metadata-purpose-regulation-override

Create a MetadataPurposeRegulationOverride

Changed on

Create a new MetadataPurposeRegulationOverride

post/metadata/purposes-regulations-overrides

Request

  • Base URL
    https://api.didomi.io (the document declares no server; this is the origin it was published from)
  • URL
    https://api.didomi.io/metadata/purposes-regulations-overrides
  • Auth
    HTTP bearer

Request body

organization_idstring required

ID of the organization which the MetadataPurposeRegulationOverride belongs to

regulations_idstring[]

Regulation IDs this override assigns to the purpose. Sending this field (including null) sets override_regulations to true unless that field is sent explicitly. Omit both this field and override_regulations on create to keep the legacy meaning: all regulations.

override_regulationsboolean

When false, catalog regulations stay in effect. Omitted on create defaults to true (legacy omit regulations_id meant all regulations). Send false for a flag-only override.

metadata_purpose_idstring required

The ID of the associated global (organization_id=null) metadata purpose

opted_out_by_gpcboolean nullable

Org-scoped GPC flag. Null inherits the catalog purpose default.

necessary_to_generate_revenueboolean nullable

Org-scoped Consent-or-Pay flag. Null inherits the catalog purpose default.

Response

The created MetadataPurposeRegulationOverride object

idstring required

The unique identifier of the override

organization_idstring required

ID of the organization that owns the override

created_atstring date-time

Creation date of the override

updated_atstring date-time

Last update date of the override

deleted_atstring date-time

Deletion date of the override

regulations_idstring[]

An array of regulation IDs the override configures the metadata purpose to support when override_regulations is true

override_regulationsboolean

When false, catalog regulations stay in effect and regulations_id is unused. True (the default for existing rows) applies regulations_id, where null means every regulation.

metadata_purpose_idstring required

The ID of the associated global (organization_id=null) metadata purpose

opted_out_by_gpcboolean nullable

Org-scoped GPC flag. Null inherits the catalog purpose default.

necessary_to_generate_revenueboolean nullable

Org-scoped Consent-or-Pay flag. Null inherits the catalog purpose default.

Changes

  • 32787b3e7b03Revision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status