O que esse endpoint de API faz

Com a API de convites, você cria e exclui convites para o Reach 360. Os administradores veem isso refletido como usuários na guia Pendente. Os usuários recebem e-mails quando convidados. Se o convite pendente for excluído antes da aceitação, o link do e-mail não funcionará.

Você também pode usar essa API para recuperar uma lista de todos os convites pendentes ou detalhes do convite para um usuário específico.

• Endpoints
• Objetos de convite
• Criar convite
• Listar convites
• Recuperar convite por ID
• Excluir convites

Endpoints

• POST /invitations—enviar um convite a um usuário para se juntar à sua equipe
• GET /invitations— listar convites pendentes
• GET /invitations/{invitationId}—obter detalhes de um convite pendente por ID de convite
• DELETE /invitations/{invitationId}—excluir um convite pendente por ID de convite

Objetos de convite

• id(string) - o identificador exclusivo do convite
• email(string) - o endereço de e-mail do convidado
• firstName(string) - o primeiro nome do convidado
• lastName(string) - o sobrenome do convidado
• groups(lista de strings) - uma lista de nomes de grupos aos quais o convidado deve ser atribuído
• url(string) - URL para buscar os detalhes do convite na API

Criar convite

POST /invitations

Parâmetros de solicitação (JSON)

• email(string, obrigatório) - e-mail do usuário a ser convidado
• firstName(string, opcional) - primeiro nome do usuário a ser convidado
• lastName(string, opcional) - sobrenome do usuário a ser convidado
• groups(lista de strings, opcional) - lista de nomes de grupos aos quais atribuir o usuário convidado. Todos os grupos que não existem são criados quando o usuário aceita o convite.

Exemplo de resposta

{
“invitation”: {
“id”: “example-invitation-id”, 
 “email”: "foo@example.com “, “FirstName”: 
 “Exemplo de primeiro nome”, “LastName”: 
 “Exemplo de sobrenome”, “groups”: ["exemplo de grupo a”, 
 “exemplo de grupo b"]}} 
 

Códigos de erro específicos do endpoint

• 'user_exists'- não é possível criar um convite porque o endereço de e-mail especificado já tem uma conta
• 'invite_pending'- não é possível criar um convite porque o endereço de e-mail especificado já tem um convite pendente
• 'max_invites_reached'- não é possível criar um convite porque você atingiu o limite da sua conta de teste. Atualize seu plano ou entre em contato com o suporte para aumentar esse limite.

Listar convites

GET /invitations

Parâmetros de solicitação (sequência de caracteres de consulta)

• limit(inteiro, opcional) - o número máximo de resultados a serem retornados em uma única resposta (consulte Paginação); deve estar entre 1 e 100 (o padrão é 50)
• email(string, opcional) - se fornecido, retorne apenas convites para este endereço de e-mail

Exemplo de resposta

{
“convites”: [
{
“id”: “example-invitation-id-1", 
 “email”: "foo@example.com “, “Primeiro nome”: “Exemplo de primeiro nome 1", 
 “sobrenome”: “Exemplo de sobrenome 1", 
 “grupos”: ["exemplo de grupo a”, “exemplo de grupo b"]},
... 
 
], 
 “NextURL”: "https://url-for-next-page-of-results"} 

Recuperar convite por ID

GET /invitations/{invitationId}

Exemplo de resposta

{
“id”: “example-invitation-id”, 
 “email”: "foo@example.com “, “FirstName”: 
 “Exemplo de primeiro nome”, “LastName”: 
 “Exemplo de sobrenome”, “groups”: ["exemplo de grupo a”, 
 “exemplo de grupo b"]} 

Códigos de erro específicos do endpoint

• 'invitation_not_found'- não é possível recuperar o convite porque o convite não existe

Excluir convites

DELETE /invitations/{invitationId}

Resposta de sucesso

204 “Sem conteúdo”

Códigos de erro específicos do endpoint

• 'invitation_not_found'- não é possível recuperar o convite porque o convite não existe