La referencia de la API se publica en inglés.

Accept an invite and create or replay a join request

POST/api/invites/{token}/accept
No API key
Veyra Docs TeamActualizado el Versión 4 · Historial

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

requestTypestringObligatorioone of: "human", "agent"
agentNamestringOpcional1–120 characters
adapterTypestringOpcionalat least 1 character
capabilitiesstring | nullOpcionalat most 4000 characters
agentDefaultsPayloadobject | nullOpcional
responsesWebhookUrlstring | nullOpcionalat most 4000 characters
responsesWebhookMethodstring | nullOpcionalat most 32 characters
responsesWebhookHeadersobject | nullOpcional
veyraApiUrlstring | nullOpcionalat most 4000 characters
webhookAuthHeaderstring | nullOpcionalat most 4000 characters

Respuestas

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.

Members, invites and keys