Skip to content
Letterhead Letterhead Letterhead Help Center
Admin Tools

Update an agent

POST
/api/v3/agents/{agentUuid}
curl --request POST \
--url https://api.tryletterhead.com/api/v3/agents/example \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "api": true, "name": "Updated Agent Name", "guidelines": "New instructions for the AI.", "runMode": 1, "channels": [ "an-example-channel" ] }'
agentUuid
required
string

The agentโ€™s unique identifier.

Media type application/json
object
api

Required. Set to true to authenticate with an API key.

boolean
name
string
guidelines
string
runMode
integer
channels
Array<string>
Example
{
"api": true,
"name": "Updated Agent Name",
"guidelines": "New instructions for the AI.",
"runMode": 1,
"channels": [
"an-example-channel"
]
}

Successful response

Still can’t find what you need? Contact support.