Skip to main content
PATCH
Update a document rule

Authorizations

Authorization
string
header
required

Organization-scoped bearer credential: a customer API key (1club_sk_live_...) or an MCP OAuth access token.

Headers

Idempotency-Key
string

Retry-safe key; a repeat of the same request replays the first response

Maximum string length: 255

Path Parameters

id
integer
required

Document rule id

Body

application/json

Fields accepted when updating a document rule. Send only what changes; documentIds and filters replace the stored value wholesale. Unknown fields are refused.

name
string

Internal name, shown to staff in the admin portal.

Required string length: 1 - 255
documentIds
integer[]

The documents the rule requires: content ids of type document in this organization. Duplicates are ignored. Replaces the whole set when sent on an update.

Required array length: 1 - 50 elements
isActive
boolean

A switched-off rule asks nobody. Defaults to true on create.

mandatoryToAccept
boolean

true: members must accept before they can finish setting up their account. false: optional - members may decline. Defaults to true on create.

requiresTypedNameAcceptance
boolean

Members must scroll to the end and type their full name, instead of ticking a box. Mandatory rules only.

requiredForEntry
boolean

A matching member who has not signed cannot check themselves in (tablet, member QR, portal, door access) until they do. Staff check-in is never refused. Mandatory rules only.

Optional rules only: each member's answer is also written to this channel's marketing consent. null records nothing.

Available options:
marketing_email,
marketing_sms,
whatsapp,
null
filters
object

Who the rule asks. Every axis means everyone when empty or left out. Sent as one object that replaces the stored filters wholesale: an axis left out is cleared. Plan and tag ids must be the organization's (an id already on the rule is kept even if it no longer exists).

Response

The updated document rule

A document rule: which members are asked to read and accept which documents, and how.

id
integer
name
string
description
string | null
isActive
boolean
mandatoryToAccept
boolean

true: members must accept to finish setting up their account. false: optional, they may decline.

requiresTypedNameAcceptance
boolean

Members type their full name to accept. Only ever true on a mandatory rule.

requiredForEntry
boolean

An unsigned matching member cannot check themselves in. Only ever true on a mandatory rule.

The marketing channel each answer is written to. Only ever set on an optional rule.

Available options:
marketing_email,
marketing_sms,
whatsapp,
null
filters
object

Who the rule asks. Every axis means everyone when empty; a member must match every axis the rule sets.

documentIds
integer[]

The documents the rule requires, ascending.

documents
object[]
createdAt
string<date-time>
updatedAt
string<date-time>