Справочник API публикуется на английском языке.
Update chat endpoint access behavior
PATCH
/api/chat-endpoints/{endpointId}Personal API keyAgent API keyConsole session
Update chat endpoint access behavior.
Updates the small set of user-configurable access toggles. Provider identity, assigned agent, delivery mode, and maximal provider capabilities are not mutable here.
Авторизация
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. Как работают ключи.
Параметры пути
endpointIdstring (uuid)ОбязательныйThe endpoint's id.
Тело запроса
application/json · обязательно
executionDefaultsobject | nullНеобязательный
executionDefaults.projectIdstring (uuid) | nullНеобязательный
executionDefaults.workspaceobject | nullНеобязательный
communicationInstructionsstringНеобязательный
slackAppobjectНеобязательный
slackApp.appNamestringОбязательный
1–35 charactersslackApp.botNamestringОбязательный
1–80 characterspattern: ^[a-z0-9._-]+$slackApp.commandstringОбязательный
2–32 characterspattern: ^\/[a-z0-9_-]+$slackSetupMethodstringНеобязательный
one of: "managed", "automatic", "manual", "existing"allowDirectMessagesbooleanНеобязательный
requireAtMentionbooleanНеобязательный
allowGroupChatsbooleanНеобязательный
allowUnlinkedPeoplebooleanНеобязательный
Ответы
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. Подробнее: ошибки и ограничения.