Skip to main content
PATCH
Update an AI Inbox Manager guidance

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string<uuid>
required

AI Inbox Manager ID

Example:

"01a0206f-e3db-7cc8-ae31-3b2764161d51"

guidance_id
string<uuid>
required

Guidance ID

Example:

"01a0206f-e3db-7cc8-ae31-3b28887b6a0d"

Body

application/json
label
string

Label of the guidance

Minimum string length: 1
Example:

"Handover to sales"

category
enum<number>

Category of the guidance

Available options:
0,
1,
2,
3,
4
Example:

1

instruction
string

Instruction text. Must be empty for BASICS guidances.

Example:

"Always answer pricing questions with a link to the pricing page."

status
enum<number>

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

Available options:
1,
0
Example:

1

basic_guidance_options
object

Tone and length options. Required for the BASICS category, rejected for every other category.

Response

The updated guidance

A guidance category or input box for an AI agent

id
string<uuid>
required
read-only

Unique identifier for the AI agent guidance

Example:

"01a0206f-abe9-7309-a84a-ca7d81a7f5a2"

organization_id
string<uuid>
required
read-only

Organization ID

Example:

"01a0206f-abe9-7309-a84a-ca7ef639acdf"

agent_id
string<uuid>
required

Associated AI Agent ID

Example:

"01a0206f-abe9-7309-a84a-ca7fb073efb3"

label
string
required

Label of the AI agent guidance

Example:

"Test AI Agent Guidance"

instruction
string
required

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

Example:

"This is an AI agent guidance instruction"

status
enum<number>
required

Status of the AI agent guidance

Available options:
1,
0
Example:

1

category
enum<number>
required

Category of the AI agent guidance

Available options:
0,
1,
2,
3,
4
Example:

1

timestamp_created
string
required
read-only

Timestamp when the AI agent guidance was created

Example:

"2026-08-20T18:29:44.553Z"

timestamp_updated
string
required
read-only

Timestamp when the AI agent guidance was updated

Example:

"2026-08-20T18:29:44.553Z"

basic_guidance_options
object

Basic guidance options (tone, length, etc.) - only for BASICS category