AI agents

The WhatsApp AI agent: settings, the per-number switch off → shadow → live behind the agent check, approved facts, KPIs, inbox drafts and hand-offs.

GET/v1/ai/agent-facts

Approved fact sheets the agent may quote (per project or company-wide)

Access: Signed-in members only (web or Android session) — not for API keys. Permission ai.agents_manage.

Parameters

project_idquery: Id
Opaque record id.

Response · 200

datarequired: array of AiAgentFact
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/ai/agent-facts' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "project_id": "cmusrceel0000q7kaafxqi1om",
      "project_name": "string",
      "topic": "pricing",
      "title": "string",
      "body": "string",
      "as_of": "string",
      "valid_from": "string",
      "valid_until": "string",
      "status": "string",
      "approved_at": "2026-10-06T05:30:00.000Z",
      "updated_at": "2026-10-06T05:30:00.000Z"
    }
  ],
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/ai/agent-facts

Add an approved fact (offers count only from here)

Access: Signed-in members only (web or Android session) — not for API keys. Permission ai.agents_manage.

Request body

project_id: Id or null
Opaque record id.
topicrequired: "pricing" | "payment_plan" | "possession" | "amenities" | "location" | "specs" | …
titlerequired: string
bodyrequired: string
as_ofrequired: string
valid_from: string or null
valid_until: string or null

Response · 201

datarequired: AiAgentFact
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/ai/agent-facts' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"project_id":null,"topic":"pricing","title":"string","body":"string","as_of":"string","valid_from":"string","valid_until":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "project_id": "cmusrceel0000q7kaafxqi1om",
    "project_name": "string",
    "topic": "pricing",
    "title": "string",
    "body": "string",
    "as_of": "string",
    "valid_from": "string",
    "valid_until": "string",
    "status": "string",
    "approved_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

PATCH/v1/ai/agent-facts/{id}

Edit an approved fact (re-approved by the editor)

Access: Signed-in members only (web or Android session) — not for API keys. Permission ai.agents_manage.

Parameters

idpathrequired: Id
Opaque record id.

Request body

project_id: Id or null
Opaque record id.
topic: "pricing" | "payment_plan" | "possession" | "amenities" | "location" | "specs" | …
title: string
body: string
as_of: string
valid_from: string or null
valid_until: string or null

Response · 200

datarequired: AiAgentFact
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/ai/agent-facts/{id}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"project_id":"cmusrceel0000q7kaafxqi1om","topic":"pricing","title":"string","body":"string","as_of":"string","valid_from":"string","valid_until":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "project_id": "cmusrceel0000q7kaafxqi1om",
    "project_name": "string",
    "topic": "pricing",
    "title": "string",
    "body": "string",
    "as_of": "string",
    "valid_from": "string",
    "valid_until": "string",
    "status": "string",
    "approved_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

DELETE/v1/ai/agent-facts/{id}

Archive a fact (the agent no longer sees it)

Access: Signed-in members only (web or Android session) — not for API keys. Permission ai.agents_manage.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: object
data.archivedrequired: true
metarequired: object

Request

curl -X DELETE 'https://api.propzolo.com/v1/ai/agent-facts/{id}' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "archived": true
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/ai/agent/conversations

The agent’s status for the given conversations (only those the member can see)

Access: Signed-in members only (web or Android session) — not for API keys. Permission inbox.view.

Parameters

idsqueryrequired: string

Response · 200

datarequired: array of AiAgentChip
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/ai/agent/conversations' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": [
    {
      "conversation_id": "cmusrceel0000q7kaafxqi1om",
      "agent_name": "string",
      "mode": "off",
      "state": "NEW",
      "pending_drafts": 0,
      "handoff_reason": "string",
      "handoff_label": "string",
      "handoff_due_at": "2026-10-06T05:30:00.000Z"
    }
  ],
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/ai/agent/conversations/{id}

The agent in one conversation: status, what it noted, drafts to approve, recent turns

Access: Signed-in members only (web or Android session) — not for API keys. Permission inbox.view.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: AiAgentConversation
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/ai/agent/conversations/{id}' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "chip": {
      "conversation_id": "cmusrceel0000q7kaafxqi1om",
      "agent_name": "string",
      "mode": "off",
      "state": "NEW",
      "pending_drafts": 0,
      "handoff_reason": "string",
      "handoff_label": "string",
      "handoff_due_at": "2026-10-06T05:30:00.000Z"
    },
    "handoff_summary": "string",
    "opted_out": true,
    "closed_reason": "string",
    "next_followup_at": "2026-10-06T05:30:00.000Z",
    "noted": [
      {
        "field": "string",
        "value": null,
        "confidence": 0,
        "status": "string",
        "source_message_id": "string",
        "at": "string"
      }
    ],
    "drafts": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "conversation_id": "cmusrceel0000q7kaafxqi1om",
        "mode": "string",
        "text": "string",
        "language": "string",
        "actions": [
          "string"
        ],
        "handoff_reason": "string",
        "created_at": "2026-10-06T05:30:00.000Z",
        "expires_at": "2026-10-06T05:30:00.000Z",
        "expired": true
      }
    ],
    "turns": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "outcome": "string",
        "intent": "string",
        "skip_reason": "string",
        "mode": "string",
        "state_after": "string",
        "created_at": "2026-10-06T05:30:00.000Z",
        "credits": 0
      }
    ]
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/ai/agent/conversations/{id}/release

Hand the chat back to the agent (it answers the customer’s next message)

Access: Signed-in members only (web or Android session) — not for API keys. Permission inbox.reply.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: AiAgentChip or null
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/ai/agent/conversations/{id}/release' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "conversation_id": "cmusrceel0000q7kaafxqi1om",
    "agent_name": "string",
    "mode": "off",
    "state": "NEW",
    "pending_drafts": 0,
    "handoff_reason": "string",
    "handoff_label": "string",
    "handoff_due_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/ai/agent/conversations/{id}/reopen

Reopen a conversation the agent closed as disqualified (never an opt-out)

Access: Signed-in members only (web or Android session) — not for API keys. Permission inbox.reply.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: AiAgentChip or null
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/ai/agent/conversations/{id}/reopen' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "conversation_id": "cmusrceel0000q7kaafxqi1om",
    "agent_name": "string",
    "mode": "off",
    "state": "NEW",
    "pending_drafts": 0,
    "handoff_reason": "string",
    "handoff_label": "string",
    "handoff_due_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/ai/agent/conversations/{id}/take-over

Take the chat from the agent (it stops replying and only drafts)

Access: Signed-in members only (web or Android session) — not for API keys. Permission inbox.reply.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: AiAgentChip or null
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/ai/agent/conversations/{id}/take-over' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "conversation_id": "cmusrceel0000q7kaafxqi1om",
    "agent_name": "string",
    "mode": "off",
    "state": "NEW",
    "pending_drafts": 0,
    "handoff_reason": "string",
    "handoff_label": "string",
    "handoff_due_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/ai/agent/drafts/{id}/approve

Send an agent draft — as written, or with your edits (sent as yours)

Access: Signed-in members only (web or Android session) — not for API keys. Permission inbox.reply.

Parameters

idpathrequired: Id
Opaque record id.
Idempotency-Keyheader: string
Unique key (a UUID) per logical request. A retry with the same key and body replays the first response for 24 hours (marked Idempotent-Replayed: true); the same key with another body is a 409.

Request body

text: string

Response · 200

datarequired: object
data.draft_statusrequired: "approved" | "edited"
data.message_idsrequired: array of Id
Opaque record id.
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/ai/agent/drafts/{id}/approve' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Idempotency-Key: 6c0f1d3e-…' \
  -H 'Content-Type: application/json' \
  -d '{"text":"string"}'

Response example

{
  "data": {
    "draft_status": "approved",
    "message_ids": [
      "cmusrceel0000q7kaafxqi1om"
    ]
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/ai/agent/drafts/{id}/reject

Discard an agent draft

Access: Signed-in members only (web or Android session) — not for API keys. Permission inbox.reply.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: object
data.rejectedrequired: true
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/ai/agent/drafts/{id}/reject' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "rejected": true
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/ai/agents

The company’s WhatsApp AI agents with their settings and numbers

Access: Signed-in members only (web or Android session) — not for API keys. Permission ai.agents_manage.

Response · 200

datarequired: array of AiAgent
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/ai/agents' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "kind": "string",
      "persona": "string",
      "instructions": "string",
      "languages": [
        "string"
      ],
      "actions": [
        "send_asset"
      ],
      "qualification": {
        "slots": [
          "transaction"
        ],
        "required": [
          "transaction"
        ]
      },
      "handoff_rules": {
        "negative_sentiment": true,
        "failed_turns": 1,
        "off_topic_redirects": 0,
        "vip_budget_rupees": 100000,
        "vip_tags": [
          "string"
        ]
      },
      "working_hours": {
        "shifts": [
          {
            "days": [
              null
            ],
            "start": "string",
            "end": "string"
          }
        ]
      },
      "config": {
        "price_policy": "exact",
        "caps": {
          "replies_per_day": 1,
          "followups_per_week": 0
        },
        "quiet_hours": {
          "start": "string",
          "end": "string"
        },
        "human_active_minutes": 5,
        "handoff_idle_hours": 1,
        "allowed_asset_ids": [
          "cmusrceel0000q7kaafxqi1om"
        ],
        "intent_templates": {
          "follow_up": "cmusrceel0000q7kaafxqi1om",
          "visit_confirmation": "cmusrceel0000q7kaafxqi1om",
          "handoff_notice": "cmusrceel0000q7kaafxqi1om",
          "reengage": "cmusrceel0000q7kaafxqi1om"
        }
      },
      "settings_version": 0,
      "eval": {
        "settings_version": 0,
        "passed": true,
        "current": true,
        "ran_at": "string",
        "gates": {},
        "failed_cases": [
          "string"
        ],
        "cases": 0
      },
      "channels": [
        {
          "channel_account_id": "cmusrceel0000q7kaafxqi1om",
          "label": "string",
          "address": "string",
          "status": "string",
          "mode": "off",
          "changed_at": "2026-10-06T05:30:00.000Z"
        }
      ],
      "is_active": true,
      "archived_at": "2026-10-06T05:30:00.000Z",
      "created_at": "2026-10-06T05:30:00.000Z",
      "updated_at": "2026-10-06T05:30:00.000Z"
    }
  ],
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/ai/agents

Create a WhatsApp AI agent (every number starts off; shadow mode first)

Access: Signed-in members only (web or Android session) — not for API keys. Permission ai.agents_manage.

Request body

name: string
persona: string or null
instructions: string or null
languages: array of "en" | "hi" | "hinglish" | "mr" | "ta" | "te" | …
actions: array of "send_asset" | "create_shortlist" | "book_visit" | "schedule_followup" | "mark_disqualified"
qualification: object
qualification.slotsrequired: array of "transaction" | "budget" | "bhk" | "property_type" | "locality" | "city" | …
qualification.requiredrequired: array of "transaction" | "budget" | "bhk" | "property_type" | "locality" | "city" | …
handoff_rules: object
Requests for a person, complaints, RERA complaints, negotiation, booking or payment and legal / tax / loan questions always hand off; these settings tune the rest.
handoff_rules.negative_sentimentrequired: boolean
Hand off when the customer is upset (complaints always do).
handoff_rules.failed_turnsrequired: integer
handoff_rules.off_topic_redirectsrequired: integer
handoff_rules.vip_budget_rupeesrequired: integer or null
handoff_rules.vip_tagsrequired: array of string
working_hours: object or null
null = 24×7; otherwise ISO weekdays and HH:mm windows in the company time zone.
working_hours.shiftsrequired: array of object
working_hours.shifts[].daysrequired: array of integer
working_hours.shifts[].startrequired: string
working_hours.shifts[].endrequired: string
config: object
config.price_policy: "exact" | "band" | "never" or null
null = the company AI setting.
config.caps: object
config.caps.replies_per_dayrequired: integer
config.caps.followups_per_weekrequired: integer
config.quiet_hours: object
config.quiet_hours.startrequired: string
config.quiet_hours.endrequired: string
config.human_active_minutes: integer
config.handoff_idle_hours: integer
config.allowed_asset_ids: array of Id
Opaque record id.
config.intent_templates: object
config.intent_templates.follow_uprequired: Id or null
Opaque record id.
config.intent_templates.visit_confirmationrequired: Id or null
Opaque record id.
config.intent_templates.handoff_noticerequired: Id or null
Opaque record id.
config.intent_templates.reengagerequired: Id or null
Opaque record id.

Response · 201

datarequired: AiAgent
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/ai/agents' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"name":"string","persona":"string","instructions":"string","languages":["en"],"actions":["send_asset"],"qualification":{"slots":["transaction"],"required":["transaction"]},"handoff_rules":{"negative_sentiment":true,"failed_turns":1,"off_topic_redirects":0,"vip_budget_rupees":100000,"vip_tags":["string"]},"working_hours":{"shifts":[{"days":[1],"start":"string","end":"string"}]},"config":{"price_policy":"exact","caps":{"replies_per_day":1,"followups_per_week":0},"quiet_hours":{"start":"string","end":"string"},"human_active_minutes":5,"handoff_idle_hours":1,"allowed_asset_ids":["cmusrceel0000q7kaafxqi1om"],"intent_templates":{"follow_up":"cmusrceel0000q7kaafxqi1om","visit_confirmation":"cmusrceel0000q7kaafxqi1om","handoff_notice":"cmusrceel0000q7kaafxqi1om","reengage":"cmusrceel0000q7kaafxqi1om"}}}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "kind": "string",
    "persona": "string",
    "instructions": "string",
    "languages": [
      "string"
    ],
    "actions": [
      "send_asset"
    ],
    "qualification": {
      "slots": [
        "transaction"
      ],
      "required": [
        "transaction"
      ]
    },
    "handoff_rules": {
      "negative_sentiment": true,
      "failed_turns": 1,
      "off_topic_redirects": 0,
      "vip_budget_rupees": 100000,
      "vip_tags": [
        "string"
      ]
    },
    "working_hours": {
      "shifts": [
        {
          "days": [
            1
          ],
          "start": "string",
          "end": "string"
        }
      ]
    },
    "config": {
      "price_policy": "exact",
      "caps": {
        "replies_per_day": 1,
        "followups_per_week": 0
      },
      "quiet_hours": {
        "start": "string",
        "end": "string"
      },
      "human_active_minutes": 5,
      "handoff_idle_hours": 1,
      "allowed_asset_ids": [
        "cmusrceel0000q7kaafxqi1om"
      ],
      "intent_templates": {
        "follow_up": "cmusrceel0000q7kaafxqi1om",
        "visit_confirmation": "cmusrceel0000q7kaafxqi1om",
        "handoff_notice": "cmusrceel0000q7kaafxqi1om",
        "reengage": "cmusrceel0000q7kaafxqi1om"
      }
    },
    "settings_version": 0,
    "eval": {
      "settings_version": 0,
      "passed": true,
      "current": true,
      "ran_at": "string",
      "gates": {},
      "failed_cases": [
        "string"
      ],
      "cases": 0
    },
    "channels": [
      {
        "channel_account_id": "cmusrceel0000q7kaafxqi1om",
        "label": "string",
        "address": "string",
        "status": "string",
        "mode": "off",
        "changed_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "is_active": true,
    "archived_at": "2026-10-06T05:30:00.000Z",
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/ai/agents/options

What an agent’s settings can point at: WhatsApp numbers, templates, sendable assets, projects

Access: Signed-in members only (web or Android session) — not for API keys. Permission ai.agents_manage.

Response · 200

datarequired: AiAgentOptions
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/ai/agents/options' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "numbers": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "label": "string",
        "address": "string",
        "status": "string",
        "agent_id": "cmusrceel0000q7kaafxqi1om",
        "mode": "off"
      }
    ],
    "templates": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "language": "string",
        "status": "string"
      }
    ],
    "assets": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "kind": "string",
        "title": "string",
        "project_name": "string"
      }
    ],
    "projects": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      }
    ]
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/ai/agents/overview

KPIs: first response, reply rate, qualified %, visits, hand-off and edit rates, opt-outs, credits

Access: Signed-in members only (web or Android session) — not for API keys. Permission ai.agents_manage.

Parameters

daysquery: number
agent_idquery: Id
Opaque record id.

Response · 200

datarequired: AiAgentOverview
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/ai/agents/overview' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "period": {
      "days": 0,
      "from": "2026-10-06T05:30:00.000Z",
      "to": "2026-10-06T05:30:00.000Z"
    },
    "turns": 0,
    "kpis": {
      "conversations": 0,
      "first_response": {
        "median_ms": 0,
        "p90_ms": 0,
        "samples": 0
      },
      "reply_rate": 0,
      "qualified_rate": 0,
      "visits_booked": 0,
      "handoff_rate": 0,
      "edit_rate": 0,
      "opt_out_rate": 0,
      "credits": 0,
      "credits_per_qualified": 0
    },
    "outcomes": {},
    "skip_reasons": [
      {
        "reason": "string",
        "count": 0
      }
    ],
    "handoff_reasons": [
      {
        "reason": "string",
        "label": "string",
        "count": 0
      }
    ]
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/ai/agents/{id}

One WhatsApp AI agent

Access: Signed-in members only (web or Android session) — not for API keys. Permission ai.agents_manage.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: AiAgent
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/ai/agents/{id}' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "kind": "string",
    "persona": "string",
    "instructions": "string",
    "languages": [
      "string"
    ],
    "actions": [
      "send_asset"
    ],
    "qualification": {
      "slots": [
        "transaction"
      ],
      "required": [
        "transaction"
      ]
    },
    "handoff_rules": {
      "negative_sentiment": true,
      "failed_turns": 1,
      "off_topic_redirects": 0,
      "vip_budget_rupees": 100000,
      "vip_tags": [
        "string"
      ]
    },
    "working_hours": {
      "shifts": [
        {
          "days": [
            1
          ],
          "start": "string",
          "end": "string"
        }
      ]
    },
    "config": {
      "price_policy": "exact",
      "caps": {
        "replies_per_day": 1,
        "followups_per_week": 0
      },
      "quiet_hours": {
        "start": "string",
        "end": "string"
      },
      "human_active_minutes": 5,
      "handoff_idle_hours": 1,
      "allowed_asset_ids": [
        "cmusrceel0000q7kaafxqi1om"
      ],
      "intent_templates": {
        "follow_up": "cmusrceel0000q7kaafxqi1om",
        "visit_confirmation": "cmusrceel0000q7kaafxqi1om",
        "handoff_notice": "cmusrceel0000q7kaafxqi1om",
        "reengage": "cmusrceel0000q7kaafxqi1om"
      }
    },
    "settings_version": 0,
    "eval": {
      "settings_version": 0,
      "passed": true,
      "current": true,
      "ran_at": "string",
      "gates": {},
      "failed_cases": [
        "string"
      ],
      "cases": 0
    },
    "channels": [
      {
        "channel_account_id": "cmusrceel0000q7kaafxqi1om",
        "label": "string",
        "address": "string",
        "status": "string",
        "mode": "off",
        "changed_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "is_active": true,
    "archived_at": "2026-10-06T05:30:00.000Z",
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

PATCH/v1/ai/agents/{id}

Change an agent’s settings (bumps its settings version: the agent check must pass again to go live)

Access: Signed-in members only (web or Android session) — not for API keys. Permission ai.agents_manage.

Parameters

idpathrequired: Id
Opaque record id.

Request body

name: string
persona: string or null
instructions: string or null
languages: array of "en" | "hi" | "hinglish" | "mr" | "ta" | "te" | …
actions: array of "send_asset" | "create_shortlist" | "book_visit" | "schedule_followup" | "mark_disqualified"
qualification: object
qualification.slotsrequired: array of "transaction" | "budget" | "bhk" | "property_type" | "locality" | "city" | …
qualification.requiredrequired: array of "transaction" | "budget" | "bhk" | "property_type" | "locality" | "city" | …
handoff_rules: object
Requests for a person, complaints, RERA complaints, negotiation, booking or payment and legal / tax / loan questions always hand off; these settings tune the rest.
handoff_rules.negative_sentimentrequired: boolean
Hand off when the customer is upset (complaints always do).
handoff_rules.failed_turnsrequired: integer
handoff_rules.off_topic_redirectsrequired: integer
handoff_rules.vip_budget_rupeesrequired: integer or null
handoff_rules.vip_tagsrequired: array of string
working_hours: object or null
null = 24×7; otherwise ISO weekdays and HH:mm windows in the company time zone.
working_hours.shiftsrequired: array of object
working_hours.shifts[].daysrequired: array of integer
working_hours.shifts[].startrequired: string
working_hours.shifts[].endrequired: string
config: object
config.price_policy: "exact" | "band" | "never" or null
null = the company AI setting.
config.caps: object
config.caps.replies_per_dayrequired: integer
config.caps.followups_per_weekrequired: integer
config.quiet_hours: object
config.quiet_hours.startrequired: string
config.quiet_hours.endrequired: string
config.human_active_minutes: integer
config.handoff_idle_hours: integer
config.allowed_asset_ids: array of Id
Opaque record id.
config.intent_templates: object
config.intent_templates.follow_uprequired: Id or null
Opaque record id.
config.intent_templates.visit_confirmationrequired: Id or null
Opaque record id.
config.intent_templates.handoff_noticerequired: Id or null
Opaque record id.
config.intent_templates.reengagerequired: Id or null
Opaque record id.

Response · 200

datarequired: AiAgent
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/ai/agents/{id}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"name":"string","persona":"string","instructions":"string","languages":["en"],"actions":["send_asset"],"qualification":{"slots":["transaction"],"required":["transaction"]},"handoff_rules":{"negative_sentiment":true,"failed_turns":1,"off_topic_redirects":0,"vip_budget_rupees":100000,"vip_tags":["string"]},"working_hours":{"shifts":[{"days":[1],"start":"string","end":"string"}]},"config":{"price_policy":"exact","caps":{"replies_per_day":1,"followups_per_week":0},"quiet_hours":{"start":"string","end":"string"},"human_active_minutes":5,"handoff_idle_hours":1,"allowed_asset_ids":["cmusrceel0000q7kaafxqi1om"],"intent_templates":{"follow_up":"cmusrceel0000q7kaafxqi1om","visit_confirmation":"cmusrceel0000q7kaafxqi1om","handoff_notice":"cmusrceel0000q7kaafxqi1om","reengage":"cmusrceel0000q7kaafxqi1om"}}}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "kind": "string",
    "persona": "string",
    "instructions": "string",
    "languages": [
      "string"
    ],
    "actions": [
      "send_asset"
    ],
    "qualification": {
      "slots": [
        "transaction"
      ],
      "required": [
        "transaction"
      ]
    },
    "handoff_rules": {
      "negative_sentiment": true,
      "failed_turns": 1,
      "off_topic_redirects": 0,
      "vip_budget_rupees": 100000,
      "vip_tags": [
        "string"
      ]
    },
    "working_hours": {
      "shifts": [
        {
          "days": [
            1
          ],
          "start": "string",
          "end": "string"
        }
      ]
    },
    "config": {
      "price_policy": "exact",
      "caps": {
        "replies_per_day": 1,
        "followups_per_week": 0
      },
      "quiet_hours": {
        "start": "string",
        "end": "string"
      },
      "human_active_minutes": 5,
      "handoff_idle_hours": 1,
      "allowed_asset_ids": [
        "cmusrceel0000q7kaafxqi1om"
      ],
      "intent_templates": {
        "follow_up": "cmusrceel0000q7kaafxqi1om",
        "visit_confirmation": "cmusrceel0000q7kaafxqi1om",
        "handoff_notice": "cmusrceel0000q7kaafxqi1om",
        "reengage": "cmusrceel0000q7kaafxqi1om"
      }
    },
    "settings_version": 0,
    "eval": {
      "settings_version": 0,
      "passed": true,
      "current": true,
      "ran_at": "string",
      "gates": {},
      "failed_cases": [
        "string"
      ],
      "cases": 0
    },
    "channels": [
      {
        "channel_account_id": "cmusrceel0000q7kaafxqi1om",
        "label": "string",
        "address": "string",
        "status": "string",
        "mode": "off",
        "changed_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "is_active": true,
    "archived_at": "2026-10-06T05:30:00.000Z",
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

DELETE/v1/ai/agents/{id}

Archive an agent (its numbers are switched off; history stays)

Access: Signed-in members only (web or Android session) — not for API keys. Permission ai.agents_manage.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: object
data.archivedrequired: true
metarequired: object

Request

curl -X DELETE 'https://api.propzolo.com/v1/ai/agents/{id}' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "archived": true
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

PUT/v1/ai/agents/{id}/channels

Put a WhatsApp number under the agent: off · shadow · live

Live only from shadow, with the agent check passed for the current settings version, after 14 days in shadow and under 10 % corrected drafts over at least 20 (409 with `fields.mode` = shadow_first · eval_required · eval_stale · shadow_too_short · shadow_quality). One agent per number (409). Saving settings puts live numbers back in shadow.

Access: Signed-in members only (web or Android session) — not for API keys. Permission ai.agents_manage.

Parameters

idpathrequired: Id
Opaque record id.

Request body

channel_account_idrequired: Id
Opaque record id.
moderequired: "off" | "shadow" | "live"

Response · 200

datarequired: AiAgent
metarequired: object

Request

curl -X PUT 'https://api.propzolo.com/v1/ai/agents/{id}/channels' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"channel_account_id":"cmusrceel0000q7kaafxqi1om","mode":"off"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "kind": "string",
    "persona": "string",
    "instructions": "string",
    "languages": [
      "string"
    ],
    "actions": [
      "send_asset"
    ],
    "qualification": {
      "slots": [
        "transaction"
      ],
      "required": [
        "transaction"
      ]
    },
    "handoff_rules": {
      "negative_sentiment": true,
      "failed_turns": 1,
      "off_topic_redirects": 0,
      "vip_budget_rupees": 100000,
      "vip_tags": [
        "string"
      ]
    },
    "working_hours": {
      "shifts": [
        {
          "days": [
            1
          ],
          "start": "string",
          "end": "string"
        }
      ]
    },
    "config": {
      "price_policy": "exact",
      "caps": {
        "replies_per_day": 1,
        "followups_per_week": 0
      },
      "quiet_hours": {
        "start": "string",
        "end": "string"
      },
      "human_active_minutes": 5,
      "handoff_idle_hours": 1,
      "allowed_asset_ids": [
        "cmusrceel0000q7kaafxqi1om"
      ],
      "intent_templates": {
        "follow_up": "cmusrceel0000q7kaafxqi1om",
        "visit_confirmation": "cmusrceel0000q7kaafxqi1om",
        "handoff_notice": "cmusrceel0000q7kaafxqi1om",
        "reengage": "cmusrceel0000q7kaafxqi1om"
      }
    },
    "settings_version": 0,
    "eval": {
      "settings_version": 0,
      "passed": true,
      "current": true,
      "ran_at": "string",
      "gates": {},
      "failed_cases": [
        "string"
      ],
      "cases": 0
    },
    "channels": [
      {
        "channel_account_id": "cmusrceel0000q7kaafxqi1om",
        "label": "string",
        "address": "string",
        "status": "string",
        "mode": "off",
        "changed_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "is_active": true,
    "archived_at": "2026-10-06T05:30:00.000Z",
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

DELETE/v1/ai/agents/{id}/channels/{accountId}

Take a WhatsApp number away from the agent

Access: Signed-in members only (web or Android session) — not for API keys. Permission ai.agents_manage.

Parameters

idpathrequired: Id
Opaque record id.
accountIdpathrequired: Id
Opaque record id.

Response · 200

datarequired: AiAgent
metarequired: object

Request

curl -X DELETE 'https://api.propzolo.com/v1/ai/agents/{id}/channels/{accountId}' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "kind": "string",
    "persona": "string",
    "instructions": "string",
    "languages": [
      "string"
    ],
    "actions": [
      "send_asset"
    ],
    "qualification": {
      "slots": [
        "transaction"
      ],
      "required": [
        "transaction"
      ]
    },
    "handoff_rules": {
      "negative_sentiment": true,
      "failed_turns": 1,
      "off_topic_redirects": 0,
      "vip_budget_rupees": 100000,
      "vip_tags": [
        "string"
      ]
    },
    "working_hours": {
      "shifts": [
        {
          "days": [
            1
          ],
          "start": "string",
          "end": "string"
        }
      ]
    },
    "config": {
      "price_policy": "exact",
      "caps": {
        "replies_per_day": 1,
        "followups_per_week": 0
      },
      "quiet_hours": {
        "start": "string",
        "end": "string"
      },
      "human_active_minutes": 5,
      "handoff_idle_hours": 1,
      "allowed_asset_ids": [
        "cmusrceel0000q7kaafxqi1om"
      ],
      "intent_templates": {
        "follow_up": "cmusrceel0000q7kaafxqi1om",
        "visit_confirmation": "cmusrceel0000q7kaafxqi1om",
        "handoff_notice": "cmusrceel0000q7kaafxqi1om",
        "reengage": "cmusrceel0000q7kaafxqi1om"
      }
    },
    "settings_version": 0,
    "eval": {
      "settings_version": 0,
      "passed": true,
      "current": true,
      "ran_at": "string",
      "gates": {},
      "failed_cases": [
        "string"
      ],
      "cases": 0
    },
    "channels": [
      {
        "channel_account_id": "cmusrceel0000q7kaafxqi1om",
        "label": "string",
        "address": "string",
        "status": "string",
        "mode": "off",
        "changed_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "is_active": true,
    "archived_at": "2026-10-06T05:30:00.000Z",
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/ai/agents/{id}/eval

Run the agent check: the offline eval gates on the agent’s current settings (no AI credits)

Every case runs through the agent’s turn engine with ideal answers (correct replies are never blocked) and faulty ones (the safety net catches invented prices, missed opt-outs and hand-offs, off-topic answers). Gates: 0 unsourced numbers, opt-out detection ≥ 99 %, slot F1 ≥ 0.95, correct hand-offs ≥ 95 %, off-topic refusals ≥ 98 %. The result is stored against the settings version.

Access: Signed-in members only (web or Android session) — not for API keys. Permission ai.agents_manage.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: AiAgentEvalReport
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/ai/agents/{id}/eval' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "agent": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "kind": "string",
      "persona": "string",
      "instructions": "string",
      "languages": [
        "string"
      ],
      "actions": [
        "send_asset"
      ],
      "qualification": {
        "slots": [
          "transaction"
        ],
        "required": [
          "transaction"
        ]
      },
      "handoff_rules": {
        "negative_sentiment": true,
        "failed_turns": 1,
        "off_topic_redirects": 0,
        "vip_budget_rupees": 100000,
        "vip_tags": [
          "string"
        ]
      },
      "working_hours": {
        "shifts": [
          {
            "days": [
              null
            ],
            "start": "string",
            "end": "string"
          }
        ]
      },
      "config": {
        "price_policy": "exact",
        "caps": {
          "replies_per_day": 1,
          "followups_per_week": 0
        },
        "quiet_hours": {
          "start": "string",
          "end": "string"
        },
        "human_active_minutes": 5,
        "handoff_idle_hours": 1,
        "allowed_asset_ids": [
          "cmusrceel0000q7kaafxqi1om"
        ],
        "intent_templates": {
          "follow_up": "cmusrceel0000q7kaafxqi1om",
          "visit_confirmation": "cmusrceel0000q7kaafxqi1om",
          "handoff_notice": "cmusrceel0000q7kaafxqi1om",
          "reengage": "cmusrceel0000q7kaafxqi1om"
        }
      },
      "settings_version": 0,
      "eval": {
        "settings_version": 0,
        "passed": true,
        "current": true,
        "ran_at": "string",
        "gates": {},
        "failed_cases": [
          "string"
        ],
        "cases": 0
      },
      "channels": [
        {
          "channel_account_id": "cmusrceel0000q7kaafxqi1om",
          "label": "string",
          "address": "string",
          "status": "string",
          "mode": "off",
          "changed_at": "2026-10-06T05:30:00.000Z"
        }
      ],
      "is_active": true,
      "archived_at": "2026-10-06T05:30:00.000Z",
      "created_at": "2026-10-06T05:30:00.000Z",
      "updated_at": "2026-10-06T05:30:00.000Z"
    },
    "passed": true,
    "modes": [
      {
        "mode": "self-check",
        "passed": true,
        "cases": 0,
        "skipped": 0,
        "gates": {},
        "failed_cases": [
          "string"
        ]
      }
    ]
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

PATCH/v1/ai/agents/{id}

Change an agent’s settings (bumps its settings version: the agent check must pass again to go live)

Access: Signed-in members only (web or Android session) — not for API keys. Permission ai.agents_manage.

Parameters

idpathrequired: Id
Opaque record id.

Request body

name: string
persona: string or null
instructions: string or null
languages: array of "en" | "hi" | "hinglish" | "mr" | "ta" | "te" | …
actions: array of "send_asset" | "create_shortlist" | "book_visit" | "schedule_followup" | "mark_disqualified"
qualification: object
qualification.slotsrequired: array of "transaction" | "budget" | "bhk" | "property_type" | "locality" | "city" | …
qualification.requiredrequired: array of "transaction" | "budget" | "bhk" | "property_type" | "locality" | "city" | …
handoff_rules: object
Requests for a person, complaints, RERA complaints, negotiation, booking or payment and legal / tax / loan questions always hand off; these settings tune the rest.
handoff_rules.negative_sentimentrequired: boolean
Hand off when the customer is upset (complaints always do).
handoff_rules.failed_turnsrequired: integer
handoff_rules.off_topic_redirectsrequired: integer
handoff_rules.vip_budget_rupeesrequired: integer or null
handoff_rules.vip_tagsrequired: array of string
working_hours: object or null
null = 24×7; otherwise ISO weekdays and HH:mm windows in the company time zone.
working_hours.shiftsrequired: array of object
working_hours.shifts[].daysrequired: array of integer
working_hours.shifts[].startrequired: string
working_hours.shifts[].endrequired: string
config: object
config.price_policy: "exact" | "band" | "never" or null
null = the company AI setting.
config.caps: object
config.caps.replies_per_dayrequired: integer
config.caps.followups_per_weekrequired: integer
config.quiet_hours: object
config.quiet_hours.startrequired: string
config.quiet_hours.endrequired: string
config.human_active_minutes: integer
config.handoff_idle_hours: integer
config.allowed_asset_ids: array of Id
Opaque record id.
config.intent_templates: object
config.intent_templates.follow_uprequired: Id or null
Opaque record id.
config.intent_templates.visit_confirmationrequired: Id or null
Opaque record id.
config.intent_templates.handoff_noticerequired: Id or null
Opaque record id.
config.intent_templates.reengagerequired: Id or null
Opaque record id.

Response · 200

datarequired: AiAgent
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/ai/agents/{id}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"name":"string","persona":"string","instructions":"string","languages":["en"],"actions":["send_asset"],"qualification":{"slots":["transaction"],"required":["transaction"]},"handoff_rules":{"negative_sentiment":true,"failed_turns":1,"off_topic_redirects":0,"vip_budget_rupees":100000,"vip_tags":["string"]},"working_hours":{"shifts":[{"days":[1],"start":"string","end":"string"}]},"config":{"price_policy":"exact","caps":{"replies_per_day":1,"followups_per_week":0},"quiet_hours":{"start":"string","end":"string"},"human_active_minutes":5,"handoff_idle_hours":1,"allowed_asset_ids":["cmusrceel0000q7kaafxqi1om"],"intent_templates":{"follow_up":"cmusrceel0000q7kaafxqi1om","visit_confirmation":"cmusrceel0000q7kaafxqi1om","handoff_notice":"cmusrceel0000q7kaafxqi1om","reengage":"cmusrceel0000q7kaafxqi1om"}}}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "kind": "string",
    "persona": "string",
    "instructions": "string",
    "languages": [
      "string"
    ],
    "actions": [
      "send_asset"
    ],
    "qualification": {
      "slots": [
        "transaction"
      ],
      "required": [
        "transaction"
      ]
    },
    "handoff_rules": {
      "negative_sentiment": true,
      "failed_turns": 1,
      "off_topic_redirects": 0,
      "vip_budget_rupees": 100000,
      "vip_tags": [
        "string"
      ]
    },
    "working_hours": {
      "shifts": [
        {
          "days": [
            1
          ],
          "start": "string",
          "end": "string"
        }
      ]
    },
    "config": {
      "price_policy": "exact",
      "caps": {
        "replies_per_day": 1,
        "followups_per_week": 0
      },
      "quiet_hours": {
        "start": "string",
        "end": "string"
      },
      "human_active_minutes": 5,
      "handoff_idle_hours": 1,
      "allowed_asset_ids": [
        "cmusrceel0000q7kaafxqi1om"
      ],
      "intent_templates": {
        "follow_up": "cmusrceel0000q7kaafxqi1om",
        "visit_confirmation": "cmusrceel0000q7kaafxqi1om",
        "handoff_notice": "cmusrceel0000q7kaafxqi1om",
        "reengage": "cmusrceel0000q7kaafxqi1om"
      }
    },
    "settings_version": 0,
    "eval": {
      "settings_version": 0,
      "passed": true,
      "current": true,
      "ran_at": "string",
      "gates": {},
      "failed_cases": [
        "string"
      ],
      "cases": 0
    },
    "channels": [
      {
        "channel_account_id": "cmusrceel0000q7kaafxqi1om",
        "label": "string",
        "address": "string",
        "status": "string",
        "mode": "off",
        "changed_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "is_active": true,
    "archived_at": "2026-10-06T05:30:00.000Z",
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.