Sign in

v1

latestOpenAPI 3.0.22026-07-1319091298.3 KB
purposes

Update a purpose

Update an existing purpose and replace all its properties

put/metadata/purposes/{id}

Path parameters

idstring required

The ID of the purpose to update

Request body

{"stackTrail":"components:schemas:purposes-patch-input:properties:description","oasType":"schema","type":"unknown","description":"Name of the purpose"}
{"stackTrail":"components:schemas:purposes-patch-input:properties:details","oasType":"schema","type":"unknown","description":"Details of the purpose"}
{"stackTrail":"components:schemas:purposes-patch-input:properties:enabled_status_description","oasType":"schema","type":"unknown","description":"Description of the purpose when the sdk status for the user for this purpose is enabled"}
{"stackTrail":"components:schemas:purposes-patch-input:properties:disabled_status_description","oasType":"schema","type":"unknown","description":"Description of the purpose when the sdk status for the user for this purpose is disabled"}
{"stackTrail":"components:schemas:purposes-patch-input:properties:reference","oasType":"schema","type":"unknown","description":"The reference number uniquely identifies the purpose in an official classification like the one from the CNIL"}
organization_idstring

Id of organization which purpose belongs to. If id is 'null', purpose is global

metadataobject

Metadata for additional information

regulations_idstring[]

An array of regulation IDs the purpose supports

Response

The updated Purpose object

idstring required

Purpose ID

descriptionobject

Name of the purpose

detailsobject

Details of the purpose

enabled_status_descriptionobject

Description of the purpose when the sdk status for the user for this purpose is enabled

disabled_status_descriptionobject

Description of the purpose when the sdk status for the user for this purpose is disabled

referenceobject

The reference number uniquely identifies the purpose in an official classification like the one from the CNIL

organization_idstring

Id of organization which purpose belongs to. If id is null, purpose is global

created_atstring date-time

Creation date of the purpose

updated_atstring date-time

Last update date of the purpose

regulations_idstring[]

An array of regulation IDs the purpose supports

typestring

The purpose type discriminator.

metadataobject

Metadata for additional information