INinstantly
AIInboxManager

Update an AI Inbox Manager guidance

Changed on

Update a guidance of an AI Inbox Manager. BASICS guidances keep an empty instruction and stay active; a guidance cannot be changed to or from the BASICS category.

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

patch/api/v2/ai-agents/inbox-manager/{id}/guidances/{guidance_id}

Request

  • Base URL
    https://api.instantly.ai
  • URL
    https://api.instantly.ai/api/v2/ai-agents/inbox-manager/{id}/guidances/{guidance_id}
  • Auth
    HTTP bearer

Path parameters

idstring uuid required
Example:01a19e6f-7f11-7cff-a60e-4554111a7c96

AI Inbox Manager ID

guidance_idstring uuid required
Example:01a19e6f-7f11-7cff-a60e-45553b82ab17

Guidance ID

Request body

labelstring

Label of the guidance

category0 | 1 | 2 | 3 | 4

Category of the guidance

instructionstring

Instruction text. Must be empty for BASICS guidances.

status1 | 0

Status of the guidance. Ignored for BASICS guidances, which are always active.

Example request

{
  "label": "Handover to sales",
  "category": 1,
  "instruction": "Always answer pricing questions with a link to the pricing page.",
  "status": 1,
  "basic_guidance_options": {
    "tone": "professional",
    "length": "standard"
  }
}

Response

The updated guidance

idstring uuid required

Unique identifier for the AI agent guidance

organization_idstring uuid required

Organization ID

agent_idstring uuid required

Associated AI Agent ID

labelstring required

Label of the AI agent guidance

instructionstring required

Instruction text for the AI agent guidance. Should be empty string for BASICS category.

status1 | 0 required

Status of the AI agent guidance

category0 | 1 | 2 | 3 | 4 required

Category of the AI agent guidance

timestamp_createdstring required

Timestamp when the AI agent guidance was created

timestamp_updatedstring required

Timestamp when the AI agent guidance was updated

Example response

{
  "id": "01a19e6f-50d7-7292-9aa1-0cdc2740da41",
  "organization_id": "01a19e6f-50d7-7292-9aa1-0cdd5eb00929",
  "agent_id": "01a19e6f-50d7-7292-9aa1-0cdedea31cb1",
  "label": "Test AI Agent Guidance",
  "instruction": "This is an AI agent guidance instruction",
  "status": 1,
  "category": 1,
  "basic_guidance_options": {
    "tone": "professional",
    "length": "standard"
  },
  "timestamp_created": "2026-11-02T22:44:17.751Z",
  "timestamp_updated": "2026-11-02T22:44:17.751Z"
}

Changes