--- title: "Update an AI Inbox Manager" method: PATCH path: "/api/v2/ai-agents/inbox-manager/{id}" tags: ["AIInboxManager"] --- # Update an AI Inbox Manager `PATCH /api/v2/ai-agents/inbox-manager/{id}` ## Request - Base URL: `https://api.instantly.ai` - URL: `https://api.instantly.ai/api/v2/ai-agents/inbox-manager/{id}` - Auth: HTTP bearer Update an AI Inbox Manager, including its configuration. Requires one of the following scopes: `ai_agents:update`, `ai_agents:all`, `all:update`, `all:all` ## Path parameters - `id` string, uuid, required ## Request body - object - `name` string: Name of the AI Inbox Manager - `status` 0 | 1: Status of the AI Inbox Manager. 0 pauses the agent, 1 activates it. - `payload` object: Configuration of the AI Inbox Manager - `configuration_type` 1 | 2: Type of the AI agent configuration - `tags` union[]: List of tags to use for AI Agent - union - 'default' - string, uuid - `handle_followup` boolean: Whether to handle follow-up emails - `respond_to_automatic_emails` boolean: Whether to respond to automatic emails - `handle_objections` boolean: Whether to handle objections, declines, or negative replies - `integrations` object: Configurations for app integrations. Set an integration to null to disconnect it. - `slack` object, nullable: Slack notification settings - `connection_id` string: Slack app connection ID - `enabled` boolean: Whether Slack notifications are enabled - `connection_name` string: Deprecated. Kept only so previously stored values round-trip. - `channel_id` string: Deprecated. Kept only so previously stored values round-trip. - `channel_name` string: Deprecated. Kept only so previously stored values round-trip. - `calendly` object, nullable: Calendly scheduling settings - `connection_id` string: Calendly app connection ID - `calendar_uri` string: URI of the Calendly event type to book - `calendar_name` string: Display name of the Calendly event type - `disable_auto_booking` boolean: When true, the agent shares the scheduling link instead of booking directly - `connection_name` string, nullable: Display name of the Calendly connection - `scheduling_url` string, nullable: Public scheduling URL of the selected event type - `custom_questions` object[], nullable: Custom questions configured on the Calendly event type - `name` string - `type` string - `required` boolean - `answer_choices` string[] - `include_other` boolean - `enabled` boolean - `position` number - `no_show` object: No-show recovery feature configuration - `enabled` boolean: Enable no-show recovery mode - `max_followups` number: Maximum number of no-show follow-up emails (1-10) - `fallback_sending_accounts` object - `accounts` string[] - `tag_ids` string[] - `trigger_on_labels_enabled` boolean: Whether to activate the agent only for specific interest labels - `trigger_on_labels` number[]: Array of interest_status values to trigger the agent on - `trigger_on_labels_mode` 'include' | 'exclude': Whether to include or exclude the selected labels. Defaults to include. - `monthly_credit_budget` number, nullable: Monthly AI credit budget for this agent (null = unlimited) - `followup_business_days_only` boolean: Whether to send follow-up emails only on business days (Mon-Fri) - `followup_delay` integer, nullable: How long to wait before each follow-up email, in `followup_delay_unit`. Measured from the agent's last email to the lead. Use 1 to 90 days or 1 to 2160 hours. If the lead asks for a specific time, the agent uses that time instead. `null` (the default) lets the agent pick the timing (about 3 days). - `followup_delay_unit` 'hours' | 'days': Unit of `followup_delay`. Defaults to `days`. ## Response `200` The updated AI Inbox Manager - AIInboxManager: An AI Inbox Manager agent - `id` string, uuid, required: Unique identifier for the AI agent - `organization_id` string, uuid, required: Organization ID - `name` string, required: Name of the AI Agent - `payload` object, required: Reply agent (Inbox Manager) payload - `configuration_type` 1 | 2: Type of the AI agent configuration - `tags` union[]: List of tags to use for AI Agent - union - 'default' - string, uuid - `handle_followup` boolean: Whether to handle follow-up emails - `respond_to_automatic_emails` boolean: Whether to respond to automatic emails - `handle_objections` boolean: Whether to handle objections, declines, or negative replies - `integrations` object: Configurations for app integrations - `no_show` object: No-show recovery feature configuration - `enabled` boolean: Enable no-show recovery mode - `max_followups` number: Maximum number of no-show follow-up emails (1-10) - `fallback_sending_accounts` object - `accounts` string[] - `tag_ids` string[] - `trigger_on_labels_enabled` boolean: Whether to activate the agent only for specific interest labels - `trigger_on_labels` number[]: Array of interest_status values to trigger the agent on - `trigger_on_labels_mode` 'include' | 'exclude': Whether to include or exclude the selected labels. Defaults to include. - `monthly_credit_budget` number, nullable: Monthly AI credit budget for this agent (null = unlimited) - `followup_business_days_only` boolean: Whether to send follow-up emails only on business days (Mon-Fri) - `followup_delay` integer, nullable: How long to wait before each follow-up email, in `followup_delay_unit`. Measured from the agent's last email to the lead. Use 1 to 90 days or 1 to 2160 hours. If the lead asks for a specific time, the agent uses that time instead. `null` (the default) lets the agent pick the timing (about 3 days). - `followup_delay_unit` 'hours' | 'days': Unit of `followup_delay`. Defaults to `days`. - `type` 1 | 2 | 3 | 4 | 6 | 7 | 8 | 9 | 10 | 11, nullable: Type of the AI Agent - `timestamp_created` string, required: Timestamp when the AI agent was created - `timestamp_updated` string, required: Timestamp when the AI agent was updated - `status` -1 | 0 | 1, required: Status of the AI Agent - `is_auto_created` boolean, nullable: Whether the AI agent was auto-created - `created_by` string, uuid, nullable: User ID who created the AI agent - `description` string, nullable: Description of the AI agent - `metadata` object: Included only when the `with_metadata` parameter is `true`. Contains additional information about the ai agent as tags. - `tags` object: The tags associated with the ai agent - `integrations` object: The integrations associated with the ai agent ## 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 - `403`: This request is forbidden (the API key scope or workspace plan does not allow this action) - `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/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/406ab2c4f714?raw)