Synup
Criar chave
v1Recursos/Clients/postEnviar o convite do portal do cliente

Enviar o convite do portal do cliente

Enviar ou reenviar ao contato principal, ou usar clientUserId para um usuário habilitado aguardando o primeiro acesso. Sem corpo mantém o contato principal; JSON inválido é recusado. Retorna portalLink. Links anteriores continuam válidos até uso ou expiração em sete dias. O titular identificado da credencial precisa de acesso ao cliente.

post/api/v1/clients/{id}/invite
clients:write
Parâmetros de consulta
idstringobrigatório
O cliente a convidar.
Corpo da solicitação
clientUserIdstringopcional
Resposta
dataobjectopcional
portalLinkstringopcional
A URL do link mágico enviado no e-mail de convite.
Erros
400Falta um parâmetro obrigatório na solicitação, ou ela é inválida de outra forma.
401Chave de API ausente, inválida, expirada ou revogada.
403A chave não tem a permissão exigida, ou não está autorizada para este cliente/local.
404O recurso não foi encontrado, ou não pertence à sua agência.
409A solicitação entra em conflito com o estado atual do recurso — por exemplo, alterar o e-mail ou telefone de um destinatário que já recebeu uma mensagem, ou um convite de equipe que já foi aceito (ou que ainda não foi aceito).
429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.
503O serviço está temporariamente indisponível. Tente adicionar os créditos novamente com a mesma chave de idempotência.
post/api/v1/clients/{id}/invite
Sua chave de API
id *
Corpo da solicitação
{
  "data": {
    "portalLink": "https://portal.synup.com/invite/aB3dE9fGhJ"
  }
}

Guias que usam este endpoint