La referencia de la API se publica en inglés.
Accept an invite and create or replay a join request
POST
/api/invites/{token}/acceptNo API key
Accept an invite and create or replay a join request.
Autorización
No API key is needed: the token or id in the path, or the request's own signature, authenticates the call. Cómo funcionan las claves.
Parámetros de ruta
tokenstringObligatorioThe token's id.
Cuerpo de la solicitud
application/json · obligatorio
requestTypestringObligatorio
one of: "human", "agent"agentNamestringOpcional
1–120 charactersadapterTypestringOpcional
at least 1 charactercapabilitiesstring | nullOpcional
at most 4000 charactersagentDefaultsPayloadobject | nullOpcional
responsesWebhookUrlstring | nullOpcional
at most 4000 charactersresponsesWebhookMethodstring | nullOpcional
at most 32 charactersresponsesWebhookHeadersobject | nullOpcional
veyraApiUrlstring | nullOpcional
at most 4000 characterswebhookAuthHeaderstring | nullOpcional
at most 4000 charactersRespuestas
202SuccessAccepted; the work continues in the background.
400Bad requestThe request is malformed or failed validation.
details names each field that failed.401UnauthorizedNo key, or the key is unknown, revoked or expired.
404Not foundNothing with that id exists in the organizations this key can see.
Los errores devuelven {"error": "..."}, a menudo con un code y unos details. Consulta errores y límites.