Skip to content

Update Doc Settings

PUT
/org/settings/docs/{scope}

Set the default documents for ONE scope.

mandatory_doc_ids omitted leaves the current mandatory set alone; sending an empty list CLEARS it. The two are different instructions and only one is destructive.

Authorizations

Parameters

Path Parameters

scope
required

Which generation scope these defaults apply to.

string
Allowed values: contacts accounts prospects campaigns global

Which generation scope these defaults apply to.

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Mirrors UpdateDocSettingsRequest.

mandatory_doc_ids omitted means LEAVE THE CURRENT MANDATORY SET ALONE. Sending [] CLEARS it. The two are different instructions and only one is destructive.

object
default_doc_ids
required

Document type ids generated by default for this scope.

Array<string>
mandatory_doc_ids
Any of:
Array<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