Create Agreement

post

https://tenants-gateway-api-sbx.sidedrawersbx.com/api/v1/tenants/tenant/tenant-id/{tenantId}/agreements

Path Params

tenantId

string

required

Tenant identifier.

Body Params

locale

string

enum

required

Locale in [ISO 639-1]-[ISO 3166-1] format. For example: en-CA, fr-CA, en-US, es-US.

Allowed:

type

string

required

The type of agreement (e.g. privacypolicy).

name

string

required

The human readable name for the type of agreement.

title

string

required

The human readable title of the individual agreement.

content

string

required

Content of the agreement.

versionName

string

Human readable version of the agreement.

version

number

required

Relative to the versioning of agreements.

mustAgree

boolean

required

Determines whether access to the application is affected by consent.

issuedAt

date-time

required

The date:time the agreement goes into effect (ISO-8601 Format, e.g. 2026-06-27T14:34:08.700Z).

brandCode

string

The affiliate code (brandCode) is an identifier for the "brand" or "affiliate" within a Tenant. The affiliate code is the version of the brand name that appears in the URL. A brand name may be "Corporate ABC", for example. Then the affiliate code might be something like "corporate-abc".

pdfUrl

string

URL of the PDF for external source.

autoGeneratePDFAgreement

boolean

Auto generate PDF agreement (default: false).

Response

200

Agreement has been successfully created.

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here!