Skip to main content
POST
Record the caller's acceptance of one or more documents

Authorizations

Authorization
string
header
required

JWT Bearer token authentication. Include your access token in the Authorization header as: Bearer YOUR_ACCESS_TOKEN

Example:

Body

application/json

Body for POST /profile/accept-terms.

documents is OPTIONAL, and omitting it is the safer call for any surface that cannot be certain which versions it rendered -- see the field description.

documents
AcceptedDocument · object[] | null

The documents being accepted, each with the version the surface displayed. Omit the field entirely to accept every currently-published signup document at the server's own versions: a caller that cannot name a version reliably must omit this rather than send a guess, because the alternative it used to have was skipping the request and recording nothing. Required only where the caller genuinely knows its version, such as the checkout surface's renewal_terms.

Required array length: 1 - 8 elements

Response

Acceptance recorded

recorded
integer
required

How many acceptance rows were written.