Skip to main content
PATCH
Update an AI Sales Agent guidance rule

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 Sales Agent ID

Example:

"01a0206f-e41a-71fd-81e8-6a08f3a23cc7"

rule_id
string
required

Positional guidance rule id from the guidance rules list (e.g. rule-0). Ids re-index after a deletion.

Pattern: ^rule-(0|[1-9][0-9]*)$
Example:

"rule-0"

Body

application/json
title
string

Short title of the rule

Maximum string length: 119
Pattern: ^[^\n\r]*$
Example:

"Tone of voice"

content
string

The rule text the agent must follow

Minimum string length: 1
Example:

"Always write in a friendly, casual tone and keep emails under 100 words."

Response

The updated guidance rule

A guidance rule the AI Sales Agent must follow when writing outreach. An agent can have at most 10 rules. Rule ids are positional (rule-0, rule-1, …) and re-index after a deletion.

id
string
required

Positional rule id. Re-indexed after a deletion, so re-fetch the list after deleting a rule.

Example:

"rule-0"

title
string
required

Short title of the rule

Maximum string length: 119
Example:

"Tone of voice"

content
string
required

The rule text the agent must follow

Example:

"Always write in a friendly, casual tone and keep emails under 100 words."