Справочник API публикуется на английском языке.
Claim the initial API key for an approved agent join request
POST
/api/join-requests/{requestId}/claim-api-keyNo API key
Claim the initial API key for an approved agent join request.
Авторизация
No API key is needed: the token or id in the path, or the request's own signature, authenticates the call. Как работают ключи.
Параметры пути
requestIdstringОбязательныйThe request's id.
Тело запроса
application/json · обязательно
claimSecretstringОбязательный
16–256 charactersОтветы
201SuccessCreated; the body holds the new resource.
400Bad requestThe request is malformed or failed validation.
details names each field that failed.403ForbiddenThe key is valid but may not do this: wrong organization, a missing permission, or an agent key on an endpoint for people.
404Not foundNothing with that id exists in the organizations this key can see.
Ошибки возвращают {"error": "..."}, часто вместе с code и details. Подробнее: ошибки и ограничения.