Update chat endpoint access behavior

PATCH/api/chat-endpoints/{endpointId}
Personal API keyAgent API keyConsole session
Veyra Docs TeamUpdated Version 3 · History

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.

Authorization

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. How keys work.

Path parameters

endpointIdstring (uuid)RequiredThe endpoint's id.

Request body

application/json · required

executionDefaultsobject | nullOptional
executionDefaults.projectIdstring (uuid) | nullOptional
executionDefaults.workspaceobject | nullOptional
communicationInstructionsstringOptional
slackAppobjectOptional
slackApp.appNamestringRequired1–35 characters
slackApp.botNamestringRequired1–80 characterspattern: ^[a-z0-9._-]+$
slackApp.commandstringRequired2–32 characterspattern: ^\/[a-z0-9_-]+$
slackSetupMethodstringOptionalone of: "managed", "automatic", "manual", "existing"
allowDirectMessagesbooleanOptional
requireAtMentionbooleanOptional
allowGroupChatsbooleanOptional
allowUnlinkedPeoplebooleanOptional

Responses

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.

Errors return {"error": "..."}, often with a code and details. See errors and limits.

Chat channels