La référence de l'API est publiée en anglais.
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.
Autorisation
No API key is needed: the token or id in the path, or the request's own signature, authenticates the call. Fonctionnement des clés.
Paramètres de chemin
tokenstringObligatoireThe token's id.
Corps de la requête
application/json · obligatoire
requestTypestringObligatoire
one of: "human", "agent"agentNamestringFacultatif
1–120 charactersadapterTypestringFacultatif
at least 1 charactercapabilitiesstring | nullFacultatif
at most 4000 charactersagentDefaultsPayloadobject | nullFacultatif
responsesWebhookUrlstring | nullFacultatif
at most 4000 charactersresponsesWebhookMethodstring | nullFacultatif
at most 32 charactersresponsesWebhookHeadersobject | nullFacultatif
veyraApiUrlstring | nullFacultatif
at most 4000 characterswebhookAuthHeaderstring | nullFacultatif
at most 4000 charactersRéponses
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.
Les erreurs renvoient {"error": "..."}, souvent avec un code et des details. Voir erreurs et limites.