customInstructions

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.

patch/v2/custom-instructions/{custom_instruction_id}

Request

  • Base URL: https://example.ada.support/api
  • URL: https://example.ada.support/api/v2/custom-instructions/{custom_instruction_id}
  • Auth: HTTP bearer

Path parameters

custom_instruction_idstring required

The id of the custom instruction

Request body

titlestring

Display name for the custom instruction (unique per Agent)

textstring

The instruction content — the rule the Agent should follow

enabledboolean

Whether the instruction is enabled. False means inactive.

notesstring

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 nullable

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

idstring required

The unique identifier for the custom instruction

titlestring required

Display name for the custom instruction (unique per Agent)

textstring required

The instruction content — the rule the Agent should follow

enabledboolean required

Whether the instruction is enabled. False means inactive.

notesstring nullable

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

availability_rulesstring nullable

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.

Changes

No recorded changes to this operation across all 1 revision of this API.