v1Recursos/Clients/postEnviar la invitación al portal del cliente
Enviar la invitación al portal del cliente
Envía (o reenvía) el correo de invitación al portal de clientes al contacto principal de un cliente — un enlace mágico sin contraseña. Reenviarlo invalida cualquier enlace enviado previamente. Falla si el cliente no tiene un primaryContactEmail configurado.
post
clients:write/api/v1/clients/{id}/inviteParámetros de consulta
idstringobligatorio
El cliente a invitar.
Respuesta
dataobjectopcional
portalLinkstringopcional
La URL del enlace mágico enviado en el correo de invitación.
Errores
401La clave de API falta, es inválida, expiró o fue revocada.
403A la clave le falta el permiso requerido, o no está autorizada para este cliente/ubicación.
404El recurso no se encontró, o no pertenece a su agencia.
422A la solicitud le falta un parámetro obligatorio o es inválida de otra forma.
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
post/api/v1/clients/{id}/invite
Su clave de API
id *
{
"data": {
"portalLink": "https://portal.synup.com/invite/aB3dE9fGhJ"
}
}