HomeUse CasesConceptsConfig GuidesDeveloper GuidesAPI Reference
API Reference

Create a privacy rule in a tenant.

post
https://{tenanturl}/config/v1.0/privacy/rules

Use this API to create a privacy rule.

Entitlements required:

  • managePrivacyPolicy (Manage privacy rules and policy)

Body Params

Privacy rule information.

string
required
length ≀ 100

Name of the Privacy Rule. Max 100 chars.

string
length ≀ 512

Short description about the privay rule. Max 512 chars.

integer

Privacy Rule start epoch timestamp, nullable

integer

Privacy rule epoch timestamp, nullable

boolean
Defaults to true

A boolean flag that is an informational field to indicate whether the rule information can be disclosed to the enduser. Defaulted to true.

boolean
Defaults to false

A boolean flag that is an informational field which can be used during consent collection page, to indicate whether the consent 'allow/opt in' option need to be 'checked' when the page is displayed. Defaulted to false.

integer
required
1 to 4

Privacy rule's legal category:
do_not_show : 1,
transparency : 2,
opt_in_out : 3,
consent : 4

tags
array of strings

Tags to indicate what the tags associated with the rule,only alphanumeric values without spaces, max of 10 tags per policy, with each tag having a maximum of 64 chars.

tags
decision
object
required

An object that contains the result or script. In case both are specified, then the script supercedes the result.

conditions
array of objects
required
conditions*
Responses
201

Successfully Created, retrieve the id from the location header.

Updated 11 months ago

Language
URL
Response 
 Choose an example:
application/json
Updated 11 months ago