HomeUse CasesConceptsConfig GuidesDeveloper GuidesAPI Reference
API Reference

Update an existing purpose and it's version

put
https://{tenanturl}/config/v1.0/privacy/purposes//

Use this API to update an existing purpose by ID and version.
Note: Only purpose version in draft state can be updated.

Entitlements required:

  • managePurpose (Manage privacy purposes and EULA)

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests

LoadingLoading

Path Params
string
required

Purpose id

integer
required

Purpose version

Body Params

Purpose information

string
required
length ≀ 100

Name of the purpose.

tags
array of strings

Tags to indicate what the purpose is going to be collected

tags
integer
1 to 3650

The default validity (in days) of user consents created for this purpose.

string
length ≀ 512

Description of the purpose.

boolean
Defaults to true

A boolean flag that indicates whether attributes can continue to be accessed under consent to previous version.

accessTypes
array of objects
required

Access types associated with this purpose.

accessTypes*
string
length ≀ 256
Defaults to default

The purpose category: "eula" or "default".

customAttributes
array of objects

A list of custom attributes for this purpose.

customAttributes
termsOfUse
object

The terms of use documentation associated with this purpose.

attributes
array of objects
attributes
Responses
204

The operation(s) were successful (No Content).

Updated 12 months ago

Language
URL
LoadingLoading

Response
Choose an example:
application/json

Updated 12 months ago