Criando convites

Como enviar as informações do Colaborador para a API da Yube para criar novos convites.
Escrito por Suporte yube
Atualizado 3 anos atrás

O Convite é onde começa o relacionamento da Empresa e o Colaborador, ao qual o Colaborador enviará as documentações requeridas.

Para fazer a criação de novos convites basta fazer o envio da mutation createInvites com as informações dos colaboradores e dos Processos que eles precisam preencher.

Mutation

mutation CreateInvites($input: CreateInvitesInput!) {
  createInvites(input: $input) {
    # Status geral de criação dos convites, o valor pode ser:
    #   ERROR  : Todos os convites falharam
    #   OK     : Todos os convites foram criados
    #   PARTIAL: Apenas alguns convites foram criados
    status

    # resultado de cada solicitação
    invites {
      # se a solicitação de criação deste convite foi realizada com sucesso ou não
      successful
      # Mensagens de erro do convite
      messages {
        code
        field
        message
      }

      # Informações do convite criado
      result {
        __typename
        id
        referenceCode
        deliveredAt
        dueDate

        personCompany {
          __typename
          id
          # Empresa ao qual o colaborador vai estar vinculado
          company {
            __typename
            id
            corporateName
            nickname
          }
          # Colaborador convidado
          person {
            __typename
            id
            mobilePhone
            email
            name
          }
        }
      }
    }

    # se a solicitação de criação dos convites foi realizada com sucesso ou não
    successful
    # Mensagens de erros gerais
    messages {
      code
      field
      message
    }
  }
}

Variables

{
  "input": {
    "companyId": "Q29tcGFueTo4MzA5Y2UwYi05NGU5LTQxZjAtODM4NC0yNjU1MGE5ZWZlNzM=",
    "invitees": [
      {
        "email": "desenvolvedor@yube.com.br",
        "mobilePhone": "+5511974223238",
        "name": "Yube Desenvolvedor"
      }
    ],
    "processes": [
      {
        "fieldsValues": "{}",
        "processTemplateId": "UHJvY2Vzc1RlbXBsYXRlOmQ2ZjIyNjc4LTQ1OWQtNDZkYy1iM2FiLWNjYTRjZDRiZDgzYg=="
      }
    ],
    "notificationChannels": [
      "EMAIL"
    ]
  }
}

Exemplo de Resposta

{
  "data": {
    "createInvites": {
      "status": "OK",
      "messages": [],
      "invites": [
        {
          "successful": true,
          "result": {
            "__typename": "Invite",
            "deliveredAt": "2020-03-09T19:47:44.468329Z",
            "dueDate": "2020-03-09",
            "id": "SW52aXRlOjQ5OTY1ZDdhLTEzMWItNDdhNC1hOWRiLTllNmViNWM5ZTI2Yw==",
            "personCompany": {
              "__typename": "PersonCompany",
              "company": {
                "__typename": "Company",
                "corporateName": "Yube S/A",
                "id": "Q29tcGFueTo4MzA5Y2UwYi05NGU5LTQxZjAtODM4NC0yNjU1MGE5ZWZlNzM=",
                "nickname": "Yube Tecnologia"
              },
              "id": "UGVyc29uQ29tcGFueTphOWRiZTg2Zi0wMjg4LTQ0ZDQtOGE4Mi1iZDE2NjE3NjMyZDM=",
              "person": {
                "__typename": "Person",
                "email": "desenvolvedor@yube.com.br",
                "id": "UGVyc29uOmIzYjBmYzFkLTBhZjMtNGM1NC1iNWU3LWMwZWVmNTM3MDU5Yw==",
                "mobilePhone": "+5511974223238",
                "name": "Yube Desenvolvedor"
              }
            },
            "referenceCode": null
          },
          "messages": []
        }
      ]
    }
  }
}

Essa requisição depende do envio da chave de autenticação.

Esse artigo foi útil?