Skip to content

Propose a tenant canon extension

Canon module

POST/canon/extensions/proposecanonExtensions.propose

Proposes a tenant extension discipline or category in the `.50` to `.99` range, scoped to the caller's org. Codes outside the range are refused. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.

  • Requires the capability canon.extension.write.
  • OAuth scopes: canon.
  • Send an Idempotency-Key header. A replay with the same key returns the original response.
  • Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.

Request body: CanonIntakeCreate

canonExtensions.propose: CanonIntakeCreate
FieldTypeRequiredDescription
proposed_kindstringYesWhat kind of canon value is proposed.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
proposed_codestringYesProposed code.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
proposed_labelstringYesProposed label.Constraints: length 1 to 200
rationalestringYesWhy the addition is needed.Constraints: length 1 to 20000
{
  "proposed_kind": "category",
  "proposed_code": "4000.01.50",
  "proposed_label": "Modular Stage Systems",
  "rationale": "Several orgs track modular stage systems."
}

Response 201: CanonIntake

canonExtensions.propose: CanonIntake
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the canon intake.
created_atstring (date-time)YesWhen the row was created.
updated_atstring (date-time)YesWhen the row was last updated.
proposed_kindstringYesWhat kind of canon value is proposed.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
proposed_codestringYesProposed code.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
proposed_labelstringYesProposed label.Constraints: length 1 to 200
rationalestringYesWhy the addition is needed.Constraints: length 1 to 20000
intake_statestringYesIntake state. A Title Case value from the lifecycle's database enum.Constraints: pattern ^[A-Z0-9][A-Za-z0-9&'/.()-]*( [A-Za-z0-9&'/.()-]+)*$
{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "updated_at": "2026-10-08T14:30:00Z",
  "proposed_kind": "category",
  "proposed_code": "4000.01.50",
  "proposed_label": "Modular Stage Systems",
  "rationale": "Several orgs track modular stage systems.",
  "intake_state": "Proposed"
}

Code samples

curl -X POST "$XOS_BASE_URL/canon/extensions/propose" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"proposed_kind":"category","proposed_code":"4000.01.50","proposed_label":"Modular Stage Systems","rationale":"Several orgs track modular stage systems."}'
const { data } = await xos.canonExtensions.propose({
    "proposed_kind": "category",
    "proposed_code": "4000.01.50",
    "proposed_label": "Modular Stage Systems",
    "rationale": "Several orgs track modular stage systems."
  });
response = xos.canon_extensions.propose({"proposed_kind": "category", "proposed_code": "4000.01.50", "proposed_label": "Modular Stage Systems", "rationale": "Several orgs track modular stage systems."})
xos canon-extensions propose --data '{"proposed_kind":"category","proposed_code":"4000.01.50","proposed_label":"Modular Stage Systems","rationale":"Several orgs track modular stage systems."}'