---
title: "Update an AI Deliverability Agent"
method: PATCH
path: "/api/v2/ai-agents/deliverability/{id}"
tags: ["AIDeliverabilityAgent"]
---

# Update an AI Deliverability Agent

`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

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`

## Path parameters

- `id` string, uuid, required

## Request body

- object
  - `slack` object, nullable, required: Slack notification settings. Set this field to `null` to disconnect Slack notifications.
    - `connection_id` string, uuid, required: Slack app connection ID.
    - `enabled` boolean, required: Whether the Deliverability Agent sends Slack notifications through this connection.

## Response `200`

The updated AI Deliverability Agent

- AIDeliverabilityAgent: An AI Deliverability Agent
  - `id` string, uuid, required: Unique identifier for the AI agent
  - `organization_id` string, uuid, required: Organization ID
  - `name` string, required: Name of the AI Agent
  - `payload` object: Deliverability Agent payload
    - `integrations` object: Configurations for Deliverability Agent app integrations
      - `slack` object, nullable
        - `connection_id` string: Slack app connection ID
        - `enabled` boolean: Whether Slack notifications are enabled for this Deliverability Agent.
        - `connection_name` string: Deprecated. Kept only so previously stored values round-trip.
        - `channel_id` string: Deprecated. Kept only so previously stored values round-trip.
        - `channel_name` string: Deprecated. Kept only so previously stored values round-trip.
  - `type` 1 | 2 | 3 | 4 | 6 | 7 | 8 | 9 | 10 | 11, nullable: Type of the AI Agent
  - `timestamp_created` string, required: Timestamp when the AI agent was created
  - `timestamp_updated` string, required: Timestamp when the AI agent was updated
  - `status` -1 | 0 | 1, required: Status of the AI Agent
  - `is_auto_created` boolean, nullable: Whether the AI agent was auto-created
  - `created_by` string, uuid, nullable: User ID who created the AI agent
  - `description` string, nullable: Description of the AI agent

## Other responses

- `400`: The request is invalid (e.g. missing required fields, invalid field values, or an invalid state for the operation)
- `401`: This request is unauthorized (either the Authorization header is missing or invalid, or the API key has been revoked)
- `402`: This request cannot be fulfilled because the workspace does not have an active paid plan
- `404`: The requested resource was not found
- `429`: You have exceeded the rate limit. Please check the rate limit docs for more information.

## Changes

- **2026-11-03** `c781051105a8`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/instantly/apis/api-explorer/changes/api/v2/ai-agents/deliverability/:id/patch.md)

---

[API](https://skmtc.dev/instantly/apis/api-explorer.md) - [All operations](https://skmtc.dev/instantly/apis/api-explorer/llms.txt) - [OpenAPI document](https://skmtc.dev/instantly/apis/api-explorer/revisions/406ab2c4f714?raw)