Skip to main content
PATCH
This endpoint is for the VIP plan only. Other plans get a 403. See Plan access.
Send only the fields to change.

Path Parameters

string
required
Custom action UUID

Body

string
The action’s name.
string
When the agent should use it.
string
GET, POST, PUT, PATCH or DELETE.
string
Your endpoint. It must be a public address. We refuse private and internal addresses.
object[]
What the agent fills in from the conversation. Each has name, description, type (string, number or boolean) and required.
boolean
Whether agents can use it.
object
Headers to send with every call. This replaces all headers. A name may only use letters, digits and !#$%&'*+-.^_|~, a value can't hold a line break, and you can't set Host, Content-Length, Transfer-EncodingorConnection.</ParamField> <ParamField body="authType" type="string">bearer, api_keyorbasic. Send nullto remove the auth.</ParamField> <ParamField body="authValue" type="string">The secret forauthType. Needed when you set authType` for the first time.
authValue and header values are write only. We never send them back. A response shows hasAuth and the header names.
If you change url to another address (a different host, http or https, or port), send authValue and headers again in the same request, or set authType to null and headers to {} to remove them. The saved ones stay with the old address, and we refuse the change with a 400.

Errors