Get a custom instruction

Retrieve a single custom instruction by its id

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

Response

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

401

Unauthorized Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error

1	import requests
2
3	url = "https://example.ada.support/api/v2/custom-instructions/custom_instruction_id"
4
5	headers = {"Authorization": "Bearer <token>"}
6
7	response = requests.get(url, headers=headers)
8
9	print(response.json())

1	{
2	"id": "65a17e3f43bec88e2792d0eb",
3	"title": "Refund policy",
4	"text": "Always confirm the order number before issuing a refund.",
5	"enabled": true,
6	"notes": "Reviewed by the CX team."
7	}