Skip to content

Update Compliance Settings

PUT
/org/settings/compliance

Patch certification status, keyed by certification id.

PARTIAL: only the ids you send are touched. An id the product does not support is IGNORED rather than rejected - that is the app’s behaviour, so read the response back rather than assuming the write landed.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Mirrors UpdateComplianceSettingsRequest.

A PARTIAL patch keyed by certification id: only the ids you send are touched, and an id the product does not support is ignored rather than rejected - which is the app’s behaviour, not a choice made here. Read GET /org/settings/compliance for the supported ids.

object
certifications
required

Certification id -> status. Unknown ids are ignored by the server.

object
key
additional properties

Mirrors campaign_builder.routers.org_settings.CertificationStatus.

object
achieved_date
Any of:
string
enabled

Whether the organization holds this certification.

boolean
report_doc_id
Any of:
string

Responses

200

Successful Response

object
data
required

An open envelope for one settings block, document or brand artefact.

OPEN on purpose. These surfaces are configuration and generated content, and both grow: a new toggle on a settings block or a new field on a generated document must reach a caller on the day it ships, not on the day somebody remembers to widen a mirror. A closed response model here would silently DROP the new key, which reads to the caller as “the product does not have that setting”.

The request side is the opposite and is mirrored exactly - see the module docstring for why the asymmetry is deliberate.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string