metadata

Create a partner-purpose association

Changed on

Creates a new association between a partner and purpose, optionally scoped to an organization

post/metadata/partners-purposes

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/partners-purposes
  • Auth
    HTTP bearer

Request body

metadata_partner_idstring required

Foreign key reference to metadata-partners(id)

metadata_purpose_idstring required

Foreign key reference to metadata-purposes(id)

organization_idstring nullable

Optional organization ID for org-specific overrides. Null indicates a global association

processing_rulesstring[] required

Processing rules for this partner-purpose combination. essential carries no user choice: the purpose is disclosed but cannot be consented to or objected to, so it cannot be combined with opt-in or opt-out

is_flexibleboolean

Whether the declared processing rule may be overridden by a publisher restriction. Defaults to false. Cannot be set on an essential association. Writable only with client type auth

Response

idstring required

Unique identifier for the partner-purpose association

metadata_partner_idstring required

Foreign key reference to metadata-partners(id)

metadata_purpose_idstring required

Foreign key reference to metadata-purposes(id)

organization_idstring nullable

Optional organization ID for org-specific overrides. Null indicates a global association

processing_rulesstring[] required

Processing rules for this partner-purpose combination. essential carries no user choice: the purpose is disclosed but cannot be consented to or objected to, so it cannot be combined with opt-in or opt-out

is_org_overrideboolean

Read-only flag indicating if this is an organization override of a global association

is_flexibleboolean

Whether the declared processing rule may be overridden by a publisher restriction. The declared rule stays authoritative until a publisher restricts the purpose. Cannot be set on an essential association, which declares no legal basis to override. Writable only with client type auth

default_purposes_idstring nullable

Legacy foreign key reference to metadata-partners-default-purposes(id)

legitimate_interest_purposes_idstring nullable

Legacy foreign key reference to metadata-partners-legitimate-interest-purposes(id)

created_atstring date-time

Timestamp of record creation

updated_atstring date-time

Timestamp of last update

versioninteger

Version number for concurrency control

Changes

  • 70997bf7efc9Revision changes
    • warning

      added the new essential enum value to the / response property for the response status

    • info

      added the new optional request property

    • info

      added the new essential enum value to the request property /

    • info

      added the optional property to the response with the status