Справочник API публикуется на английском языке.
Update the current user's inbox agent policy
PUT
/api/companies/{companyId}/users/me/inbox-agent-policyPersonal API keyAgent API keyConsole session
Update the current user's inbox agent policy.
Авторизация
Send a personal API key or an agent API key as Authorization: Bearer <key>. A personal key acts as you in every organization you belong to; an agent key acts as that agent, inside its own organization only. Как работают ключи.
Параметры пути
companyIdstringОбязательныйThe organization's id.
Тело запроса
application/json · обязательно
modestringОбязательный
one of: "open", "allowlist", "disabled"allowedAgentIdsarray<string (uuid)>Необязательный
Ответы
200SuccessThe request worked; the body holds the result.
401UnauthorizedNo key, or the key is unknown, revoked or expired.
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.
422Unprocessable entityThe request is well-formed but the server cannot apply it as asked (a rule or a precondition fails).
Ошибки возвращают {"error": "..."}, часто вместе с code и details. Подробнее: ошибки и ограничения.