INinstantly
AISalesAgent

Update an AI Sales Agent guidance rule

Changed on

Update the title or content of a guidance rule. Rules are stored as a single list, so concurrent writes to the same agent are last-write-wins — serialize them client-side.

Requires one of the following scopes: ai_sdr:update, ai_sdr:all, all:update, all:all

patch/api/v2/ai-agents/sales/{id}/guidance-rules/{rule_id}

Request

  • Base URL
    https://api.instantly.ai
  • URL
    https://api.instantly.ai/api/v2/ai-agents/sales/{id}/guidance-rules/{rule_id}
  • Auth
    HTTP bearer

Path parameters

idstring uuid required
Example:01a19e6d-85a8-74a1-93de-a7b94a962e68

AI Sales Agent ID

rule_idstring required
Example:rule-0

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

Request body

titlestring

Short title of the rule

contentstring

The rule text the agent must follow

Example request

{
  "title": "Tone of voice",
  "content": "Always write in a friendly, casual tone and keep emails under 100 words."
}

Response

The updated guidance rule

idstring required

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

titlestring required

Short title of the rule

contentstring required

The rule text the agent must follow

Example response

{
  "id": "rule-0",
  "title": "Tone of voice",
  "content": "Always write in a friendly, casual tone and keep emails under 100 words."
}

Changes