Synup
Crear clave
v1Recursos/Clients/postEnviar la invitación al portal del cliente

Enviar la invitación al portal del cliente

Enviar o reenviar al contacto principal, o usar clientUserId para un usuario habilitado que aún no inició sesión. Sin cuerpo mantiene el comportamiento del contacto principal; rechaza JSON incorrecto. Devuelve portalLink. Los enlaces anteriores siguen válidos hasta usarse o vencer a los siete días. Requiere que el propietario identificado de la credencial tenga acceso al cliente.

post/api/v1/clients/{id}/invite
clients:write
Parámetros de consulta
idstringobligatorio
El cliente a invitar.
Cuerpo de la solicitud
clientUserIdstringopcional
Respuesta
dataobjectopcional
portalLinkstringopcional
La URL del enlace mágico enviado en el correo de invitación.
Errores
400A la solicitud le falta un parámetro obligatorio o es inválida de otra forma.
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.
409La solicitud entra en conflicto con el estado actual del recurso — por ejemplo, cambiar el correo electrónico o el teléfono de un destinatario al que ya se le ha enviado un mensaje, o una invitación de equipo que ya fue aceptada (o que aún no ha sido aceptada).
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
503El servicio no está disponible temporalmente. Reintente la asignación de créditos con la misma clave de idempotencia.
post/api/v1/clients/{id}/invite
Su clave de API
id *
Cuerpo de la solicitud
{
  "data": {
    "portalLink": "https://portal.synup.com/invite/aB3dE9fGhJ"
  }
}

Guías que usan este endpoint