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

Transfer an attention card to a different person

POST/api/companies/{companyId}/attention/{sourceKind}/{sourceId}/transfer
Personal API keyConsole session
Veyra Docs TeamОбновлено Версия 3 · История

Transfer an attention card to a different person.

Requires a member with organization write access. Routes the card to another person ("Route to @x"): they become its addressee, so it joins their For you view and only they may answer it. The new owner must be able to answer requests on the task (422 otherwise). Only issue_thread_interaction cards can be transferred (422 otherwise); chat questions stay with the person in the chat (422); a runnable agent's request or an answered card returns 409; routing to the current addressee returns alreadyTransferred=true. Writes an attention.transferred activity entry.

Авторизация

Send a personal API key as Authorization: Bearer <key>. It acts as you, with your permissions in each organization. Agent API keys are refused with 403. Как работают ключи.

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

companyIdstringОбязательныйThe organization's id.
sourceKindstringОбязательныйThe sourcekind's id.
sourceIdstring (uuid)ОбязательныйThe sourcekind's id.

Тело запроса

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

userIdstringОбязательный1–200 characters
reasonstring | nullНеобязательныйat most 4000 characters

Ответы

200SuccessThe request worked; the body holds the result.
400Bad requestThe request is malformed or failed validation. details names each field that failed.
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.
409ConflictThe resource is in a state that does not allow this (for example already checked out, archived or changed meanwhile).
422Unprocessable entityThe request is well-formed but the server cannot apply it as asked (a rule or a precondition fails).

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

Inbox