customInstructions

Get a custom instruction

Retrieve a single custom instruction by its id

get/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

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.