Update Agreement

put

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

Path Params

tenantId

string

required

Tenant identifier.

agreementId

string

required

Body Params

type

string

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

name

string

The human readable name for the type of agreement.

title

string

The human readable title of the individual agreement.

content

string

Content of the agreement.

versionName

string

Human readable version of the agreement.

version

number

Relative to the versioning of agreements.

mustAgree

boolean

Determines whether access to the application is affected by consent.

issuedAt

date-time

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

brandCode

string

Affiliate code to which to apply the agreement (use null value to un-set the current affiliate code). 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 updated.