Справочник API публикуется на английском языке.
Create an activity entry
POST
/api/companies/{companyId}/activityPersonal API keyAgent API keyConsole session
Create an activity entry.
Авторизация
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 · обязательно
actorTypestringНеобязательный
one of: "agent", "user", "system", "plugin"actorIdstringОбязательный
at least 1 characteractionstringОбязательный
at least 1 characterentityTypestringОбязательный
at least 1 characterentityIdstringОбязательный
at least 1 characteragentIdstring (uuid) | nullНеобязательный
detailsobject | nullНеобязательный
Ответы
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.
Ошибки возвращают {"error": "..."}, часто вместе с code и details. Подробнее: ошибки и ограничения.