customInstructions

Create a custom instruction

Create a new custom instruction for the AI Agent. New instructions default to inactive (enabled: false); enable one by setting enabled: true on create or via a later update.

post/v2/custom-instructions/

Request

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

Request body

titlestring required

Display name for the custom instruction (unique per Agent)

textstring required

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)

availability_rulesstring nullable

Optional availability rule as a rule-expression string with v("<variable_name>") lookups. Omit or send null for no rule. A rule that references an unknown variable, or that is malformed or uses an unsupported operator, is rejected with 400.

Response

Created

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.