INinstantly
AIDeliverabilityAgent

Update an AI Deliverability Agent

Changed on

Update an AI Deliverability Agent. Set slack to connect Slack notifications, or to null to disconnect them.

Requires one of the following scopes: ai_agents:update, ai_agents:all, all:update, all:all

patch/api/v2/ai-agents/deliverability/{id}

Request

  • Base URL
    https://api.instantly.ai
  • URL
    https://api.instantly.ai/api/v2/ai-agents/deliverability/{id}
  • Auth
    HTTP bearer

Path parameters

idstring uuid required
Example:01a19e6f-7efd-75d1-a285-413774268b6f

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.

Request body

Example request

{
  "slack": {
    "connection_id": "01a19e6f-7efd-75d1-a285-413774268b6f"
  }
}

Response

The updated AI Deliverability Agent

idstring uuid required

Unique identifier for the AI agent

organization_idstring uuid required

Organization ID

namestring required

Name of the AI Agent

type1 | 2 | 3 | 4 | 6 | 7 | 8 | 9 | 10 | 11 nullable

Type of the AI Agent

timestamp_createdstring required

Timestamp when the AI agent was created

timestamp_updatedstring required

Timestamp when the AI agent was updated

status-1 | 0 | 1 required

Status of the AI Agent

is_auto_createdboolean nullable

Whether the AI agent was auto-created

created_bystring uuid nullable

User ID who created the AI agent

descriptionstring nullable

Description of the AI agent

Example response

{
  "id": "01a19e6f-5074-7a90-9d10-535a367c0bf1",
  "organization_id": "01a19e6f-5074-7a90-9d10-535b0a6d005c",
  "name": "Test AI Agent",
  "type": 1,
  "timestamp_created": "2026-11-02T22:44:17.652Z",
  "timestamp_updated": "2026-11-02T22:44:17.652Z",
  "status": 1,
  "created_by": "01a19e6f-5074-7a90-9d10-535cef352927",
  "description": "Optional agent description"
}

Changes