INinstantly
AIDeliverabilityAgent

Deploy the default AI Deliverability Agent

Changed on

Create or reactivate the workspace default AI Deliverability Agent. This operation is idempotent when the agent is already active and schedules an initial cycle after deployment.

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

post/api/v2/ai-agents/deliverability/deploy

Request

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

Response

Default Response

already_deployedboolean required

Whether the workspace already had an active Deliverability Agent.

initial_cycle_enqueuedboolean required

Whether an immediate initial Deliverability Agent cycle was successfully scheduled.

promo_credits_grantednumber nullable required

Instantly credits granted by an active limited-time promotion, if any.

Example response

{
  "agent": {
    "id": "01a19e6f-5074-7a90-9d10-535a367c0bf1",
    "organization_id": "01a19e6f-5074-7a90-9d10-535b0a6d005c",
    "name": "Test AI Agent",
    "payload": {
      "campaign_id": "01a19e6f-5074-7a90-9d10-5358888d7c91",
      "campaign_name": "Outbound US",
      "min_active_leads": 50,
      "on_exhaustion": "pause",
      "ai_enrichment_workflow": "custom:0198c2a4-3f1e-7000-8000-000000000000"
    },
    "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"
  },
  "initial_cycle_enqueued": true,
  "promo_credits_granted": 250
}

Changes

  • e8adcfd8ae95Revision changes
    • info

      added subschema #1 subschema #2 subschema #3 subschema #4 to the / response property anyOf list for the response status

    • info

      removed subschema #1 subschema #2 subschema #3 subschema #4 from the / response property anyOf list for the response status

  • 89f7767b369dRevision changes
    • info

      added subschema #1 subschema #2 subschema #3 subschema #4 to the / response property anyOf list for the response status

    • info

      removed subschema #1 subschema #2 subschema #3 subschema #4 from the / response property anyOf list for the response status