Справочник API публикуется на английском языке.
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.
Авторизация
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 charactersadapterTypestringНеобязательный
at least 1 charactercapabilitiesstring | nullНеобязательный
at most 4000 charactersagentDefaultsPayloadobject | nullНеобязательный
responsesWebhookUrlstring | nullНеобязательный
at most 4000 charactersresponsesWebhookMethodstring | nullНеобязательный
at most 32 charactersresponsesWebhookHeadersobject | nullНеобязательный
veyraApiUrlstring | nullНеобязательный
at most 4000 characterswebhookAuthHeaderstring | 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. Подробнее: ошибки и ограничения.