Skip to content
FacilydevelopersDashboard
Build with Facily
DocsREST APIsPatch Organization Config
Search the full API reference Esc to close

Patch Organization Config

Organization · REST API reference

Get support
PATCH/v1/organization/config
Set/reset organization-level config overrides, and report the fan-out.

Authentication

Bearer API key or Facily session, subject to permissions and facility scope.

Authentication and scope

Request example

Replace bracketed path values with real IDs from your environment. The body, where shown, is generated from the schema and uses illustrative values.

cURL
curl --request PATCH \
  --url 'https://api.staging.facily.ai/v1/organization/config' \
  --header "Authorization: Bearer $FACILY_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{}'
An example for building your request, not an executed call. Check required fields, allowed values, and environment configuration before sending.

Request body

application/json · Required

object

Responses

Expand a status to inspect its schema. Generated examples show structure and synthetic values.

200Successful Response
JSON · generated example
{
  "data": {
    "access_control": {
      "inherited": {},
      "inherited_from": {},
      "overrides": {},
      "resolved": {}
    },
    "billing": {
      "inherited": {},
      "inherited_from": {},
      "overrides": {},
      "resolved": {}
    },
    "delinquency": {
      "inherited": {},
      "inherited_from": {},
      "overrides": {},
      "resolved": {}
    },
    "downstream": {
      "changed": [
        "00000000-0000-4000-8000-000000000001"
      ],
      "kept_own": [
        "00000000-0000-4000-8000-000000000001"
      ],
      "partially_changed": [
        "00000000-0000-4000-8000-000000000001"
      ],
      "retained_siblings": {}
    },
    "localization": {
      "inherited": {},
      "inherited_from": {},
      "overrides": {},
      "resolved": {}
    },
    "notifications": {
      "inherited": {},
      "inherited_from": {},
      "overrides": {},
      "resolved": {}
    },
    "operations": {
      "inherited": {},
      "inherited_from": {},
      "overrides": {},
      "resolved": {}
    },
    "payments": {
      "inherited": {},
      "inherited_from": {},
      "overrides": {},
      "resolved": {}
    }
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

dataOrganizationConfigPatchResponserequired

`PATCH /v1/organization/config`.

Show data schema
access_controlConfigDomainResponserequired

One config domain's GET/PATCH response: effective value + provenance.

Show access_control schema
inheritedobjectrequired
inherited_fromobjectrequired
overridesobjectrequired
resolvedobjectrequired
billingConfigDomainResponserequired

One config domain's GET/PATCH response: effective value + provenance.

Show billing schema
inheritedobjectrequired
inherited_fromobjectrequired
overridesobjectrequired
resolvedobjectrequired
delinquencyConfigDomainResponserequired

One config domain's GET/PATCH response: effective value + provenance.

Show delinquency schema
inheritedobjectrequired
inherited_fromobjectrequired
overridesobjectrequired
resolvedobjectrequired
downstreamDownstreamImpactResponserequired

The fan-out report on `PATCH /v1/organization/config`: how far this save actually reached.

Show downstream schema
changedstring[]required

Facilities overriding NONE of the leaves this save wrote -- the organization value lands.

Show changed schema
string
kept_ownstring[]required

Facilities overriding EVERY leaf this save wrote -- the save reached nothing there.

Show kept_own schema
string
partially_changedstring[]required

Facilities overriding SOME but not all of the leaves this save wrote. Only a multi-leaf save can produce this; a single-leaf save has exactly two honest answers.

Show partially_changed schema
string
retained_siblingsobject

Detail, never a count: facility id -> domain -> the facility's own leaf paths that sit under the same nested object as something this save wrote and therefore survive it. Lets a drill-down say 'receipt will be enabled; Beta keeps its own channels'. Facilities with nothing retained are absent.

localizationConfigDomainResponserequired

One config domain's GET/PATCH response: effective value + provenance.

Show localization schema
inheritedobjectrequired
inherited_fromobjectrequired
overridesobjectrequired
resolvedobjectrequired
notificationsConfigDomainResponserequired

One config domain's GET/PATCH response: effective value + provenance.

Show notifications schema
inheritedobjectrequired
inherited_fromobjectrequired
overridesobjectrequired
resolvedobjectrequired
operationsConfigDomainResponserequired

One config domain's GET/PATCH response: effective value + provenance.

Show operations schema
inheritedobjectrequired
inherited_fromobjectrequired
overridesobjectrequired
resolvedobjectrequired
paymentsConfigDomainResponserequired

One config domain's GET/PATCH response: effective value + provenance.

Show payments schema
inheritedobjectrequired
inherited_fromobjectrequired
overridesobjectrequired
resolvedobjectrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
400Validation error
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
401Unauthenticated
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
403Permission denied
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
404Not found
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
409Business logic error
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
503Temporary failure
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
Build something that works beautifully.

Facily API · Contract v1.200 · Reviewed October 29, 2026

Patch Organization Config | Facily Developers