---
title: "Update an AI Inbox Manager guidance"
method: PATCH
path: "/api/v2/ai-agents/inbox-manager/{id}/guidances/{guidance_id}"
tags: ["AIInboxManager"]
---

# Update an AI Inbox Manager guidance

`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

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`

## Path parameters

- `id` string, uuid, required
- `guidance_id` string, uuid, required

## Request body

- object
  - `label` string: Label of the guidance
  - `category` 0 | 1 | 2 | 3 | 4: Category of the guidance
  - `instruction` string: Instruction text. Must be empty for BASICS guidances.
  - `status` 1 | 0: Status of the guidance. Ignored for BASICS guidances, which are always active.
  - `basic_guidance_options` object: Tone and length options. Required for the BASICS category, rejected for every other category.
    - `tone` 'friendly' | 'neutral' | 'matter_of_fact' | 'professional' | 'humorous', required: Tone of voice for the agent
    - `length` 'concise' | 'standard' | 'thorough', required: Response length preference

## Response `200`

The updated guidance

- AIAgentGuidance: A guidance category or input box for an AI agent
  - `id` string, uuid, required: Unique identifier for the AI agent guidance
  - `organization_id` string, uuid, required: Organization ID
  - `agent_id` string, uuid, required: Associated AI Agent ID
  - `label` string, required: Label of the AI agent guidance
  - `instruction` string, required: Instruction text for the AI agent guidance. Should be empty string for BASICS category.
  - `status` 1 | 0, required: Status of the AI agent guidance
  - `category` 0 | 1 | 2 | 3 | 4, required: Category of the AI agent guidance
  - `basic_guidance_options` object: Basic guidance options (tone, length, etc.) - only for BASICS category
    - `tone` 'friendly' | 'neutral' | 'matter_of_fact' | 'professional' | 'humorous', required: Tone of voice for the AI agent
    - `length` 'concise' | 'standard' | 'thorough', required: Response length preference
  - `timestamp_created` string, required: Timestamp when the AI agent guidance was created
  - `timestamp_updated` string, required: Timestamp when the AI agent guidance was updated

## 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/inbox-manager/:id/guidances/:guidance_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/adcd5b3299da?raw)