Справочник API публикуется на английском языке.

Accept an invite and create or replay a join request

POST/api/invites/{token}/accept
No API key
Veyra Docs TeamОбновлено Версия 4 · История

Accept an invite and create or replay a join request.

Авторизация

No API key is needed: the token or id in the path, or the request's own signature, authenticates the call. Как работают ключи.

Параметры пути

tokenstringОбязательныйThe token's id.

Тело запроса

application/json · обязательно

requestTypestringОбязательныйone of: "human", "agent"
agentNamestringНеобязательный1–120 characters
adapterTypestringНеобязательныйat least 1 character
capabilitiesstring | nullНеобязательныйat most 4000 characters
agentDefaultsPayloadobject | nullНеобязательный
responsesWebhookUrlstring | nullНеобязательныйat most 4000 characters
responsesWebhookMethodstring | nullНеобязательныйat most 32 characters
responsesWebhookHeadersobject | nullНеобязательный
veyraApiUrlstring | nullНеобязательныйat most 4000 characters
webhookAuthHeaderstring | nullНеобязательныйat most 4000 characters

Ответы

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.

Ошибки возвращают {"error": "..."}, часто вместе с code и details. Подробнее: ошибки и ограничения.

Members, invites and keys