Skip to main content
PATCH
Update an AI Deliverability Agent

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string<uuid>
required

AI Deliverability Agent ID. Call GET /api/v2/ai-agents/deliverability and use the returned agent.id value to retrieve the workspace default agent ID.

Example:

"01a0206f-e3c8-7c89-bb8e-26ad638ed6a3"

Body

application/json
slack
object | null
required

Slack notification settings. Set this field to null to disconnect Slack notifications.

Response

The updated AI Deliverability Agent

An AI Deliverability Agent

id
string<uuid>
required
read-only

Unique identifier for the AI agent

Example:

"01a0206f-ab5d-7a94-b390-0e72d746d00a"

organization_id
string<uuid>
required
read-only

Organization ID

Example:

"01a0206f-ab5d-7a94-b390-0e739ce03f39"

name
string
required

Name of the AI Agent

Example:

"Test AI Agent"

timestamp_created
string
required
read-only

Timestamp when the AI agent was created

Example:

"2026-08-20T18:29:44.413Z"

timestamp_updated
string
required
read-only

Timestamp when the AI agent was updated

Example:

"2026-08-20T18:29:44.413Z"

status
enum<number>
required

Status of the AI Agent

Available options:
-1,
0,
1
Example:

1

payload
object

Deliverability Agent payload

type
null | enum<number>

Type of the AI Agent

Available options:
1,
2,
3,
4,
6,
7,
8,
9,
10
Example:

1

is_auto_created
null | boolean

Whether the AI agent was auto-created

Example:

false

created_by
null | string<uuid>
read-only

User ID who created the AI agent

Example:

"01a0206f-ab5d-7a94-b390-0e74994e2dba"

description
null | string
read-only

Description of the AI agent

Example:

"Optional agent description"