INinstantly
AIInboxManager

Create an AI Inbox Manager guidance

Changed on

Create a guidance for an AI Inbox Manager. The BASICS category is an upsert: it carries tone/length options instead of an instruction, is always active, and an agent has at most one — creating a second one updates the existing guidance in place.

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

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

Request

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

Path parameters

idstring uuid required
Example:0195b1a5-3b1d-7b6e-9c1a-2f7a4b0c1d2e

AI Inbox Manager ID

Request body

labelstring required

Label of the guidance

category0 | 1 | 2 | 3 | 4 required

Category of the guidance

instructionstring

Instruction text. Required for every category except BASICS, where it must be empty.

status1 | 0

Status of the guidance. Required for every category except BASICS, which is 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 created (or, for BASICS, 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": "01a19e6d-5112-78b2-a4b9-25d6753c4d2e",
  "organization_id": "01a19e6d-5112-78b2-a4b9-25d7203d126c",
  "agent_id": "01a19e6d-5112-78b2-a4b9-25d88ee1b88e",
  "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:42:06.738Z",
  "timestamp_updated": "2026-11-02T22:42:06.738Z"
}

Changes