Custom InstructionsCustom Instructions

Update a custom instruction

Update a custom instruction. Only the fields provided in the request body are changed; omitted fields are left as they are.

Authentication

AuthorizationBearer

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

Path parameters

custom_instruction_idstringRequired
The id of the custom instruction

Request

This endpoint expects an object.
titlestringOptional1-150 characters

Display name for the custom instruction (unique per Agent)

textstringOptional1-300 characters

The instruction content — the rule the Agent should follow

enabledbooleanOptional
Whether the instruction is enabled. False means inactive.
notesstringOptional

Internal notes about this instruction (not shown to the Agent). Send an empty string to blank it; omit it to leave the existing notes unchanged.

availability_rulesstring or nullOptional

Optional availability rule as a rule-expression string with v("<variable_name>") lookups. Send a non-empty string to set or replace it, null to clear it, or omit to leave it unchanged. A rule that references an unknown variable, or that is malformed or uses an unsupported operator, is rejected with 400.

Response

OK
idstringRead-only
The unique identifier for the custom instruction
titlestring<=150 characters

Display name for the custom instruction (unique per Agent)

textstring<=300 characters

The instruction content — the rule the Agent should follow

enabledbooleanDefaults to false
Whether the instruction is enabled. False means inactive.
notesstring or null

Internal notes about this instruction (not shown to the Agent)

availability_rulesstring or null

Availability rule gating which end users this instruction applies to, as a rule-expression string with v("<variable_name>") variable lookups. null when no rule is set.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error