{ "info": { "_postman_id": "48638dcb-0b9a-4ac2-92b1-77857a6fe9d4", "name": "Didomi API", "description": "A REST API to communicate with the Didomi platform (https://api.didomi.io/v1/)\n\nThis is the complete specification of the API. A complete guide to authenticating and using the API is available on our Developers Portal.\n\nAll HTTP calls to the API require a valid JWT token. The token must be provided in an **Authorization** header with the value \"Bearer \".\nClick on the Authorize button in the header of this page to provide a token before testing requests from this documentation.\n\n", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-06-05T15:07:55.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "lastUpdatedBy": "35240", "uid": "35240-48638dcb-0b9a-4ac2-92b1-77857a6fe9d4" }, "item": [ { "name": "consents", "item": [ { "name": "events", "item": [ { "name": "{id}", "item": [ { "name": "Retrieve an event", "id": "f228913b-b750-4d45-93f7-bf7e01205f24", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/consents/events/:id?organization_id=&user_id=&organization_user_id=", "host": [ "{{baseUrl}}" ], "path": [ "consents", "events", ":id" ], "query": [ { "description": "(Required) The ID of the organization that the event belongs to", "key": "organization_id", "value": "" }, { "description": "The Didomi user ID for which to retrieve events. You must provide either **user_id** or **organization_user_id** when querying events", "key": "user_id", "value": "" }, { "description": "The organization user ID for which to retrieve events. You must provide either **user_id** or **organization_user_id** when querying events", "key": "organization_user_id", "value": "" } ], "variable": [ { "id": "3c4aecd5-cf1f-4306-b113-442e6d58275f", "key": "id", "value": "", "description": "(Required) The ID of the event to retrieve" } ] }, "description": "Returns an event" }, "response": [ { "id": "f65a195d-589b-4486-bcdb-a449ad6684e6", "name": "A ConsentEvent object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/consents/events/:id?organization_id=&user_id=&organization_user_id=", "host": [ "{{baseUrl}}" ], "path": [ "consents", "events", ":id" ], "query": [ { "description": "(Required) The ID of the organization that the event belongs to", "key": "organization_id", "value": "" }, { "description": "The Didomi user ID for which to retrieve events. You must provide either **user_id** or **organization_user_id** when querying events", "key": "user_id", "value": "" }, { "description": "The organization user ID for which to retrieve events. You must provide either **user_id** or **organization_user_id** when querying events", "key": "organization_user_id", "value": "" } ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"value\": \"reference #/definitions/consent-events not found in the OpenAPI spec\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-f65a195d-589b-4486-bcdb-a449ad6684e6" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-f228913b-b750-4d45-93f7-bf7e01205f24" }, { "name": "Patch an event", "id": "2bb9b6b2-52fa-4667-aa3c-67d10919073f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/consents/events/:id?organization_id=&user_id=&organization_user_id=", "host": [ "{{baseUrl}}" ], "path": [ "consents", "events", ":id" ], "query": [ { "description": "(Required) The ID of the organization that the event belongs to", "key": "organization_id", "value": "" }, { "description": "The Didomi user ID for which to update events. You must provide either **user_id** or **organization_user_id** when updating events", "key": "user_id", "value": "" }, { "description": "The organization user ID for which to update events. You must provide either **user_id** or **organization_user_id** when updating events", "key": "organization_user_id", "value": "" } ], "variable": [ { "id": "244d3469-5806-4056-8b1f-e8907a7ee941", "key": "id", "value": "", "description": "(Required) The ID of the event to update" } ] }, "description": "Patch an existing event" }, "response": [ { "id": "bbdb0128-c4f4-462b-9058-742e040c364d", "name": "The patched ConsentEvent object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/consents/events/:id?organization_id=&user_id=&organization_user_id=", "host": [ "{{baseUrl}}" ], "path": [ "consents", "events", ":id" ], "query": [ { "description": "(Required) The ID of the organization that the event belongs to", "key": "organization_id", "value": "" }, { "description": "The Didomi user ID for which to update events. You must provide either **user_id** or **organization_user_id** when updating events", "key": "user_id", "value": "" }, { "description": "The organization user ID for which to update events. You must provide either **user_id** or **organization_user_id** when updating events", "key": "organization_user_id", "value": "" } ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"value\": \"reference #/definitions/consent-events not found in the OpenAPI spec\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-bbdb0128-c4f4-462b-9058-742e040c364d" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-2bb9b6b2-52fa-4667-aa3c-67d10919073f" }, { "name": "Delete an event", "id": "8ff030eb-099c-4b40-960a-652131699364", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/consents/events/:id?organization_id=&user_id=&organization_user_id=", "host": [ "{{baseUrl}}" ], "path": [ "consents", "events", ":id" ], "query": [ { "description": "(Required) The ID of the organization that the event belongs to", "key": "organization_id", "value": "" }, { "description": "The Didomi user ID for which to delete events. You must provide either **user_id** or **organization_user_id** when querying events", "key": "user_id", "value": "" }, { "description": "The organization user ID for which to delete events. You must provide either **user_id** or **organization_user_id** when querying events", "key": "organization_user_id", "value": "" } ], "variable": [ { "id": "80d8b27e-4c58-41e9-ab2a-5f6a1ef53b83", "key": "id", "value": "", "description": "(Required) The ID of the event to delete" } ] }, "description": "Delete an event and update the user consent status as if the event had never happened ; the user consent status is re-computed from all events for that user except deleted events" }, "response": [ { "id": "43e2a599-3d63-4c5e-a8d3-af50e9a8f335", "name": "The event was successfully deleted and the user consent status has been updated", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/consents/events/:id?organization_id=&user_id=&organization_user_id=", "host": [ "{{baseUrl}}" ], "path": [ "consents", "events", ":id" ], "query": [ { "description": "(Required) The ID of the organization that the event belongs to", "key": "organization_id", "value": "" }, { "description": "The Didomi user ID for which to delete events. You must provide either **user_id** or **organization_user_id** when querying events", "key": "user_id", "value": "" }, { "description": "The organization user ID for which to delete events. You must provide either **user_id** or **organization_user_id** when querying events", "key": "organization_user_id", "value": "" } ], "variable": [ { "key": "id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-43e2a599-3d63-4c5e-a8d3-af50e9a8f335" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-8ff030eb-099c-4b40-960a-652131699364" } ], "id": "5cc22da9-e804-4526-b904-5763875c0ab7", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-5cc22da9-e804-4526-b904-5763875c0ab7" }, { "name": "Retrieve events", "id": "3bac0e8a-da8e-40c4-8e21-0f7423961198", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/consents/events?organization_id=&user_id=&organization_user_id=&status=®ulation=", "host": [ "{{baseUrl}}" ], "path": [ "consents", "events" ], "query": [ { "description": "(Required) The ID of the organization for which to retrieve events", "key": "organization_id", "value": "" }, { "description": "The Didomi user ID for which to retrieve events. You must provide either **user_id** or **organization_user_id** when querying events", "key": "user_id", "value": "" }, { "description": "The organization user ID for which to retrieve events. You must provide either **user_id** or **organization_user_id** when querying events", "key": "organization_user_id", "value": "" }, { "description": "Filter events according to their status (possible values: confirmed, pending_approval). If this field is missing, only confirmed events are returned. To filter on multiple statuses in a single request, use the notation status[$in]: ?status[$in]=confirmed&status[$in]=pending_approval.", "key": "status", "value": "" }, { "description": "Filter events according to their regulation. Possible value is any existing regulation in the Regulations API (/compliance/v1/regulations). If this field is missing, only GDPR events are returned. To filter on multiple regulations in a single request, use the notation regulation[$in]: ?regulation[$in]=gdpr®ulation[$in]=cpra.", "key": "regulation", "value": "" } ] }, "description": "Returns a list of events for a given organization ID and user ID or organization user ID" }, "response": [ { "id": "07780d8d-5aef-4c73-9256-c8d0b676cd44", "name": "A list of ConsentEvent objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/consents/events?organization_id=&user_id=&organization_user_id=&status=®ulation=", "host": [ "{{baseUrl}}" ], "path": [ "consents", "events" ], "query": [ { "description": "(Required) The ID of the organization for which to retrieve events", "key": "organization_id", "value": "" }, { "description": "The Didomi user ID for which to retrieve events. You must provide either **user_id** or **organization_user_id** when querying events", "key": "user_id", "value": "" }, { "description": "The organization user ID for which to retrieve events. You must provide either **user_id** or **organization_user_id** when querying events", "key": "organization_user_id", "value": "" }, { "description": "Filter events according to their status (possible values: confirmed, pending_approval). If this field is missing, only confirmed events are returned. To filter on multiple statuses in a single request, use the notation status[$in]: ?status[$in]=confirmed&status[$in]=pending_approval.", "key": "status", "value": "" }, { "description": "Filter events according to their regulation. Possible value is any existing regulation in the Regulations API (/compliance/v1/regulations). If this field is missing, only GDPR events are returned. To filter on multiple regulations in a single request, use the notation regulation[$in]: ?regulation[$in]=gdpr®ulation[$in]=cpra.", "key": "regulation", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"value\": \"reference #/definitions/consent-events not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/definitions/consent-events not found in the OpenAPI spec\"\n }\n]", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-07780d8d-5aef-4c73-9256-c8d0b676cd44" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-3bac0e8a-da8e-40c4-8e21-0f7423961198" }, { "name": "Create a new event", "id": "15729410-5dcc-4724-8e77-368801082339", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/consents/events?organization_id=&$disable_integrations=&$generate_tcfcs=", "host": [ "{{baseUrl}}" ], "path": [ "consents", "events" ], "query": [ { "description": "(Required) The ID of the organization for which to create an event", "key": "organization_id", "value": "" }, { "description": "Disable sending the event to integrations configured for the organization. Set this parameter to true if you do not want the event processed by integrations (if you are importing events that already exist in the integrated systems, for instance).", "key": "$disable_integrations", "value": "" }, { "description": "Set to \"true\" to generate a TCF consent string for the user based on the latest status of the user", "key": "$generate_tcfcs", "value": "" } ] }, "description": "Create a new event and update the consent status of the user" }, "response": [ { "id": "537a7450-88b4-436f-82ba-2f7fceeacd0d", "name": "The created ConsentEvent object", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/consents/events?organization_id=&$disable_integrations=&$generate_tcfcs=", "host": [ "{{baseUrl}}" ], "path": [ "consents", "events" ], "query": [ { "description": "(Required) The ID of the organization for which to create an event", "key": "organization_id", "value": "" }, { "description": "Disable sending the event to integrations configured for the organization. Set this parameter to true if you do not want the event processed by integrations (if you are importing events that already exist in the integrated systems, for instance).", "key": "$disable_integrations", "value": "" }, { "description": "Set to \"true\" to generate a TCF consent string for the user based on the latest status of the user", "key": "$generate_tcfcs", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"value\": \"reference #/definitions/consent-events not found in the OpenAPI spec\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-537a7450-88b4-436f-82ba-2f7fceeacd0d" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-15729410-5dcc-4724-8e77-368801082339" }, { "name": "Delete events", "id": "3890ebc5-7321-4dbf-8c05-1df4eecd35fb", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/consents/events?organization_id=&user_id=&organization_user_id=&{filters}=", "host": [ "{{baseUrl}}" ], "path": [ "consents", "events" ], "query": [ { "description": "(Required) The ID of the organization that the event belongs to", "key": "organization_id", "value": "" }, { "description": "The Didomi user ID for which to delete events. You must provide either **user_id** or **organization_user_id** when querying events", "key": "user_id", "value": "" }, { "description": "The organization user ID for which to delete events. You must provide either **user_id** or **organization_user_id** when querying events", "key": "organization_user_id", "value": "" }, { "description": "(Required) Keys and values to filter the events to delete. You can filter using any property of the events, including nested properties like metadata by using . as a separator for each level", "key": "{filters}", "value": "" } ] }, "description": "Delete events and update the user consent status as if the events had never happened ; the user consent status is re-computed from all events for that user except deleted events" }, "response": [ { "id": "fc197819-3095-4841-a80d-22f341203125", "name": "The events were successfully deleted and the user consent status has been updated", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/consents/events?organization_id=&user_id=&organization_user_id=&{filters}=", "host": [ "{{baseUrl}}" ], "path": [ "consents", "events" ], "query": [ { "description": "(Required) The ID of the organization that the event belongs to", "key": "organization_id", "value": "" }, { "description": "The Didomi user ID for which to delete events. You must provide either **user_id** or **organization_user_id** when querying events", "key": "user_id", "value": "" }, { "description": "The organization user ID for which to delete events. You must provide either **user_id** or **organization_user_id** when querying events", "key": "organization_user_id", "value": "" }, { "description": "(Required) Keys and values to filter the events to delete. You can filter using any property of the events, including nested properties like metadata by using . as a separator for each level", "key": "{filters}", "value": "" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-fc197819-3095-4841-a80d-22f341203125" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-3890ebc5-7321-4dbf-8c05-1df4eecd35fb" } ], "id": "a78b81c2-d6f3-4eb0-87c7-ee3b6e6a463d", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-a78b81c2-d6f3-4eb0-87c7-ee3b6e6a463d" }, { "name": "proofs", "item": [ { "name": "{id}", "item": [ { "name": "Retrieve a proof", "id": "a6a3be4d-637f-4ca3-87b4-889f82dc3408", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/consents/proofs/:id?organization_id=", "host": [ "{{baseUrl}}" ], "path": [ "consents", "proofs", ":id" ], "query": [ { "description": "(Required) The ID of the organization that the proof belongs to", "key": "organization_id", "value": "" } ], "variable": [ { "id": "5d26cd83-4c56-4978-82b1-a5c0528361e7", "key": "id", "value": "", "description": "(Required) Unique ID of the proof to retrieve" } ] }, "description": "Returns a consent proof" }, "response": [ { "id": "92041018-4b2b-4ccb-8098-de0bca985661", "name": "A ConsentProof object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/consents/proofs/:id?organization_id=", "host": [ "{{baseUrl}}" ], "path": [ "consents", "proofs", ":id" ], "query": [ { "description": "(Required) The ID of the organization that the proof belongs to", "key": "organization_id", "value": "" } ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"value\": \"reference #/definitions/consent-proofs not found in the OpenAPI spec\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-92041018-4b2b-4ccb-8098-de0bca985661" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-a6a3be4d-637f-4ca3-87b4-889f82dc3408" } ], "id": "4dcdbf1a-cdbf-41ac-9bfc-9773637c9c1b", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-4dcdbf1a-cdbf-41ac-9bfc-9773637c9c1b" }, { "name": "Upload a consent proof", "id": "d0c88b53-2cba-4bcc-b8d4-c372a153cb38", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/consents/proofs?organization_id=", "host": [ "{{baseUrl}}" ], "path": [ "consents", "proofs" ], "query": [ { "description": "(Required) The ID of the organization that the proof belongs to", "key": "organization_id", "value": "" } ] }, "description": "Upload a file to serve as proof of consent" }, "response": [ { "id": "f75147a2-7963-40a5-b07a-bf630987e65b", "name": "The created ConsentProof object", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/consents/proofs?organization_id=", "host": [ "{{baseUrl}}" ], "path": [ "consents", "proofs" ], "query": [ { "description": "(Required) The ID of the organization that the proof belongs to", "key": "organization_id", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"value\": \"reference #/definitions/consent-proofs not found in the OpenAPI spec\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-f75147a2-7963-40a5-b07a-bf630987e65b" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-d0c88b53-2cba-4bcc-b8d4-c372a153cb38" } ], "id": "2b30a8d0-a31c-487e-a34b-c221fa0624de", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-2b30a8d0-a31c-487e-a34b-c221fa0624de" }, { "name": "tokens", "item": [ { "name": "Create a new consent token", "id": "f9f0b258-19fe-41de-aecb-31d0b42f15df", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/consents/tokens", "host": [ "{{baseUrl}}" ], "path": [ "consents", "tokens" ] }, "description": "Create a new consent token for the user" }, "response": [ { "id": "991e9266-cebd-4639-a355-1a729db62e93", "name": "The created ConsentToken object", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/consents/tokens", "host": [ "{{baseUrl}}" ], "path": [ "consents", "tokens" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"value\": \"reference #/definitions/consent-tokens not found in the OpenAPI spec\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-991e9266-cebd-4639-a355-1a729db62e93" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-f9f0b258-19fe-41de-aecb-31d0b42f15df" } ], "id": "1dc6d10d-08bf-44f2-9f07-9b04fc2c3f72", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-1dc6d10d-08bf-44f2-9f07-9b04fc2c3f72" }, { "name": "users", "item": [ { "name": "{id}", "item": [ { "name": "Retrieve a user", "id": "8bf2e41a-437a-453d-a6d5-776c8aa6fbeb", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/consents/users/:id?organization_id=&$by_organization_user_id=", "host": [ "{{baseUrl}}" ], "path": [ "consents", "users", ":id" ], "query": [ { "description": "(Required) The ID of the organization that the user belongs to", "key": "organization_id", "value": "" }, { "description": "Add this query-string parameter if you provide an organization user ID as the **id** in the path", "key": "$by_organization_user_id", "value": "" } ], "variable": [ { "id": "294fe222-129d-4616-809b-762f57e5daf8", "key": "id", "value": "", "description": "(Required) The ID of the user to retrieve. You can query by organization user ID here by providing your organization user ID in the path and adding a **$by_organization_user_id** query-string parameter" } ] }, "description": "Returns a user and its consent status" }, "response": [ { "id": "b6340c52-174f-4bdd-81ae-da9b7eab635d", "name": "A ConsentUser object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/consents/users/:id?organization_id=&$by_organization_user_id=", "host": [ "{{baseUrl}}" ], "path": [ "consents", "users", ":id" ], "query": [ { "description": "(Required) The ID of the organization that the user belongs to", "key": "organization_id", "value": "" }, { "description": "Add this query-string parameter if you provide an organization user ID as the **id** in the path", "key": "$by_organization_user_id", "value": "" } ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"value\": \"reference #/definitions/consent-users not found in the OpenAPI spec\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-b6340c52-174f-4bdd-81ae-da9b7eab635d" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-8bf2e41a-437a-453d-a6d5-776c8aa6fbeb" }, { "name": "Patch a user", "id": "d1007340-7e2a-4e31-a395-061c13f04fd6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/consents/users/:id?organization_id=&$by_organization_user_id=&$generate_tcfcs=", "host": [ "{{baseUrl}}" ], "path": [ "consents", "users", ":id" ], "query": [ { "description": "(Required) The ID of the organization that the user belongs to", "key": "organization_id", "value": "" }, { "description": "Add this query-string parameter if you provide an organization user ID as the **id** in the path", "key": "$by_organization_user_id", "value": "" }, { "description": "Set to \"true\" to generate a TCF consent string for the user based on the latest status of the user", "key": "$generate_tcfcs", "value": "" } ], "variable": [ { "id": "01821bba-a98f-474a-8dfb-7ca39f76e8b3", "key": "id", "value": "", "description": "(Required) The ID of the user to update. You can update a user by organization user ID here by providing your organization user ID in the path and adding a **$by_organization_user_id** query-string parameter" } ] }, "description": "Patch an existing user" }, "response": [ { "id": "8179757c-bfe8-41b7-9afa-5838e35fc652", "name": "The patched ConsentUser object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/consents/users/:id?organization_id=&$by_organization_user_id=&$generate_tcfcs=", "host": [ "{{baseUrl}}" ], "path": [ "consents", "users", ":id" ], "query": [ { "description": "(Required) The ID of the organization that the user belongs to", "key": "organization_id", "value": "" }, { "description": "Add this query-string parameter if you provide an organization user ID as the **id** in the path", "key": "$by_organization_user_id", "value": "" }, { "description": "Set to \"true\" to generate a TCF consent string for the user based on the latest status of the user", "key": "$generate_tcfcs", "value": "" } ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"value\": \"reference #/definitions/consent-users not found in the OpenAPI spec\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-8179757c-bfe8-41b7-9afa-5838e35fc652" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-d1007340-7e2a-4e31-a395-061c13f04fd6" }, { "name": "Delete a user", "id": "0a0c273e-d13f-4ef7-893c-b80a1f118b13", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/consents/users/:id?organization_id=&$by_organization_user_id=", "host": [ "{{baseUrl}}" ], "path": [ "consents", "users", ":id" ], "query": [ { "description": "(Required) The ID of the organization that the user belongs to", "key": "organization_id", "value": "" }, { "description": "Add this query-string parameter if you provide an organization user ID as the **id** in the path", "key": "$by_organization_user_id", "value": "" } ], "variable": [ { "id": "5e56cdec-edd4-4569-bcd7-c37c2ced173a", "key": "id", "value": "", "description": "(Required) The ID of the user to delete. You can delete a user by organization user ID here by providing your organization user ID in the path and adding a **$by_organization_user_id** query-string parameter" } ] }, "description": "Delete an existing user" }, "response": [ { "id": "fe6b2e34-0e4a-4364-9779-37ab1b76887d", "name": "The deleted ConsentUser object", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/consents/users/:id?organization_id=&$by_organization_user_id=", "host": [ "{{baseUrl}}" ], "path": [ "consents", "users", ":id" ], "query": [ { "description": "(Required) The ID of the organization that the user belongs to", "key": "organization_id", "value": "" }, { "description": "Add this query-string parameter if you provide an organization user ID as the **id** in the path", "key": "$by_organization_user_id", "value": "" } ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"value\": \"reference #/definitions/consent-users not found in the OpenAPI spec\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-fe6b2e34-0e4a-4364-9779-37ab1b76887d" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-0a0c273e-d13f-4ef7-893c-b80a1f118b13" } ], "id": "8b999feb-9de8-499d-8e1b-14469ca5dcce", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-8b999feb-9de8-499d-8e1b-14469ca5dcce" }, { "name": "Retrieve users", "id": "b23caef5-b426-43db-aa99-1f2d54ceca04", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/consents/users?organization_id=&organization_user_id=®ulation=", "host": [ "{{baseUrl}}" ], "path": [ "consents", "users" ], "query": [ { "description": "(Required) The ID of the organization for which to retrieve users", "key": "organization_id", "value": "" }, { "description": "The organization user ID to retrieve (optional)", "key": "organization_user_id", "value": "" }, { "description": "Filter user consents according to their regulation. Possible value is any existing regulation in the Regulations API (/compliance/v1/regulations). If this field is missing, only GDPR events are returned. To filter on multiple regulations in a single request, use the notation regulation[$in]: ?regulation[$in]=gdpr®ulation[$in]=cpra.", "key": "regulation", "value": "" } ] }, "description": "Returns a list of end users and their consent status" }, "response": [ { "id": "d9601124-eea2-44f7-bd7e-6f5f59880a79", "name": "A list of ConsentUser objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/consents/users?organization_id=&organization_user_id=®ulation=", "host": [ "{{baseUrl}}" ], "path": [ "consents", "users" ], "query": [ { "description": "(Required) The ID of the organization for which to retrieve users", "key": "organization_id", "value": "" }, { "description": "The organization user ID to retrieve (optional)", "key": "organization_user_id", "value": "" }, { "description": "Filter user consents according to their regulation. Possible value is any existing regulation in the Regulations API (/compliance/v1/regulations). If this field is missing, only GDPR events are returned. To filter on multiple regulations in a single request, use the notation regulation[$in]: ?regulation[$in]=gdpr®ulation[$in]=cpra.", "key": "regulation", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"value\": \"reference #/definitions/consent-users not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/definitions/consent-users not found in the OpenAPI spec\"\n }\n]", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-d9601124-eea2-44f7-bd7e-6f5f59880a79" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-b23caef5-b426-43db-aa99-1f2d54ceca04" }, { "name": "Create a new user", "id": "a1366666-6868-4c73-8352-5e9d0e5f2603", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/consents/users?organization_id=&$generate_tcfcs=", "host": [ "{{baseUrl}}" ], "path": [ "consents", "users" ], "query": [ { "description": "(Required) The ID of the organization that the user belongs to", "key": "organization_id", "value": "" }, { "description": "Set to \"true\" to generate a TCF consent string for the user based on the latest status of the user", "key": "$generate_tcfcs", "value": "" } ] }, "description": "Create a new user and store its consent status" }, "response": [ { "id": "bee638b8-7179-4ff3-82e4-b6a568e21276", "name": "The created ConsentUser object", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/consents/users?organization_id=&$generate_tcfcs=", "host": [ "{{baseUrl}}" ], "path": [ "consents", "users" ], "query": [ { "description": "(Required) The ID of the organization that the user belongs to", "key": "organization_id", "value": "" }, { "description": "Set to \"true\" to generate a TCF consent string for the user based on the latest status of the user", "key": "$generate_tcfcs", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"value\": \"reference #/definitions/consent-users not found in the OpenAPI spec\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-bee638b8-7179-4ff3-82e4-b6a568e21276" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-a1366666-6868-4c73-8352-5e9d0e5f2603" } ], "id": "5e326396-2c89-4a51-a59d-62be4f7eee8a", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-5e326396-2c89-4a51-a59d-62be4f7eee8a" } ], "id": "5f82cb9f-6928-42a6-a790-2fa96aa8bb96", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-5f82cb9f-6928-42a6-a790-2fa96aa8bb96" }, { "name": "widgets", "item": [ { "name": "notices", "item": [ { "name": "remote-configs", "item": [ { "name": "Deploy a SDK config", "id": "f180bb22-3876-47eb-abc9-913015d99862", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/widgets/notices/remote-configs", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", "remote-configs" ] }, "description": "Directly deploy a SDK config to the production environment for the property" }, "response": [ { "id": "1f886efa-5fd4-4a11-9763-f0b87e51a450", "name": "created", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/widgets/notices/remote-configs", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", "remote-configs" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"config\": {}\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-1f886efa-5fd4-4a11-9763-f0b87e51a450" }, { "id": "072d40ff-62b0-4830-9800-327e865eff72", "name": "not authenticated", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/widgets/notices/remote-configs", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", "remote-configs" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-072d40ff-62b0-4830-9800-327e865eff72" }, { "id": "74607ab7-38b7-43c4-beeb-aa355bf36346", "name": "forbidden", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/widgets/notices/remote-configs", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", "remote-configs" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-74607ab7-38b7-43c4-beeb-aa355bf36346" }, { "id": "08b1a1d5-f5c1-4b2d-b478-82dd27b573ec", "name": "general error", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/widgets/notices/remote-configs", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", "remote-configs" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-08b1a1d5-f5c1-4b2d-b478-82dd27b573ec" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-f180bb22-3876-47eb-abc9-913015d99862" } ], "id": "b33156cb-7ac2-40d0-b9be-0027af229a8e", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-b33156cb-7ac2-40d0-b9be-0027af229a8e" }, { "name": "texts", "item": [ { "name": "{id}", "item": [ { "name": "Retrieve a notice text", "id": "546e350d-64aa-49f1-9095-cdb0d59a5d12", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/widgets/notices/texts/:id", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", "texts", ":id" ], "variable": [ { "id": "41776696-45c9-4e05-baf3-602b673c1562", "key": "id", "value": "", "description": "(Required) The ID of the notice text to retrieve" } ] }, "description": "Returns a single notice text" }, "response": [ { "id": "bcee2db6-49d6-48cf-85f4-d2d3a6b673cf", "name": "A NoticeText object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/widgets/notices/texts/:id", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", "texts", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"platforms\": [\n \"\",\n \"\"\n ],\n \"organization_id\": \"\",\n \"default\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-bcee2db6-49d6-48cf-85f4-d2d3a6b673cf" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-546e350d-64aa-49f1-9095-cdb0d59a5d12" }, { "name": "Update a notice text", "id": "bbb8a30a-e05e-4e8d-a69d-24e5c9c30170", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"archived_at\": \"\",\n \"version\": \"\",\n \"privacy_experience_id\": \"\",\n \"environment\": \"\",\n \"external_source\": \"\",\n \"external_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/widgets/notices/texts/:id", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", "texts", ":id" ], "variable": [ { "id": "b22595be-4a40-4b0d-b091-5eb9ba72df1e", "key": "id", "value": "", "description": "(Required) The ID of the notice text to update" } ] }, "description": "Update an existing notice text" }, "response": [ { "id": "7d525f13-f948-420e-bdbd-8f0a1b352861", "name": "The updated NoticeText object", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"archived_at\": \"\",\n \"version\": \"\",\n \"privacy_experience_id\": \"\",\n \"environment\": \"\",\n \"external_source\": \"\",\n \"external_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/widgets/notices/texts/:id", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", "texts", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"platforms\": [\n \"\",\n \"\"\n ],\n \"organization_id\": \"\",\n \"default\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-7d525f13-f948-420e-bdbd-8f0a1b352861" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-bbb8a30a-e05e-4e8d-a69d-24e5c9c30170" }, { "name": "Patch a notice text", "id": "890cdbf7-6ebd-4b37-858b-658183cdb3d7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"archived_at\": \"\",\n \"version\": \"\",\n \"privacy_experience_id\": \"\",\n \"environment\": \"\",\n \"external_source\": \"\",\n \"external_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/widgets/notices/texts/:id", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", "texts", ":id" ], "variable": [ { "id": "08aaaf6d-507e-444c-b8ec-3830642d5bcc", "key": "id", "value": "", "description": "(Required) The ID of the notice text to patch" } ] }, "description": "Partially update a notice text" }, "response": [ { "id": "c750214d-477e-4d02-9950-21c13e7a9c5a", "name": "The patched NoticeText object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"archived_at\": \"\",\n \"version\": \"\",\n \"privacy_experience_id\": \"\",\n \"environment\": \"\",\n \"external_source\": \"\",\n \"external_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/widgets/notices/texts/:id", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", "texts", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"platforms\": [\n \"\",\n \"\"\n ],\n \"organization_id\": \"\",\n \"default\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-c750214d-477e-4d02-9950-21c13e7a9c5a" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-890cdbf7-6ebd-4b37-858b-658183cdb3d7" } ], "id": "051f1e6c-5f99-4492-b14f-ae8ed130b3d9", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-051f1e6c-5f99-4492-b14f-ae8ed130b3d9" }, { "name": "Retrieve a list of notice texts", "id": "e007b9bc-5dd5-4c2f-9531-7a4f6e30486f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/widgets/notices/texts", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", "texts" ] }, "description": "Returns a list of notice texts" }, "response": [ { "id": "10dc3196-ec16-413a-8b85-ade4c95db292", "name": "A list of NoticeText objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/widgets/notices/texts", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", "texts" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"platforms\": [\n \"\",\n \"\"\n ],\n \"organization_id\": \"\",\n \"default\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"platforms\": [\n \"\",\n \"\"\n ],\n \"organization_id\": \"\",\n \"default\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n }\n]", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-10dc3196-ec16-413a-8b85-ade4c95db292" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-e007b9bc-5dd5-4c2f-9531-7a4f6e30486f" }, { "name": "Create a notice text", "id": "70ae063e-3d00-499e-a69c-9d87d6c4e465", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"archived_at\": \"\",\n \"version\": \"\",\n \"privacy_experience_id\": \"\",\n \"environment\": \"\",\n \"external_source\": \"\",\n \"external_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/widgets/notices/texts", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", "texts" ] }, "description": "Create a new notice text for an organization" }, "response": [ { "id": "7829be9c-a06b-46b0-a86c-866190b09b6e", "name": "The created NoticeText object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"archived_at\": \"\",\n \"version\": \"\",\n \"privacy_experience_id\": \"\",\n \"environment\": \"\",\n \"external_source\": \"\",\n \"external_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/widgets/notices/texts", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", "texts" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"platforms\": [\n \"\",\n \"\"\n ],\n \"organization_id\": \"\",\n \"default\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-7829be9c-a06b-46b0-a86c-866190b09b6e" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-70ae063e-3d00-499e-a69c-9d87d6c4e465" } ], "id": "87f5ae1e-5b21-41d1-b181-94bd77dd3c1a", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-87f5ae1e-5b21-41d1-b181-94bd77dd3c1a" }, { "name": "texts-contents", "item": [ { "name": "{id}", "item": [ { "name": "Retrieve a notice text content", "id": "2c46e180-0c49-4a89-8ec1-d10ea481e073", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/widgets/notices/texts-contents/:id", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", "texts-contents", ":id" ], "variable": [ { "id": "7e4befb3-798e-483a-b53e-c54ff28304df", "key": "id", "value": "", "description": "(Required) The ID of the notice text content to retrieve" } ] }, "description": "Returns a single notice text content" }, "response": [ { "id": "d5fcbdba-7120-4570-ba44-d96596fb53ca", "name": "A NoticeTextContent object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/widgets/notices/texts-contents/:id", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", "texts-contents", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"content\": \"\",\n \"status\": \"\",\n \"includes_purposes\": \"\",\n \"content_version\": \"\",\n \"organization_id\": \"\",\n \"text_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-d5fcbdba-7120-4570-ba44-d96596fb53ca" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-2c46e180-0c49-4a89-8ec1-d10ea481e073" }, { "name": "Update a notice text content", "id": "1f7e8f48-8f8e-458a-89c7-5294285ce7c0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"archived_at\": \"\",\n \"version\": \"\",\n \"privacy_experience_id\": \"\",\n \"environment\": \"\",\n \"external_source\": \"\",\n \"external_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/widgets/notices/texts-contents/:id", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", "texts-contents", ":id" ], "variable": [ { "id": "75682b56-7b6a-4bf2-ac7a-ab92a8a372cb", "key": "id", "value": "", "description": "(Required) The ID of the notice text content to update" } ] }, "description": "Update an existing notice text content. Text contents cannot be modified once their status is \"approved\". If you want to update an approved text content, create a new content for the same text and get it approved again by the Didomi team." }, "response": [ { "id": "0a23fd84-dcd7-4c27-949c-3441796fdec4", "name": "The updated NoticeTextContent object", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"archived_at\": \"\",\n \"version\": \"\",\n \"privacy_experience_id\": \"\",\n \"environment\": \"\",\n \"external_source\": \"\",\n \"external_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/widgets/notices/texts-contents/:id", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", "texts-contents", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"content\": \"\",\n \"status\": \"\",\n \"includes_purposes\": \"\",\n \"content_version\": \"\",\n \"organization_id\": \"\",\n \"text_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-0a23fd84-dcd7-4c27-949c-3441796fdec4" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-1f7e8f48-8f8e-458a-89c7-5294285ce7c0" }, { "name": "Patch a notice text content", "id": "e6ccdd7b-769c-48eb-8a55-222a451b9429", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"archived_at\": \"\",\n \"version\": \"\",\n \"privacy_experience_id\": \"\",\n \"environment\": \"\",\n \"external_source\": \"\",\n \"external_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/widgets/notices/texts-contents/:id", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", "texts-contents", ":id" ], "variable": [ { "id": "728ce518-e2a2-4563-9c3a-e051e4ddfa38", "key": "id", "value": "", "description": "(Required) The ID of the notice text content to patch" } ] }, "description": "Partially update an existing notice text content. Text contents cannot be modified once their status is \"approved\". If you want to update an approved text content, create a new content for the same text and get it approved again by the Didomi team." }, "response": [ { "id": "a7fdf0a7-02d3-4384-8e72-f949472ce0e0", "name": "The patched NoticeTextContent object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"archived_at\": \"\",\n \"version\": \"\",\n \"privacy_experience_id\": \"\",\n \"environment\": \"\",\n \"external_source\": \"\",\n \"external_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/widgets/notices/texts-contents/:id", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", "texts-contents", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"content\": \"\",\n \"status\": \"\",\n \"includes_purposes\": \"\",\n \"content_version\": \"\",\n \"organization_id\": \"\",\n \"text_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-a7fdf0a7-02d3-4384-8e72-f949472ce0e0" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-e6ccdd7b-769c-48eb-8a55-222a451b9429" }, { "name": "Delete a notice text content", "id": "712b1279-30a2-4e9a-9348-63592d017368", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/widgets/notices/texts-contents/:id", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", "texts-contents", ":id" ], "variable": [ { "id": "5fb71863-7d89-432c-abe3-017f6b8a9455", "key": "id", "value": "", "description": "(Required) The ID of the notice text content to delete" } ] }, "description": "Delete an existing notice text content. Text contents cannot be deleted once their status is \"approved\". If you want to update an approved text content, create a new content for the same text and get it approved again by the Didomi team." }, "response": [ { "id": "652dcd25-a7c3-45f9-9b3e-e753bf1c96f3", "name": "The deleted NoticeTextContent object", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/widgets/notices/texts-contents/:id", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", "texts-contents", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"content\": \"\",\n \"status\": \"\",\n \"includes_purposes\": \"\",\n \"content_version\": \"\",\n \"organization_id\": \"\",\n \"text_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-652dcd25-a7c3-45f9-9b3e-e753bf1c96f3" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-712b1279-30a2-4e9a-9348-63592d017368" } ], "id": "1048f9b9-4b9c-44ae-9dcf-d8d82f9e7e70", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-1048f9b9-4b9c-44ae-9dcf-d8d82f9e7e70" }, { "name": "Retrieve a list of notice text contents", "id": "709f0174-c1f7-4232-8e51-f7abdfad5693", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/widgets/notices/texts-contents", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", "texts-contents" ] }, "description": "Returns a list of notice text contents" }, "response": [ { "id": "f474b7a8-60d1-4bff-941a-f6ae178f1334", "name": "A list of NoticeTextContent objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/widgets/notices/texts-contents", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", "texts-contents" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"content\": \"\",\n \"status\": \"\",\n \"includes_purposes\": \"\",\n \"content_version\": \"\",\n \"organization_id\": \"\",\n \"text_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n },\n {\n \"id\": \"\",\n \"content\": \"\",\n \"status\": \"\",\n \"includes_purposes\": \"\",\n \"content_version\": \"\",\n \"organization_id\": \"\",\n \"text_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n }\n]", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-f474b7a8-60d1-4bff-941a-f6ae178f1334" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-709f0174-c1f7-4232-8e51-f7abdfad5693" }, { "name": "Create a notice text content", "id": "11ed4607-a38f-485d-9f8c-d9034ef9fd40", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"archived_at\": \"\",\n \"version\": \"\",\n \"privacy_experience_id\": \"\",\n \"environment\": \"\",\n \"external_source\": \"\",\n \"external_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/widgets/notices/texts-contents", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", "texts-contents" ] }, "description": "Create a new notice text content for an organization. A content version will be automatically assigned and the content will need to go through the approval process from the Didomi team before it can be used in a notice. If there is already an approved content for a given notice text, it remains available for notices until the new version of the content get approved." }, "response": [ { "id": "516a1200-b940-4623-9bd8-bd73d7da110c", "name": "The created NoticeTextContent object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"archived_at\": \"\",\n \"version\": \"\",\n \"privacy_experience_id\": \"\",\n \"environment\": \"\",\n \"external_source\": \"\",\n \"external_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/widgets/notices/texts-contents", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", "texts-contents" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"content\": \"\",\n \"status\": \"\",\n \"includes_purposes\": \"\",\n \"content_version\": \"\",\n \"organization_id\": \"\",\n \"text_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-516a1200-b940-4623-9bd8-bd73d7da110c" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-11ed4607-a38f-485d-9f8c-d9034ef9fd40" } ], "id": "373f008f-d3cb-4810-892a-2de115ad9769", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-373f008f-d3cb-4810-892a-2de115ad9769" }, { "name": "generators", "item": [ { "name": "sdk", "item": [ { "name": "Generate a SDK configuration", "id": "9c151822-34e6-487f-bd6d-c323dbc210ba", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"archived_at\": \"\",\n \"version\": \"\",\n \"privacy_experience_id\": \"\",\n \"environment\": \"\",\n \"external_source\": \"\",\n \"external_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/widgets/notices/generators/sdk", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", "generators", "sdk" ] }, "description": "Generate a SDK configuration from a notice configuration" }, "response": [ { "id": "d0bc950b-b850-46b4-9c1d-ba70cca5629f", "name": "The generated SDK configuration", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"archived_at\": \"\",\n \"version\": \"\",\n \"privacy_experience_id\": \"\",\n \"environment\": \"\",\n \"external_source\": \"\",\n \"external_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/widgets/notices/generators/sdk", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", "generators", "sdk" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"config\": {}\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-d0bc950b-b850-46b4-9c1d-ba70cca5629f" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-9c151822-34e6-487f-bd6d-c323dbc210ba" } ], "id": "8bffae49-32f8-4024-b413-71dfd77996ad", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-8bffae49-32f8-4024-b413-71dfd77996ad" }, { "name": "configs", "item": [ { "name": "Generate a Notice configuration", "id": "05c0009f-7ad6-4ba4-8489-ca160c575f91", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"archived_at\": \"\",\n \"version\": \"\",\n \"privacy_experience_id\": \"\",\n \"environment\": \"\",\n \"external_source\": \"\",\n \"external_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/widgets/notices/generators/configs", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", "generators", "configs" ] }, "description": "Generate a Notice configuration from a SDK configuration" }, "response": [ { "id": "a264cb51-617a-47b6-9984-8abfeb428ce8", "name": "The generated notice configuration", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"archived_at\": \"\",\n \"version\": \"\",\n \"privacy_experience_id\": \"\",\n \"environment\": \"\",\n \"external_source\": \"\",\n \"external_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/widgets/notices/generators/configs", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", "generators", "configs" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"config\": {}\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-a264cb51-617a-47b6-9984-8abfeb428ce8" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-05c0009f-7ad6-4ba4-8489-ca160c575f91" } ], "id": "7c10d33e-7d25-4a1f-bc11-c1f81b3ebf1f", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-7c10d33e-7d25-4a1f-bc11-c1f81b3ebf1f" } ], "id": "371c86c2-7ba9-405b-bf4e-b02f31ac90d4", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-371c86c2-7ba9-405b-bf4e-b02f31ac90d4" }, { "name": "templates", "item": [ { "name": "configs", "item": [ { "name": "{id}", "item": [ { "name": "Retrieve a notice template configuration", "id": "5347ead7-7895-4c0a-a52e-673519372090", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/widgets/notices/templates/configs/:id?$limit=&$skip=", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", "templates", "configs", ":id" ], "query": [ { "key": "$limit", "value": "" }, { "key": "$skip", "value": "" } ], "variable": [ { "id": "6aab5166-7508-44b4-b4a7-7cc0e5d609df", "key": "id" }, { "id": "9c94c16a-72a9-46a1-a47c-cb5c6f7c343f", "key": "template_id", "value": "", "description": "The ID of the notice template to retrieve configuration" } ] }, "description": "Returns a single notice template configuration" }, "response": [ { "id": "e6d935a0-469d-4072-adf8-44cf686c7482", "name": "A NoticeTemplateConfig object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/widgets/notices/templates/configs/:id?$limit=&$skip=", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", "templates", "configs", ":id" ], "query": [ { "key": "$limit", "value": "" }, { "key": "$skip", "value": "" } ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"total\": \"\",\n \"limit\": \"\",\n \"skip\": \"\",\n \"data\": [\n {\n \"id\": \"\",\n \"template_id\": \"\",\n \"config\": {\n \"app\": {\n \"essentialPurposes\": [\n \"\",\n \"\"\n ],\n \"vendors\": {\n \"include\": [\n \"\",\n \"\"\n ],\n \"iab\": {\n \"all\": \"\",\n \"include\": [\n \"\",\n \"\"\n ],\n \"exclude\": [\n \"\",\n \"\"\n ],\n \"enabled\": \"\",\n \"version\": \"\",\n \"restrictions\": [\n {\n \"id\": \"\",\n \"purposeId\": [\n \"\",\n \"\"\n ],\n \"restrictionType\": \"disallow\",\n \"vendors\": {\n \"restrictionType\": \"all\",\n \"purposeId\": [\n \"\",\n \"\"\n ]\n }\n },\n {\n \"id\": \"\",\n \"purposeId\": [\n \"\",\n \"\"\n ],\n \"restrictionType\": \"req-li\",\n \"vendors\": {\n \"restrictionType\": \"all\",\n \"purposeId\": [\n \"\",\n \"\"\n ]\n }\n }\n ],\n \"stacks\": {\n \"auto\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n }\n }\n },\n \"preferences\": {}\n },\n \"regulation_settings\": {\n \"privacySignals\": [\n {\n \"namespaces\": {},\n \"section\": \"\",\n \"purposes\": [\n \"\",\n \"\"\n ]\n },\n {\n \"namespaces\": {},\n \"section\": \"\",\n \"purposes\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n \"organization_id\": \"\",\n \"version\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"id\": \"\",\n \"template_id\": \"\",\n \"config\": {\n \"app\": {\n \"essentialPurposes\": [\n \"\",\n \"\"\n ],\n \"vendors\": {\n \"include\": [\n \"\",\n \"\"\n ],\n \"iab\": {\n \"all\": \"\",\n \"include\": [\n \"\",\n \"\"\n ],\n \"exclude\": [\n \"\",\n \"\"\n ],\n \"enabled\": \"\",\n \"version\": \"\",\n \"restrictions\": [\n {\n \"id\": \"\",\n \"purposeId\": [\n \"\",\n \"\"\n ],\n \"restrictionType\": \"req-consent\",\n \"vendors\": {\n \"restrictionType\": \"all\",\n \"purposeId\": [\n \"\",\n \"\"\n ]\n }\n },\n {\n \"id\": \"\",\n \"purposeId\": [\n \"\",\n \"\"\n ],\n \"restrictionType\": \"disallow\",\n \"vendors\": {\n \"restrictionType\": \"all\",\n \"purposeId\": [\n \"\",\n \"\"\n ]\n }\n }\n ],\n \"stacks\": {\n \"auto\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n }\n }\n },\n \"preferences\": {}\n },\n \"regulation_settings\": {\n \"privacySignals\": [\n {\n \"namespaces\": {},\n \"section\": \"\",\n \"purposes\": [\n \"\",\n \"\"\n ]\n },\n {\n \"namespaces\": {},\n \"section\": \"\",\n \"purposes\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n \"organization_id\": \"\",\n \"version\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-e6d935a0-469d-4072-adf8-44cf686c7482" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-5347ead7-7895-4c0a-a52e-673519372090" }, { "name": "Update a notice template configuration", "id": "78d7b2c0-76e2-4598-8cbb-8a7f98f5b5f6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"archived_at\": \"\",\n \"version\": \"\",\n \"privacy_experience_id\": \"\",\n \"environment\": \"\",\n \"external_source\": \"\",\n \"external_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/widgets/notices/templates/configs/:id", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", "templates", "configs", ":id" ], "variable": [ { "id": "10f7be98-583a-4228-b81e-e024b81b7001", "key": "id", "value": "", "description": "(Required) The ID of the notice template configuration to update" } ] }, "description": "Update an existing notice template configuration." }, "response": [ { "id": "c5a5f790-caa6-432c-95c0-576145399e95", "name": "The updated NoticeTemplateConfig object", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"archived_at\": \"\",\n \"version\": \"\",\n \"privacy_experience_id\": \"\",\n \"environment\": \"\",\n \"external_source\": \"\",\n \"external_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/widgets/notices/templates/configs/:id", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", "templates", "configs", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"template_id\": \"\",\n \"config\": {\n \"app\": {\n \"essentialPurposes\": [\n \"\",\n \"\"\n ],\n \"vendors\": {\n \"include\": [\n \"\",\n \"\"\n ],\n \"iab\": {\n \"all\": \"\",\n \"include\": [\n \"\",\n \"\"\n ],\n \"exclude\": [\n \"\",\n \"\"\n ],\n \"enabled\": \"\",\n \"version\": \"\",\n \"restrictions\": [\n {\n \"id\": \"\",\n \"purposeId\": [\n \"\",\n \"\"\n ],\n \"restrictionType\": \"req-consent\",\n \"vendors\": {\n \"restrictionType\": \"list\",\n \"purposeId\": [\n \"\",\n \"\"\n ]\n }\n },\n {\n \"id\": \"\",\n \"purposeId\": [\n \"\",\n \"\"\n ],\n \"restrictionType\": \"req-consent\",\n \"vendors\": {\n \"restrictionType\": \"all\",\n \"purposeId\": [\n \"\",\n \"\"\n ]\n }\n }\n ],\n \"stacks\": {\n \"auto\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n }\n }\n },\n \"preferences\": {}\n },\n \"regulation_settings\": {\n \"privacySignals\": [\n {\n \"namespaces\": {},\n \"section\": \"\",\n \"purposes\": [\n \"\",\n \"\"\n ]\n },\n {\n \"namespaces\": {},\n \"section\": \"\",\n \"purposes\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n \"organization_id\": \"\",\n \"version\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-c5a5f790-caa6-432c-95c0-576145399e95" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-78d7b2c0-76e2-4598-8cbb-8a7f98f5b5f6" }, { "name": "Patch a notice template configuration", "id": "c225874f-3483-4b9a-904f-a2fecf7612b9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"archived_at\": \"\",\n \"version\": \"\",\n \"privacy_experience_id\": \"\",\n \"environment\": \"\",\n \"external_source\": \"\",\n \"external_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/widgets/notices/templates/configs/:id", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", "templates", "configs", ":id" ], "variable": [ { "id": "c1bda0a4-b57c-49cd-a82a-e08331b00db9", "key": "id", "value": "", "description": "(Required) The ID of the notice template configuration to patch" } ] }, "description": "Partially update an existing notice template configuration." }, "response": [ { "id": "cd3af02f-310f-4a71-9d3f-0de9d3c9ef99", "name": "The patched NoticeTemplateConfig object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"archived_at\": \"\",\n \"version\": \"\",\n \"privacy_experience_id\": \"\",\n \"environment\": \"\",\n \"external_source\": \"\",\n \"external_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/widgets/notices/templates/configs/:id", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", "templates", "configs", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"template_id\": \"\",\n \"config\": {\n \"app\": {\n \"essentialPurposes\": [\n \"\",\n \"\"\n ],\n \"vendors\": {\n \"include\": [\n \"\",\n \"\"\n ],\n \"iab\": {\n \"all\": \"\",\n \"include\": [\n \"\",\n \"\"\n ],\n \"exclude\": [\n \"\",\n \"\"\n ],\n \"enabled\": \"\",\n \"version\": \"\",\n \"restrictions\": [\n {\n \"id\": \"\",\n \"purposeId\": [\n \"\",\n \"\"\n ],\n \"restrictionType\": \"req-consent\",\n \"vendors\": {\n \"restrictionType\": \"list\",\n \"purposeId\": [\n \"\",\n \"\"\n ]\n }\n },\n {\n \"id\": \"\",\n \"purposeId\": [\n \"\",\n \"\"\n ],\n \"restrictionType\": \"req-consent\",\n \"vendors\": {\n \"restrictionType\": \"all\",\n \"purposeId\": [\n \"\",\n \"\"\n ]\n }\n }\n ],\n \"stacks\": {\n \"auto\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n }\n }\n },\n \"preferences\": {}\n },\n \"regulation_settings\": {\n \"privacySignals\": [\n {\n \"namespaces\": {},\n \"section\": \"\",\n \"purposes\": [\n \"\",\n \"\"\n ]\n },\n {\n \"namespaces\": {},\n \"section\": \"\",\n \"purposes\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n \"organization_id\": \"\",\n \"version\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-cd3af02f-310f-4a71-9d3f-0de9d3c9ef99" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-c225874f-3483-4b9a-904f-a2fecf7612b9" }, { "name": "Removes the resource with id.", "id": "9b30ef6e-54ea-40c3-be5f-d0cf837baa82", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/widgets/notices/templates/configs/:id", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", "templates", "configs", ":id" ], "variable": [ { "id": "802a5083-3598-4c08-a881-71b576aa90d3", "key": "id", "value": "", "description": "(Required) ID of notices to remove" } ] }, "description": "Removes the resource with id." }, "response": [ { "id": "bfd807a1-54a3-4451-8a57-b62be3a41874", "name": "success", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/widgets/notices/templates/configs/:id", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", "templates", "configs", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"archived_at\": \"\",\n \"version\": \"\",\n \"privacy_experience_id\": \"\",\n \"environment\": \"\",\n \"external_source\": \"\",\n \"external_id\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-bfd807a1-54a3-4451-8a57-b62be3a41874" }, { "id": "3671ee3d-c952-43eb-b4c4-6ad94da10d7f", "name": "not authenticated", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/widgets/notices/templates/configs/:id", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", "templates", "configs", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-3671ee3d-c952-43eb-b4c4-6ad94da10d7f" }, { "id": "c2488306-2320-4b61-b9d9-1823b41084f4", "name": "not found", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/widgets/notices/templates/configs/:id", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", "templates", "configs", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-c2488306-2320-4b61-b9d9-1823b41084f4" }, { "id": "8ffbc847-2c85-4663-a390-484ff97d3b79", "name": "general error", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/widgets/notices/templates/configs/:id", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", "templates", "configs", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-8ffbc847-2c85-4663-a390-484ff97d3b79" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-9b30ef6e-54ea-40c3-be5f-d0cf837baa82" } ], "id": "96fe6bbf-b199-4dea-9e42-d2c7ff41971f", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-96fe6bbf-b199-4dea-9e42-d2c7ff41971f" }, { "name": "Retrieve a list of notice template configurations", "id": "b0956c00-db51-4f58-8ea3-76eddfa7ea76", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/widgets/notices/templates/configs?$limit=&$skip=", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", "templates", "configs" ], "query": [ { "key": "$limit", "value": "" }, { "key": "$skip", "value": "" } ] }, "description": "Returns a list of notice template configurations" }, "response": [ { "id": "247fe537-feb0-49e4-956b-e6e32dd0b9c7", "name": "A NoticeTemplateConfig object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/widgets/notices/templates/configs?$limit=&$skip=", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", "templates", "configs" ], "query": [ { "key": "$limit", "value": "" }, { "key": "$skip", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"total\": \"\",\n \"limit\": \"\",\n \"skip\": \"\",\n \"data\": [\n {\n \"id\": \"\",\n \"template_id\": \"\",\n \"config\": {\n \"app\": {\n \"essentialPurposes\": [\n \"\",\n \"\"\n ],\n \"vendors\": {\n \"include\": [\n \"\",\n \"\"\n ],\n \"iab\": {\n \"all\": \"\",\n \"include\": [\n \"\",\n \"\"\n ],\n \"exclude\": [\n \"\",\n \"\"\n ],\n \"enabled\": \"\",\n \"version\": \"\",\n \"restrictions\": [\n {\n \"id\": \"\",\n \"purposeId\": [\n \"\",\n \"\"\n ],\n \"restrictionType\": \"disallow\",\n \"vendors\": {\n \"restrictionType\": \"all\",\n \"purposeId\": [\n \"\",\n \"\"\n ]\n }\n },\n {\n \"id\": \"\",\n \"purposeId\": [\n \"\",\n \"\"\n ],\n \"restrictionType\": \"req-li\",\n \"vendors\": {\n \"restrictionType\": \"all\",\n \"purposeId\": [\n \"\",\n \"\"\n ]\n }\n }\n ],\n \"stacks\": {\n \"auto\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n }\n }\n },\n \"preferences\": {}\n },\n \"regulation_settings\": {\n \"privacySignals\": [\n {\n \"namespaces\": {},\n \"section\": \"\",\n \"purposes\": [\n \"\",\n \"\"\n ]\n },\n {\n \"namespaces\": {},\n \"section\": \"\",\n \"purposes\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n \"organization_id\": \"\",\n \"version\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"id\": \"\",\n \"template_id\": \"\",\n \"config\": {\n \"app\": {\n \"essentialPurposes\": [\n \"\",\n \"\"\n ],\n \"vendors\": {\n \"include\": [\n \"\",\n \"\"\n ],\n \"iab\": {\n \"all\": \"\",\n \"include\": [\n \"\",\n \"\"\n ],\n \"exclude\": [\n \"\",\n \"\"\n ],\n \"enabled\": \"\",\n \"version\": \"\",\n \"restrictions\": [\n {\n \"id\": \"\",\n \"purposeId\": [\n \"\",\n \"\"\n ],\n \"restrictionType\": \"req-consent\",\n \"vendors\": {\n \"restrictionType\": \"all\",\n \"purposeId\": [\n \"\",\n \"\"\n ]\n }\n },\n {\n \"id\": \"\",\n \"purposeId\": [\n \"\",\n \"\"\n ],\n \"restrictionType\": \"disallow\",\n \"vendors\": {\n \"restrictionType\": \"all\",\n \"purposeId\": [\n \"\",\n \"\"\n ]\n }\n }\n ],\n \"stacks\": {\n \"auto\": \"\",\n \"ids\": [\n \"\",\n \"\"\n ]\n }\n }\n }\n },\n \"preferences\": {}\n },\n \"regulation_settings\": {\n \"privacySignals\": [\n {\n \"namespaces\": {},\n \"section\": \"\",\n \"purposes\": [\n \"\",\n \"\"\n ]\n },\n {\n \"namespaces\": {},\n \"section\": \"\",\n \"purposes\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n \"organization_id\": \"\",\n \"version\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-247fe537-feb0-49e4-956b-e6e32dd0b9c7" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-b0956c00-db51-4f58-8ea3-76eddfa7ea76" } ], "id": "5d5280e2-d362-4c8d-91dc-89db3308ddbc", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-5d5280e2-d362-4c8d-91dc-89db3308ddbc" }, { "name": "{id}", "item": [ { "name": "Retrieve a notice template", "id": "df243b0d-9ff1-4f75-8191-0df9c6b6c5d8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/widgets/notices/templates/:id?$limit=&$skip=", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", "templates", ":id" ], "query": [ { "key": "$limit", "value": "" }, { "key": "$skip", "value": "" } ], "variable": [ { "id": "8a260423-b3bc-4396-9625-67375c17d472", "key": "id", "value": "", "description": "The ID of the notice template to retrieve" } ] }, "description": "Returns a single notice template" }, "response": [ { "id": "2bd4c3a1-e256-4336-8d65-12c375c32cde", "name": "A NoticeTemplate object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/widgets/notices/templates/:id?$limit=&$skip=", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", "templates", ":id" ], "query": [ { "key": "$limit", "value": "" }, { "key": "$skip", "value": "" } ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"total\": \"\",\n \"limit\": \"\",\n \"skip\": \"\",\n \"data\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"created_at\": \"\",\n \"organization_id\": \"\",\n \"version\": \"\",\n \"notices_id\": [\n \"\",\n \"\"\n ],\n \"updated_at\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"created_at\": \"\",\n \"organization_id\": \"\",\n \"version\": \"\",\n \"notices_id\": [\n \"\",\n \"\"\n ],\n \"updated_at\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-2bd4c3a1-e256-4336-8d65-12c375c32cde" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-df243b0d-9ff1-4f75-8191-0df9c6b6c5d8" }, { "name": "Updates the resource identified by id using data.", "id": "a6ca2590-7f7b-4cea-ade6-82209a0e2d8a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"archived_at\": \"\",\n \"version\": \"\",\n \"privacy_experience_id\": \"\",\n \"environment\": \"\",\n \"external_source\": \"\",\n \"external_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/widgets/notices/templates/:id", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", "templates", ":id" ], "variable": [ { "id": "af8e2bed-06b2-4213-80b0-bd5bf281423c", "key": "id", "value": "", "description": "(Required) ID of notices to update" } ] }, "description": "Updates the resource identified by id using data." }, "response": [ { "id": "9a614c39-3855-450a-9b08-219076dfe298", "name": "success", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"archived_at\": \"\",\n \"version\": \"\",\n \"privacy_experience_id\": \"\",\n \"environment\": \"\",\n \"external_source\": \"\",\n \"external_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/widgets/notices/templates/:id", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", "templates", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"archived_at\": \"\",\n \"version\": \"\",\n \"privacy_experience_id\": \"\",\n \"environment\": \"\",\n \"external_source\": \"\",\n \"external_id\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-9a614c39-3855-450a-9b08-219076dfe298" }, { "id": "38dbe2ab-e59f-4f03-9f5a-6a61a7df12cb", "name": "not authenticated", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"archived_at\": \"\",\n \"version\": \"\",\n \"privacy_experience_id\": \"\",\n \"environment\": \"\",\n \"external_source\": \"\",\n \"external_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/widgets/notices/templates/:id", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", "templates", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-38dbe2ab-e59f-4f03-9f5a-6a61a7df12cb" }, { "id": "b27ed2e3-de66-4b03-939f-df828e7d5276", "name": "not found", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"archived_at\": \"\",\n \"version\": \"\",\n \"privacy_experience_id\": \"\",\n \"environment\": \"\",\n \"external_source\": \"\",\n \"external_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/widgets/notices/templates/:id", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", "templates", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-b27ed2e3-de66-4b03-939f-df828e7d5276" }, { "id": "e0b48f96-47b1-4a26-bba3-c0ac62257e97", "name": "general error", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"archived_at\": \"\",\n \"version\": \"\",\n \"privacy_experience_id\": \"\",\n \"environment\": \"\",\n \"external_source\": \"\",\n \"external_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/widgets/notices/templates/:id", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", "templates", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-e0b48f96-47b1-4a26-bba3-c0ac62257e97" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-a6ca2590-7f7b-4cea-ade6-82209a0e2d8a" }, { "name": "Patch a notice template, and associate notice template with notices", "id": "e245dc89-a314-4e18-b090-699acc6df564", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"archived_at\": \"\",\n \"version\": \"\",\n \"privacy_experience_id\": \"\",\n \"environment\": \"\",\n \"external_source\": \"\",\n \"external_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/widgets/notices/templates/:id", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", "templates", ":id" ], "variable": [ { "id": "9d49358d-a6e0-42e3-a7b5-5dcf8553a6e2", "key": "id", "value": "", "description": "(Required) The ID of the notice template to patch" } ] }, "description": "Partially update an existing notice template." }, "response": [ { "id": "1a3571f0-a432-4179-8fc7-147354b7f3d9", "name": "The patched NoticeTemplate object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"archived_at\": \"\",\n \"version\": \"\",\n \"privacy_experience_id\": \"\",\n \"environment\": \"\",\n \"external_source\": \"\",\n \"external_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/widgets/notices/templates/:id", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", "templates", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created_at\": \"\",\n \"organization_id\": \"\",\n \"version\": \"\",\n \"notices_id\": [\n \"\",\n \"\"\n ],\n \"updated_at\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-1a3571f0-a432-4179-8fc7-147354b7f3d9" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-e245dc89-a314-4e18-b090-699acc6df564" }, { "name": "Removes the notice template, and associated notice template config", "id": "b6eaef5e-d080-4d0f-a3d7-12fab472069f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/widgets/notices/templates/:id", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", "templates", ":id" ], "variable": [ { "id": "267f3316-6a13-4db6-ba62-371db0e8bec7", "key": "id", "value": "", "description": "(Required) The ID of the notice template to patch" } ] }, "description": "Removes the notice template." }, "response": [ { "id": "18349ce6-9ca3-4b69-9a08-5f9c00f1b044", "name": "The removed NoticeTemplate object", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/widgets/notices/templates/:id", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", "templates", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created_at\": \"\",\n \"organization_id\": \"\",\n \"version\": \"\",\n \"notices_id\": [\n \"\",\n \"\"\n ],\n \"updated_at\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-18349ce6-9ca3-4b69-9a08-5f9c00f1b044" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-b6eaef5e-d080-4d0f-a3d7-12fab472069f" } ], "id": "e6428180-d011-4246-8028-1d754b9ff041", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-e6428180-d011-4246-8028-1d754b9ff041" }, { "name": "Retrieve a list of notices templates", "id": "81d08149-c432-4ccd-be8a-11dc4912d2de", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/widgets/notices/templates?$limit=&$skip=", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", "templates" ], "query": [ { "key": "$limit", "value": "" }, { "key": "$skip", "value": "" } ] }, "description": "Returns a list of notices templates" }, "response": [ { "id": "314edbdc-4f78-4f35-a299-7a5c7ed2e976", "name": "A NoticeTemplate object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/widgets/notices/templates?$limit=&$skip=", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", "templates" ], "query": [ { "key": "$limit", "value": "" }, { "key": "$skip", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"total\": \"\",\n \"limit\": \"\",\n \"skip\": \"\",\n \"data\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"created_at\": \"\",\n \"organization_id\": \"\",\n \"version\": \"\",\n \"notices_id\": [\n \"\",\n \"\"\n ],\n \"updated_at\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"created_at\": \"\",\n \"organization_id\": \"\",\n \"version\": \"\",\n \"notices_id\": [\n \"\",\n \"\"\n ],\n \"updated_at\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-314edbdc-4f78-4f35-a299-7a5c7ed2e976" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-81d08149-c432-4ccd-be8a-11dc4912d2de" }, { "name": "Create a notice template", "id": "dfd93767-a9a8-4fa0-9b61-e8e4d1516102", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"archived_at\": \"\",\n \"version\": \"\",\n \"privacy_experience_id\": \"\",\n \"environment\": \"\",\n \"external_source\": \"\",\n \"external_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/widgets/notices/templates", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", "templates" ] }, "description": "Create a new notice template for an organization." }, "response": [ { "id": "72e0f047-09bb-430c-8266-702bab2eeaa2", "name": "The created NoticeTemplate object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"archived_at\": \"\",\n \"version\": \"\",\n \"privacy_experience_id\": \"\",\n \"environment\": \"\",\n \"external_source\": \"\",\n \"external_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/widgets/notices/templates", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", "templates" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created_at\": \"\",\n \"organization_id\": \"\",\n \"version\": \"\",\n \"notices_id\": [\n \"\",\n \"\"\n ],\n \"updated_at\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-72e0f047-09bb-430c-8266-702bab2eeaa2" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-dfd93767-a9a8-4fa0-9b61-e8e4d1516102" } ], "id": "bc35419a-bd14-4be4-be91-079055b80d3b", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-bc35419a-bd14-4be4-be91-079055b80d3b" }, { "name": "deployments", "item": [ { "name": "{id}", "item": [ { "name": "Retrieve a deployment", "id": "6342fce2-e4d7-46d8-a707-20416d9a4823", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/widgets/notices/deployments/:id", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", "deployments", ":id" ], "variable": [ { "id": "721140e0-d3fe-4fe4-bc31-06e45a516043", "key": "id", "value": "", "description": "(Required) The ID of the deployment to retrieve" } ] }, "description": "Returns a single deployment" }, "response": [ { "id": "8763ba20-61b5-480d-a83f-42e9350f9dc3", "name": "A NoticeDeployment object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/widgets/notices/deployments/:id", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", "deployments", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"notice_id\": \"\",\n \"organization_id\": \"\",\n \"production_config_id\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-8763ba20-61b5-480d-a83f-42e9350f9dc3" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-6342fce2-e4d7-46d8-a707-20416d9a4823" } ], "id": "5067028a-4cc7-40da-b115-0b2779f547f4", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-5067028a-4cc7-40da-b115-0b2779f547f4" }, { "name": "Retrieve a list of deployments", "id": "f2f0e9f5-679c-4e5e-aa71-3791aed5738f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/widgets/notices/deployments", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", "deployments" ] }, "description": "Returns a list of deployments" }, "response": [ { "id": "74d27261-aac8-4f7a-9b9d-15e158aeeaba", "name": "A list of NoticeDeployment objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/widgets/notices/deployments", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", "deployments" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"notice_id\": \"\",\n \"organization_id\": \"\",\n \"production_config_id\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n },\n {\n \"id\": \"\",\n \"notice_id\": \"\",\n \"organization_id\": \"\",\n \"production_config_id\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n }\n]", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-74d27261-aac8-4f7a-9b9d-15e158aeeaba" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-f2f0e9f5-679c-4e5e-aa71-3791aed5738f" }, { "name": "Create a deployment", "id": "3ac09dd7-b74f-435b-bec6-d4b102609b05", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"archived_at\": \"\",\n \"version\": \"\",\n \"privacy_experience_id\": \"\",\n \"environment\": \"\",\n \"external_source\": \"\",\n \"external_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/widgets/notices/deployments", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", "deployments" ] }, "description": "Create a new deployment for an organization" }, "response": [ { "id": "d0611721-8194-4693-bee7-bc5755b421c2", "name": "The created NoticeDeployment object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"archived_at\": \"\",\n \"version\": \"\",\n \"privacy_experience_id\": \"\",\n \"environment\": \"\",\n \"external_source\": \"\",\n \"external_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/widgets/notices/deployments", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", "deployments" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"notice_id\": \"\",\n \"organization_id\": \"\",\n \"production_config_id\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-d0611721-8194-4693-bee7-bc5755b421c2" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-3ac09dd7-b74f-435b-bec6-d4b102609b05" } ], "id": "f8a4ec0c-35ef-4afa-b8c5-08ff58005a0e", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-f8a4ec0c-35ef-4afa-b8c5-08ff58005a0e" }, { "name": "configs", "item": [ { "name": "{id}", "item": [ { "name": "Retrieve a notice configuration", "id": "0bb37238-a39d-48f0-9a5d-5dad31906840", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "description": "Header to indicate Notice-Config API version. 1: Legacy. 2: Multi-Regulation", "key": "v", "value": "1" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/widgets/notices/configs/:id?download=", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", "configs", ":id" ], "query": [ { "description": "Flag to indicate the response should be returned as an attachment (interpreted as true if present regardless of value)", "key": "download", "value": "" } ], "variable": [ { "id": "1b3f127f-0735-451c-bc0b-096aea297e3f", "key": "id", "value": "", "description": "(Required) The ID of the notice configuration to retrieve" } ] }, "description": "Returns a single notice configuration" }, "response": [ { "id": "cb124fc7-31c1-418e-9792-9d6888406c87", "name": "A NoticeConfig object", "originalRequest": { "method": "GET", "header": [ { "description": "Header to indicate Notice-Config API version. 1: Legacy. 2: Multi-Regulation", "key": "v", "value": "1" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/widgets/notices/configs/:id?download=", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", "configs", ":id" ], "query": [ { "description": "Flag to indicate the response should be returned as an attachment (interpreted as true if present regardless of value)", "key": "download", "value": "" } ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"notice_id\": \"\",\n \"organization_id\": \"\",\n \"platform\": \"\",\n \"default\": \"\",\n \"targets\": [\n \"\",\n \"\"\n ],\n \"custom_json\": {},\n \"config\": {},\n \"full_atp\": \"\",\n \"text_mode\": \"\",\n \"text_id\": \"\",\n \"template_id\": \"\",\n \"enable_ignore_consent_before\": \"\",\n \"ignore_consent_before\": \"\",\n \"negative_action\": \"button\",\n \"negative_action_link\": \"\",\n \"negative_action_link_format\": \"cross\",\n \"negative_action_button\": \"\",\n \"disagree_button_style\": \"primary\",\n \"country\": \"\",\n \"notice_deny_applies_to_li\": \"\",\n \"preferences_deny_applies_to_li\": \"\",\n \"consent_duration\": \"\",\n \"consent_duration_unit\": \"days\",\n \"denied_consent_duration\": \"\",\n \"denied_consent_duration_unit\": \"months\",\n \"denied_consent_duration_custom\": \"\",\n \"cross_device_enabled\": \"\",\n \"cross_device_timeout\": \"\",\n \"gcm_enabled\": \"\",\n \"gcm_tcf_enabled\": \"\",\n \"gcm_set_default_status\": \"\",\n \"gcm_data_layer_name\": \"\",\n \"gcm_analytics_default_status\": \"\",\n \"gcm_ads_default_status\": \"\",\n \"gcm_functionality_default_status\": \"\",\n \"gcm_personalization_default_status\": \"\",\n \"gcm_security_default_status\": \"\",\n \"gcm_ad_user_data_default_status\": \"\",\n \"gcm_ad_personalization_default_status\": \"\",\n \"microsoft_enabled\": \"\",\n \"microsoft_set_default_status\": \"\",\n \"microsoft_ad_storage_default_status\": \"\",\n \"microsoft_enable_tcf_advertiser_consent_mode\": \"\",\n \"amazon_enabled\": \"\",\n \"amazon_set_default_status\": \"\",\n \"amazon_ad_storage_default_status\": \"\",\n \"amazon_ad_user_data_default_status\": \"\",\n \"wordpress_enabled\": \"\",\n \"gcm_firebase_enabled\": \"\",\n \"gcm_airbridge_enabled\": \"\",\n \"gcm_kochava_enabled\": \"\",\n \"gcm_branch_enabled\": \"\",\n \"gcm_appsflyer_enabled\": \"\",\n \"ctv_focus_on_agree_and_close\": \"\",\n \"secure_cookies\": \"\",\n \"gpp_enabled\": \"\",\n \"gpp_mspa_signatory\": \"\",\n \"gpp_mspa_mode\": \"opt_out\",\n \"gpp_mspa_generate_usnat_string\": \"\",\n \"deployed_at\": \"\",\n \"deployed_by\": \"\",\n \"deployed_by_type\": \"\",\n \"deployed_by_name\": \"\",\n \"deployed_metadata\": {\n \"all_iab_enabled\": \"\",\n \"iab_vendor_count\": \"\",\n \"custom_vendor_count\": \"\",\n \"iab_purpose_count\": {},\n \"custom_purpose_count\": {}\n },\n \"regulation_configurations\": [\n {\n \"id\": \"\",\n \"notice_config_id\": \"\",\n \"organization_id\": \"\",\n \"regulation_id\": \"\",\n \"is_default_regulation_config\": \"\",\n \"geo_locations\": [\n \"\",\n \"\"\n ],\n \"regulation_settings\": {},\n \"config\": {},\n \"template_id\": \"\",\n \"enable_ignore_consent_before\": \"\",\n \"negative_action_link_format\": \"text\",\n \"disagree_button_style\": \"primary\",\n \"country\": \"\",\n \"notice_deny_applies_to_li\": \"\",\n \"preferences_deny_applies_to_li\": \"\",\n \"consent_duration\": \"\",\n \"consent_duration_unit\": \"seconds\",\n \"denied_consent_duration\": \"\",\n \"denied_consent_duration_unit\": \"seconds\",\n \"denied_consent_duration_custom\": \"\",\n \"cross_device_enabled\": \"\",\n \"cross_device_timeout\": \"\",\n \"gcm_enabled\": \"\",\n \"gcm_tcf_enabled\": \"\",\n \"gcm_set_default_status\": \"\",\n \"gcm_analytics_default_status\": \"\",\n \"gcm_ads_default_status\": \"\",\n \"gcm_functionality_default_status\": \"\",\n \"gcm_personalization_default_status\": \"\",\n \"gcm_security_default_status\": \"\",\n \"gcm_ad_user_data_default_status\": \"\",\n \"gcm_ad_personalization_default_status\": \"\",\n \"microsoft_enabled\": \"\",\n \"microsoft_set_default_status\": \"\",\n \"microsoft_ad_storage_default_status\": \"\",\n \"microsoft_enable_tcf_advertiser_consent_mode\": \"\",\n \"amazon_enabled\": \"\",\n \"amazon_set_default_status\": \"\",\n \"amazon_ad_storage_default_status\": \"\",\n \"amazon_ad_user_data_default_status\": \"\",\n \"wordpress_enabled\": \"\",\n \"gcm_firebase_enabled\": \"\",\n \"gcm_airbridge_enabled\": \"\",\n \"gcm_kochava_enabled\": \"\",\n \"gcm_branch_enabled\": \"\",\n \"gcm_appsflyer_enabled\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"disabled_at\": \"\",\n \"version\": \"\",\n \"gpp_mspa_generate_usnat_string\": \"\",\n \"notice_disabled\": \"\",\n \"notice_active_elements_order\": {},\n \"dismiss_button_enabled\": \"\",\n \"preferences_title_enabled\": \"\",\n \"preferences_cross_button_enabled\": \"\",\n \"preferences_view_all_partners_button_enabled\": \"\",\n \"preferences_active_elements_order\": {}\n },\n {\n \"id\": \"\",\n \"notice_config_id\": \"\",\n \"organization_id\": \"\",\n \"regulation_id\": \"\",\n \"is_default_regulation_config\": \"\",\n \"geo_locations\": [\n \"\",\n \"\"\n ],\n \"regulation_settings\": {},\n \"config\": {},\n \"template_id\": \"\",\n \"enable_ignore_consent_before\": \"\",\n \"negative_action_link_format\": \"text\",\n \"disagree_button_style\": \"secondary\",\n \"country\": \"\",\n \"notice_deny_applies_to_li\": \"\",\n \"preferences_deny_applies_to_li\": \"\",\n \"consent_duration\": \"\",\n \"consent_duration_unit\": \"months\",\n \"denied_consent_duration\": \"\",\n \"denied_consent_duration_unit\": \"months\",\n \"denied_consent_duration_custom\": \"\",\n \"cross_device_enabled\": \"\",\n \"cross_device_timeout\": \"\",\n \"gcm_enabled\": \"\",\n \"gcm_tcf_enabled\": \"\",\n \"gcm_set_default_status\": \"\",\n \"gcm_analytics_default_status\": \"\",\n \"gcm_ads_default_status\": \"\",\n \"gcm_functionality_default_status\": \"\",\n \"gcm_personalization_default_status\": \"\",\n \"gcm_security_default_status\": \"\",\n \"gcm_ad_user_data_default_status\": \"\",\n \"gcm_ad_personalization_default_status\": \"\",\n \"microsoft_enabled\": \"\",\n \"microsoft_set_default_status\": \"\",\n \"microsoft_ad_storage_default_status\": \"\",\n \"microsoft_enable_tcf_advertiser_consent_mode\": \"\",\n \"amazon_enabled\": \"\",\n \"amazon_set_default_status\": \"\",\n \"amazon_ad_storage_default_status\": \"\",\n \"amazon_ad_user_data_default_status\": \"\",\n \"wordpress_enabled\": \"\",\n \"gcm_firebase_enabled\": \"\",\n \"gcm_airbridge_enabled\": \"\",\n \"gcm_kochava_enabled\": \"\",\n \"gcm_branch_enabled\": \"\",\n \"gcm_appsflyer_enabled\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"disabled_at\": \"\",\n \"version\": \"\",\n \"gpp_mspa_generate_usnat_string\": \"\",\n \"notice_disabled\": \"\",\n \"notice_active_elements_order\": {},\n \"dismiss_button_enabled\": \"\",\n \"preferences_title_enabled\": \"\",\n \"preferences_cross_button_enabled\": \"\",\n \"preferences_view_all_partners_button_enabled\": \"\",\n \"preferences_active_elements_order\": {}\n }\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\",\n \"notice_disabled\": \"\",\n \"consent_string_partners_encoding\": \"\",\n \"consent_string_purposes_encoding\": \"\",\n \"enable_web_view\": \"\",\n \"notice_active_elements_order\": {},\n \"dismiss_button_enabled\": \"\",\n \"preferences_title_enabled\": \"\",\n \"preferences_cross_button_enabled\": \"\",\n \"preferences_view_all_partners_button_enabled\": \"\",\n \"preferences_active_elements_order\": {}\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-cb124fc7-31c1-418e-9792-9d6888406c87" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-0bb37238-a39d-48f0-9a5d-5dad31906840" }, { "name": "Patch a notice configuration", "id": "5c053efd-b22f-4792-a51b-a054a90a4334", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "PATCH", "header": [ { "description": "Header to indicate Notice-Config API version. 1: Legacy. 2: Multi-Regulation", "key": "v", "value": "1" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"archived_at\": \"\",\n \"version\": \"\",\n \"privacy_experience_id\": \"\",\n \"environment\": \"\",\n \"external_source\": \"\",\n \"external_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/widgets/notices/configs/:id", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", "configs", ":id" ], "variable": [ { "id": "6299625c-00a0-45b3-94dc-1a8c71b4063d", "key": "id", "value": "", "description": "(Required) The ID of the notice configuration to patch" } ] }, "description": "Partially update a notice configuration" }, "response": [ { "id": "d53e7739-50b7-4a50-b079-ca8a19b2f8de", "name": "The patched NoticeConfig object", "originalRequest": { "method": "PATCH", "header": [ { "description": "Header to indicate Notice-Config API version. 1: Legacy. 2: Multi-Regulation", "key": "v", "value": "1" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"archived_at\": \"\",\n \"version\": \"\",\n \"privacy_experience_id\": \"\",\n \"environment\": \"\",\n \"external_source\": \"\",\n \"external_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/widgets/notices/configs/:id", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", "configs", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"notice_id\": \"\",\n \"organization_id\": \"\",\n \"platform\": \"\",\n \"default\": \"\",\n \"targets\": [\n \"\",\n \"\"\n ],\n \"custom_json\": {},\n \"config\": {},\n \"full_atp\": \"\",\n \"text_mode\": \"\",\n \"text_id\": \"\",\n \"template_id\": \"\",\n \"enable_ignore_consent_before\": \"\",\n \"ignore_consent_before\": \"\",\n \"negative_action\": \"button\",\n \"negative_action_link\": \"\",\n \"negative_action_link_format\": \"cross\",\n \"negative_action_button\": \"\",\n \"disagree_button_style\": \"primary\",\n \"country\": \"\",\n \"notice_deny_applies_to_li\": \"\",\n \"preferences_deny_applies_to_li\": \"\",\n \"consent_duration\": \"\",\n \"consent_duration_unit\": \"days\",\n \"denied_consent_duration\": \"\",\n \"denied_consent_duration_unit\": \"months\",\n \"denied_consent_duration_custom\": \"\",\n \"cross_device_enabled\": \"\",\n \"cross_device_timeout\": \"\",\n \"gcm_enabled\": \"\",\n \"gcm_tcf_enabled\": \"\",\n \"gcm_set_default_status\": \"\",\n \"gcm_data_layer_name\": \"\",\n \"gcm_analytics_default_status\": \"\",\n \"gcm_ads_default_status\": \"\",\n \"gcm_functionality_default_status\": \"\",\n \"gcm_personalization_default_status\": \"\",\n \"gcm_security_default_status\": \"\",\n \"gcm_ad_user_data_default_status\": \"\",\n \"gcm_ad_personalization_default_status\": \"\",\n \"microsoft_enabled\": \"\",\n \"microsoft_set_default_status\": \"\",\n \"microsoft_ad_storage_default_status\": \"\",\n \"microsoft_enable_tcf_advertiser_consent_mode\": \"\",\n \"amazon_enabled\": \"\",\n \"amazon_set_default_status\": \"\",\n \"amazon_ad_storage_default_status\": \"\",\n \"amazon_ad_user_data_default_status\": \"\",\n \"wordpress_enabled\": \"\",\n \"gcm_firebase_enabled\": \"\",\n \"gcm_airbridge_enabled\": \"\",\n \"gcm_kochava_enabled\": \"\",\n \"gcm_branch_enabled\": \"\",\n \"gcm_appsflyer_enabled\": \"\",\n \"ctv_focus_on_agree_and_close\": \"\",\n \"secure_cookies\": \"\",\n \"gpp_enabled\": \"\",\n \"gpp_mspa_signatory\": \"\",\n \"gpp_mspa_mode\": \"opt_out\",\n \"gpp_mspa_generate_usnat_string\": \"\",\n \"deployed_at\": \"\",\n \"deployed_by\": \"\",\n \"deployed_by_type\": \"\",\n \"deployed_by_name\": \"\",\n \"deployed_metadata\": {\n \"all_iab_enabled\": \"\",\n \"iab_vendor_count\": \"\",\n \"custom_vendor_count\": \"\",\n \"iab_purpose_count\": {},\n \"custom_purpose_count\": {}\n },\n \"regulation_configurations\": [\n {\n \"id\": \"\",\n \"notice_config_id\": \"\",\n \"organization_id\": \"\",\n \"regulation_id\": \"\",\n \"is_default_regulation_config\": \"\",\n \"geo_locations\": [\n \"\",\n \"\"\n ],\n \"regulation_settings\": {},\n \"config\": {},\n \"template_id\": \"\",\n \"enable_ignore_consent_before\": \"\",\n \"negative_action_link_format\": \"text\",\n \"disagree_button_style\": \"primary\",\n \"country\": \"\",\n \"notice_deny_applies_to_li\": \"\",\n \"preferences_deny_applies_to_li\": \"\",\n \"consent_duration\": \"\",\n \"consent_duration_unit\": \"seconds\",\n \"denied_consent_duration\": \"\",\n \"denied_consent_duration_unit\": \"seconds\",\n \"denied_consent_duration_custom\": \"\",\n \"cross_device_enabled\": \"\",\n \"cross_device_timeout\": \"\",\n \"gcm_enabled\": \"\",\n \"gcm_tcf_enabled\": \"\",\n \"gcm_set_default_status\": \"\",\n \"gcm_analytics_default_status\": \"\",\n \"gcm_ads_default_status\": \"\",\n \"gcm_functionality_default_status\": \"\",\n \"gcm_personalization_default_status\": \"\",\n \"gcm_security_default_status\": \"\",\n \"gcm_ad_user_data_default_status\": \"\",\n \"gcm_ad_personalization_default_status\": \"\",\n \"microsoft_enabled\": \"\",\n \"microsoft_set_default_status\": \"\",\n \"microsoft_ad_storage_default_status\": \"\",\n \"microsoft_enable_tcf_advertiser_consent_mode\": \"\",\n \"amazon_enabled\": \"\",\n \"amazon_set_default_status\": \"\",\n \"amazon_ad_storage_default_status\": \"\",\n \"amazon_ad_user_data_default_status\": \"\",\n \"wordpress_enabled\": \"\",\n \"gcm_firebase_enabled\": \"\",\n \"gcm_airbridge_enabled\": \"\",\n \"gcm_kochava_enabled\": \"\",\n \"gcm_branch_enabled\": \"\",\n \"gcm_appsflyer_enabled\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"disabled_at\": \"\",\n \"version\": \"\",\n \"gpp_mspa_generate_usnat_string\": \"\",\n \"notice_disabled\": \"\",\n \"notice_active_elements_order\": {},\n \"dismiss_button_enabled\": \"\",\n \"preferences_title_enabled\": \"\",\n \"preferences_cross_button_enabled\": \"\",\n \"preferences_view_all_partners_button_enabled\": \"\",\n \"preferences_active_elements_order\": {}\n },\n {\n \"id\": \"\",\n \"notice_config_id\": \"\",\n \"organization_id\": \"\",\n \"regulation_id\": \"\",\n \"is_default_regulation_config\": \"\",\n \"geo_locations\": [\n \"\",\n \"\"\n ],\n \"regulation_settings\": {},\n \"config\": {},\n \"template_id\": \"\",\n \"enable_ignore_consent_before\": \"\",\n \"negative_action_link_format\": \"text\",\n \"disagree_button_style\": \"secondary\",\n \"country\": \"\",\n \"notice_deny_applies_to_li\": \"\",\n \"preferences_deny_applies_to_li\": \"\",\n \"consent_duration\": \"\",\n \"consent_duration_unit\": \"months\",\n \"denied_consent_duration\": \"\",\n \"denied_consent_duration_unit\": \"months\",\n \"denied_consent_duration_custom\": \"\",\n \"cross_device_enabled\": \"\",\n \"cross_device_timeout\": \"\",\n \"gcm_enabled\": \"\",\n \"gcm_tcf_enabled\": \"\",\n \"gcm_set_default_status\": \"\",\n \"gcm_analytics_default_status\": \"\",\n \"gcm_ads_default_status\": \"\",\n \"gcm_functionality_default_status\": \"\",\n \"gcm_personalization_default_status\": \"\",\n \"gcm_security_default_status\": \"\",\n \"gcm_ad_user_data_default_status\": \"\",\n \"gcm_ad_personalization_default_status\": \"\",\n \"microsoft_enabled\": \"\",\n \"microsoft_set_default_status\": \"\",\n \"microsoft_ad_storage_default_status\": \"\",\n \"microsoft_enable_tcf_advertiser_consent_mode\": \"\",\n \"amazon_enabled\": \"\",\n \"amazon_set_default_status\": \"\",\n \"amazon_ad_storage_default_status\": \"\",\n \"amazon_ad_user_data_default_status\": \"\",\n \"wordpress_enabled\": \"\",\n \"gcm_firebase_enabled\": \"\",\n \"gcm_airbridge_enabled\": \"\",\n \"gcm_kochava_enabled\": \"\",\n \"gcm_branch_enabled\": \"\",\n \"gcm_appsflyer_enabled\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"disabled_at\": \"\",\n \"version\": \"\",\n \"gpp_mspa_generate_usnat_string\": \"\",\n \"notice_disabled\": \"\",\n \"notice_active_elements_order\": {},\n \"dismiss_button_enabled\": \"\",\n \"preferences_title_enabled\": \"\",\n \"preferences_cross_button_enabled\": \"\",\n \"preferences_view_all_partners_button_enabled\": \"\",\n \"preferences_active_elements_order\": {}\n }\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\",\n \"notice_disabled\": \"\",\n \"consent_string_partners_encoding\": \"\",\n \"consent_string_purposes_encoding\": \"\",\n \"enable_web_view\": \"\",\n \"notice_active_elements_order\": {},\n \"dismiss_button_enabled\": \"\",\n \"preferences_title_enabled\": \"\",\n \"preferences_cross_button_enabled\": \"\",\n \"preferences_view_all_partners_button_enabled\": \"\",\n \"preferences_active_elements_order\": {}\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-d53e7739-50b7-4a50-b079-ca8a19b2f8de" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-5c053efd-b22f-4792-a51b-a054a90a4334" } ], "id": "714575a6-6959-4669-8032-d4029533707e", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-714575a6-6959-4669-8032-d4029533707e" }, { "name": "Retrieve a list of configurations", "id": "b8eff26a-653d-4064-bfeb-cc7a03be220b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "description": "Header to indicate Notice-Config API version. 1: Legacy. 2: Multi-Regulation", "key": "v", "value": "1" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/widgets/notices/configs?download=", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", "configs" ], "query": [ { "description": "Flag to indicate the response should be returned as an attachment (interpreted as true if present regardless of value). Responds with a CSV extract of the items or Not Found if no items match the query.", "key": "download", "value": "" } ] }, "description": "Returns a list of configurations" }, "response": [ { "id": "7009d090-f2c7-4643-a643-c829cdc4a220", "name": "A list of NoticeConfig objects", "originalRequest": { "method": "GET", "header": [ { "description": "Header to indicate Notice-Config API version. 1: Legacy. 2: Multi-Regulation", "key": "v", "value": "1" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/widgets/notices/configs?download=", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", "configs" ], "query": [ { "description": "Flag to indicate the response should be returned as an attachment (interpreted as true if present regardless of value). Responds with a CSV extract of the items or Not Found if no items match the query.", "key": "download", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"notice_id\": \"\",\n \"organization_id\": \"\",\n \"platform\": \"\",\n \"default\": \"\",\n \"targets\": [\n \"\",\n \"\"\n ],\n \"custom_json\": {},\n \"config\": {},\n \"full_atp\": \"\",\n \"text_mode\": \"\",\n \"text_id\": \"\",\n \"template_id\": \"\",\n \"enable_ignore_consent_before\": \"\",\n \"ignore_consent_before\": \"\",\n \"negative_action\": \"link\",\n \"negative_action_link\": \"\",\n \"negative_action_link_format\": \"cross\",\n \"negative_action_button\": \"\",\n \"disagree_button_style\": \"primary\",\n \"country\": \"\",\n \"notice_deny_applies_to_li\": \"\",\n \"preferences_deny_applies_to_li\": \"\",\n \"consent_duration\": \"\",\n \"consent_duration_unit\": \"seconds\",\n \"denied_consent_duration\": \"\",\n \"denied_consent_duration_unit\": \"months\",\n \"denied_consent_duration_custom\": \"\",\n \"cross_device_enabled\": \"\",\n \"cross_device_timeout\": \"\",\n \"gcm_enabled\": \"\",\n \"gcm_tcf_enabled\": \"\",\n \"gcm_set_default_status\": \"\",\n \"gcm_data_layer_name\": \"\",\n \"gcm_analytics_default_status\": \"\",\n \"gcm_ads_default_status\": \"\",\n \"gcm_functionality_default_status\": \"\",\n \"gcm_personalization_default_status\": \"\",\n \"gcm_security_default_status\": \"\",\n \"gcm_ad_user_data_default_status\": \"\",\n \"gcm_ad_personalization_default_status\": \"\",\n \"microsoft_enabled\": \"\",\n \"microsoft_set_default_status\": \"\",\n \"microsoft_ad_storage_default_status\": \"\",\n \"microsoft_enable_tcf_advertiser_consent_mode\": \"\",\n \"amazon_enabled\": \"\",\n \"amazon_set_default_status\": \"\",\n \"amazon_ad_storage_default_status\": \"\",\n \"amazon_ad_user_data_default_status\": \"\",\n \"wordpress_enabled\": \"\",\n \"gcm_firebase_enabled\": \"\",\n \"gcm_airbridge_enabled\": \"\",\n \"gcm_kochava_enabled\": \"\",\n \"gcm_branch_enabled\": \"\",\n \"gcm_appsflyer_enabled\": \"\",\n \"ctv_focus_on_agree_and_close\": \"\",\n \"secure_cookies\": \"\",\n \"gpp_enabled\": \"\",\n \"gpp_mspa_signatory\": \"\",\n \"gpp_mspa_mode\": \"opt_out\",\n \"gpp_mspa_generate_usnat_string\": \"\",\n \"deployed_at\": \"\",\n \"deployed_by\": \"\",\n \"deployed_by_type\": \"\",\n \"deployed_by_name\": \"\",\n \"deployed_metadata\": {\n \"all_iab_enabled\": \"\",\n \"iab_vendor_count\": \"\",\n \"custom_vendor_count\": \"\",\n \"iab_purpose_count\": {},\n \"custom_purpose_count\": {}\n },\n \"regulation_configurations\": [\n {\n \"id\": \"\",\n \"notice_config_id\": \"\",\n \"organization_id\": \"\",\n \"regulation_id\": \"\",\n \"is_default_regulation_config\": \"\",\n \"geo_locations\": [\n \"\",\n \"\"\n ],\n \"regulation_settings\": {},\n \"config\": {},\n \"template_id\": \"\",\n \"enable_ignore_consent_before\": \"\",\n \"negative_action_link_format\": \"text\",\n \"disagree_button_style\": \"primary\",\n \"country\": \"\",\n \"notice_deny_applies_to_li\": \"\",\n \"preferences_deny_applies_to_li\": \"\",\n \"consent_duration\": \"\",\n \"consent_duration_unit\": \"months\",\n \"denied_consent_duration\": \"\",\n \"denied_consent_duration_unit\": \"seconds\",\n \"denied_consent_duration_custom\": \"\",\n \"cross_device_enabled\": \"\",\n \"cross_device_timeout\": \"\",\n \"gcm_enabled\": \"\",\n \"gcm_tcf_enabled\": \"\",\n \"gcm_set_default_status\": \"\",\n \"gcm_analytics_default_status\": \"\",\n \"gcm_ads_default_status\": \"\",\n \"gcm_functionality_default_status\": \"\",\n \"gcm_personalization_default_status\": \"\",\n \"gcm_security_default_status\": \"\",\n \"gcm_ad_user_data_default_status\": \"\",\n \"gcm_ad_personalization_default_status\": \"\",\n \"microsoft_enabled\": \"\",\n \"microsoft_set_default_status\": \"\",\n \"microsoft_ad_storage_default_status\": \"\",\n \"microsoft_enable_tcf_advertiser_consent_mode\": \"\",\n \"amazon_enabled\": \"\",\n \"amazon_set_default_status\": \"\",\n \"amazon_ad_storage_default_status\": \"\",\n \"amazon_ad_user_data_default_status\": \"\",\n \"wordpress_enabled\": \"\",\n \"gcm_firebase_enabled\": \"\",\n \"gcm_airbridge_enabled\": \"\",\n \"gcm_kochava_enabled\": \"\",\n \"gcm_branch_enabled\": \"\",\n \"gcm_appsflyer_enabled\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"disabled_at\": \"\",\n \"version\": \"\",\n \"gpp_mspa_generate_usnat_string\": \"\",\n \"notice_disabled\": \"\",\n \"notice_active_elements_order\": {},\n \"dismiss_button_enabled\": \"\",\n \"preferences_title_enabled\": \"\",\n \"preferences_cross_button_enabled\": \"\",\n \"preferences_view_all_partners_button_enabled\": \"\",\n \"preferences_active_elements_order\": {}\n },\n {\n \"id\": \"\",\n \"notice_config_id\": \"\",\n \"organization_id\": \"\",\n \"regulation_id\": \"\",\n \"is_default_regulation_config\": \"\",\n \"geo_locations\": [\n \"\",\n \"\"\n ],\n \"regulation_settings\": {},\n \"config\": {},\n \"template_id\": \"\",\n \"enable_ignore_consent_before\": \"\",\n \"negative_action_link_format\": \"cross\",\n \"disagree_button_style\": \"primary\",\n \"country\": \"\",\n \"notice_deny_applies_to_li\": \"\",\n \"preferences_deny_applies_to_li\": \"\",\n \"consent_duration\": \"\",\n \"consent_duration_unit\": \"days\",\n \"denied_consent_duration\": \"\",\n \"denied_consent_duration_unit\": \"seconds\",\n \"denied_consent_duration_custom\": \"\",\n \"cross_device_enabled\": \"\",\n \"cross_device_timeout\": \"\",\n \"gcm_enabled\": \"\",\n \"gcm_tcf_enabled\": \"\",\n \"gcm_set_default_status\": \"\",\n \"gcm_analytics_default_status\": \"\",\n \"gcm_ads_default_status\": \"\",\n \"gcm_functionality_default_status\": \"\",\n \"gcm_personalization_default_status\": \"\",\n \"gcm_security_default_status\": \"\",\n \"gcm_ad_user_data_default_status\": \"\",\n \"gcm_ad_personalization_default_status\": \"\",\n \"microsoft_enabled\": \"\",\n \"microsoft_set_default_status\": \"\",\n \"microsoft_ad_storage_default_status\": \"\",\n \"microsoft_enable_tcf_advertiser_consent_mode\": \"\",\n \"amazon_enabled\": \"\",\n \"amazon_set_default_status\": \"\",\n \"amazon_ad_storage_default_status\": \"\",\n \"amazon_ad_user_data_default_status\": \"\",\n \"wordpress_enabled\": \"\",\n \"gcm_firebase_enabled\": \"\",\n \"gcm_airbridge_enabled\": \"\",\n \"gcm_kochava_enabled\": \"\",\n \"gcm_branch_enabled\": \"\",\n \"gcm_appsflyer_enabled\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"disabled_at\": \"\",\n \"version\": \"\",\n \"gpp_mspa_generate_usnat_string\": \"\",\n \"notice_disabled\": \"\",\n \"notice_active_elements_order\": {},\n \"dismiss_button_enabled\": \"\",\n \"preferences_title_enabled\": \"\",\n \"preferences_cross_button_enabled\": \"\",\n \"preferences_view_all_partners_button_enabled\": \"\",\n \"preferences_active_elements_order\": {}\n }\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\",\n \"notice_disabled\": \"\",\n \"consent_string_partners_encoding\": \"\",\n \"consent_string_purposes_encoding\": \"\",\n \"enable_web_view\": \"\",\n \"notice_active_elements_order\": {},\n \"dismiss_button_enabled\": \"\",\n \"preferences_title_enabled\": \"\",\n \"preferences_cross_button_enabled\": \"\",\n \"preferences_view_all_partners_button_enabled\": \"\",\n \"preferences_active_elements_order\": {}\n },\n {\n \"id\": \"\",\n \"notice_id\": \"\",\n \"organization_id\": \"\",\n \"platform\": \"\",\n \"default\": \"\",\n \"targets\": [\n \"\",\n \"\"\n ],\n \"custom_json\": {},\n \"config\": {},\n \"full_atp\": \"\",\n \"text_mode\": \"\",\n \"text_id\": \"\",\n \"template_id\": \"\",\n \"enable_ignore_consent_before\": \"\",\n \"ignore_consent_before\": \"\",\n \"negative_action\": \"button\",\n \"negative_action_link\": \"\",\n \"negative_action_link_format\": \"text\",\n \"negative_action_button\": \"\",\n \"disagree_button_style\": \"secondary\",\n \"country\": \"\",\n \"notice_deny_applies_to_li\": \"\",\n \"preferences_deny_applies_to_li\": \"\",\n \"consent_duration\": \"\",\n \"consent_duration_unit\": \"seconds\",\n \"denied_consent_duration\": \"\",\n \"denied_consent_duration_unit\": \"days\",\n \"denied_consent_duration_custom\": \"\",\n \"cross_device_enabled\": \"\",\n \"cross_device_timeout\": \"\",\n \"gcm_enabled\": \"\",\n \"gcm_tcf_enabled\": \"\",\n \"gcm_set_default_status\": \"\",\n \"gcm_data_layer_name\": \"\",\n \"gcm_analytics_default_status\": \"\",\n \"gcm_ads_default_status\": \"\",\n \"gcm_functionality_default_status\": \"\",\n \"gcm_personalization_default_status\": \"\",\n \"gcm_security_default_status\": \"\",\n \"gcm_ad_user_data_default_status\": \"\",\n \"gcm_ad_personalization_default_status\": \"\",\n \"microsoft_enabled\": \"\",\n \"microsoft_set_default_status\": \"\",\n \"microsoft_ad_storage_default_status\": \"\",\n \"microsoft_enable_tcf_advertiser_consent_mode\": \"\",\n \"amazon_enabled\": \"\",\n \"amazon_set_default_status\": \"\",\n \"amazon_ad_storage_default_status\": \"\",\n \"amazon_ad_user_data_default_status\": \"\",\n \"wordpress_enabled\": \"\",\n \"gcm_firebase_enabled\": \"\",\n \"gcm_airbridge_enabled\": \"\",\n \"gcm_kochava_enabled\": \"\",\n \"gcm_branch_enabled\": \"\",\n \"gcm_appsflyer_enabled\": \"\",\n \"ctv_focus_on_agree_and_close\": \"\",\n \"secure_cookies\": \"\",\n \"gpp_enabled\": \"\",\n \"gpp_mspa_signatory\": \"\",\n \"gpp_mspa_mode\": \"opt_out\",\n \"gpp_mspa_generate_usnat_string\": \"\",\n \"deployed_at\": \"\",\n \"deployed_by\": \"\",\n \"deployed_by_type\": \"\",\n \"deployed_by_name\": \"\",\n \"deployed_metadata\": {\n \"all_iab_enabled\": \"\",\n \"iab_vendor_count\": \"\",\n \"custom_vendor_count\": \"\",\n \"iab_purpose_count\": {},\n \"custom_purpose_count\": {}\n },\n \"regulation_configurations\": [\n {\n \"id\": \"\",\n \"notice_config_id\": \"\",\n \"organization_id\": \"\",\n \"regulation_id\": \"\",\n \"is_default_regulation_config\": \"\",\n \"geo_locations\": [\n \"\",\n \"\"\n ],\n \"regulation_settings\": {},\n \"config\": {},\n \"template_id\": \"\",\n \"enable_ignore_consent_before\": \"\",\n \"negative_action_link_format\": \"text\",\n \"disagree_button_style\": \"secondary\",\n \"country\": \"\",\n \"notice_deny_applies_to_li\": \"\",\n \"preferences_deny_applies_to_li\": \"\",\n \"consent_duration\": \"\",\n \"consent_duration_unit\": \"seconds\",\n \"denied_consent_duration\": \"\",\n \"denied_consent_duration_unit\": \"months\",\n \"denied_consent_duration_custom\": \"\",\n \"cross_device_enabled\": \"\",\n \"cross_device_timeout\": \"\",\n \"gcm_enabled\": \"\",\n \"gcm_tcf_enabled\": \"\",\n \"gcm_set_default_status\": \"\",\n \"gcm_analytics_default_status\": \"\",\n \"gcm_ads_default_status\": \"\",\n \"gcm_functionality_default_status\": \"\",\n \"gcm_personalization_default_status\": \"\",\n \"gcm_security_default_status\": \"\",\n \"gcm_ad_user_data_default_status\": \"\",\n \"gcm_ad_personalization_default_status\": \"\",\n \"microsoft_enabled\": \"\",\n \"microsoft_set_default_status\": \"\",\n \"microsoft_ad_storage_default_status\": \"\",\n \"microsoft_enable_tcf_advertiser_consent_mode\": \"\",\n \"amazon_enabled\": \"\",\n \"amazon_set_default_status\": \"\",\n \"amazon_ad_storage_default_status\": \"\",\n \"amazon_ad_user_data_default_status\": \"\",\n \"wordpress_enabled\": \"\",\n \"gcm_firebase_enabled\": \"\",\n \"gcm_airbridge_enabled\": \"\",\n \"gcm_kochava_enabled\": \"\",\n \"gcm_branch_enabled\": \"\",\n \"gcm_appsflyer_enabled\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"disabled_at\": \"\",\n \"version\": \"\",\n \"gpp_mspa_generate_usnat_string\": \"\",\n \"notice_disabled\": \"\",\n \"notice_active_elements_order\": {},\n \"dismiss_button_enabled\": \"\",\n \"preferences_title_enabled\": \"\",\n \"preferences_cross_button_enabled\": \"\",\n \"preferences_view_all_partners_button_enabled\": \"\",\n \"preferences_active_elements_order\": {}\n },\n {\n \"id\": \"\",\n \"notice_config_id\": \"\",\n \"organization_id\": \"\",\n \"regulation_id\": \"\",\n \"is_default_regulation_config\": \"\",\n \"geo_locations\": [\n \"\",\n \"\"\n ],\n \"regulation_settings\": {},\n \"config\": {},\n \"template_id\": \"\",\n \"enable_ignore_consent_before\": \"\",\n \"negative_action_link_format\": \"text\",\n \"disagree_button_style\": \"primary\",\n \"country\": \"\",\n \"notice_deny_applies_to_li\": \"\",\n \"preferences_deny_applies_to_li\": \"\",\n \"consent_duration\": \"\",\n \"consent_duration_unit\": \"days\",\n \"denied_consent_duration\": \"\",\n \"denied_consent_duration_unit\": \"months\",\n \"denied_consent_duration_custom\": \"\",\n \"cross_device_enabled\": \"\",\n \"cross_device_timeout\": \"\",\n \"gcm_enabled\": \"\",\n \"gcm_tcf_enabled\": \"\",\n \"gcm_set_default_status\": \"\",\n \"gcm_analytics_default_status\": \"\",\n \"gcm_ads_default_status\": \"\",\n \"gcm_functionality_default_status\": \"\",\n \"gcm_personalization_default_status\": \"\",\n \"gcm_security_default_status\": \"\",\n \"gcm_ad_user_data_default_status\": \"\",\n \"gcm_ad_personalization_default_status\": \"\",\n \"microsoft_enabled\": \"\",\n \"microsoft_set_default_status\": \"\",\n \"microsoft_ad_storage_default_status\": \"\",\n \"microsoft_enable_tcf_advertiser_consent_mode\": \"\",\n \"amazon_enabled\": \"\",\n \"amazon_set_default_status\": \"\",\n \"amazon_ad_storage_default_status\": \"\",\n \"amazon_ad_user_data_default_status\": \"\",\n \"wordpress_enabled\": \"\",\n \"gcm_firebase_enabled\": \"\",\n \"gcm_airbridge_enabled\": \"\",\n \"gcm_kochava_enabled\": \"\",\n \"gcm_branch_enabled\": \"\",\n \"gcm_appsflyer_enabled\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"disabled_at\": \"\",\n \"version\": \"\",\n \"gpp_mspa_generate_usnat_string\": \"\",\n \"notice_disabled\": \"\",\n \"notice_active_elements_order\": {},\n \"dismiss_button_enabled\": \"\",\n \"preferences_title_enabled\": \"\",\n \"preferences_cross_button_enabled\": \"\",\n \"preferences_view_all_partners_button_enabled\": \"\",\n \"preferences_active_elements_order\": {}\n }\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\",\n \"notice_disabled\": \"\",\n \"consent_string_partners_encoding\": \"\",\n \"consent_string_purposes_encoding\": \"\",\n \"enable_web_view\": \"\",\n \"notice_active_elements_order\": {},\n \"dismiss_button_enabled\": \"\",\n \"preferences_title_enabled\": \"\",\n \"preferences_cross_button_enabled\": \"\",\n \"preferences_view_all_partners_button_enabled\": \"\",\n \"preferences_active_elements_order\": {}\n }\n]", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-7009d090-f2c7-4643-a643-c829cdc4a220" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-b8eff26a-653d-4064-bfeb-cc7a03be220b" } ], "id": "69558462-1066-4626-be1b-4c06cf4480c9", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-69558462-1066-4626-be1b-4c06cf4480c9" }, { "name": "sdk-configs", "item": [ { "name": "{id}", "item": [ { "name": "Retrieve a SDK configuration", "id": "1d08eac1-b08b-4b7d-9f02-e2547a8e672a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/widgets/notices/sdk-configs/:id", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", "sdk-configs", ":id" ], "variable": [ { "id": "4dd26d77-9438-4e57-8355-5a6d06402d1a", "key": "id", "value": "", "description": "(Required) The ID of the SDK configuration to retrieve" } ] }, "description": "Returns a single SDK configuration" }, "response": [ { "id": "80df7e1a-a475-4ecb-b8cd-1f1a0675ff97", "name": "A SDK config object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/widgets/notices/sdk-configs/:id", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", "sdk-configs", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"regulation_id\": \"\",\n \"geo_locations\": [\n \"\",\n \"\"\n ],\n \"sdk_config\": {},\n \"created_at\": \"\",\n \"deployment_id\": \"\",\n \"notice_id\": \"\",\n \"notice_config_id\": \"\",\n \"notice_regulation_config_id\": \"\",\n \"organization_id\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-80df7e1a-a475-4ecb-b8cd-1f1a0675ff97" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-1d08eac1-b08b-4b7d-9f02-e2547a8e672a" } ], "id": "bee74876-2927-4634-96ef-5aef40dd3492", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-bee74876-2927-4634-96ef-5aef40dd3492" }, { "name": "Retrieve a list of SDK configurations", "id": "5d1ace07-392a-4509-8637-fa508a96e899", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/widgets/notices/sdk-configs", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", "sdk-configs" ] }, "description": "Returns a list of SDK configurations" }, "response": [ { "id": "3bec920a-e5ab-472b-87bf-0aaba244b224", "name": "A list of SDK Configs objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/widgets/notices/sdk-configs", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", "sdk-configs" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"regulation_id\": \"\",\n \"geo_locations\": [\n \"\",\n \"\"\n ],\n \"sdk_config\": {},\n \"created_at\": \"\",\n \"deployment_id\": \"\",\n \"notice_id\": \"\",\n \"notice_config_id\": \"\",\n \"notice_regulation_config_id\": \"\",\n \"organization_id\": \"\"\n },\n {\n \"id\": \"\",\n \"regulation_id\": \"\",\n \"geo_locations\": [\n \"\",\n \"\"\n ],\n \"sdk_config\": {},\n \"created_at\": \"\",\n \"deployment_id\": \"\",\n \"notice_id\": \"\",\n \"notice_config_id\": \"\",\n \"notice_regulation_config_id\": \"\",\n \"organization_id\": \"\"\n }\n]", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-3bec920a-e5ab-472b-87bf-0aaba244b224" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-5d1ace07-392a-4509-8637-fa508a96e899" } ], "id": "9d8da1cc-930f-434d-b2c3-c16805c207f7", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-9d8da1cc-930f-434d-b2c3-c16805c207f7" }, { "name": "{id}", "item": [ { "name": "Retrieve a notice", "id": "7a859459-f38b-475f-be34-3c7102c25b46", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/widgets/notices/:id", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", ":id" ], "variable": [ { "id": "038d6da7-f0a3-431e-8035-265af6c64f6f", "key": "id", "value": "", "description": "(Required) ID of the notice to retrieve" } ] }, "description": "Returns a single notice" }, "response": [ { "id": "9dae2995-5a45-44e0-b421-7b27b94a5d60", "name": "A Notice object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/widgets/notices/:id", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"archived_at\": \"\",\n \"version\": \"\",\n \"privacy_experience_id\": \"\",\n \"environment\": \"\",\n \"external_source\": \"\",\n \"external_id\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-9dae2995-5a45-44e0-b421-7b27b94a5d60" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-7a859459-f38b-475f-be34-3c7102c25b46" }, { "name": "Update a notice", "id": "136bde1b-d950-4800-8135-f8380eda5a9f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"archived_at\": \"\",\n \"version\": \"\",\n \"privacy_experience_id\": \"\",\n \"environment\": \"\",\n \"external_source\": \"\",\n \"external_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/widgets/notices/:id", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", ":id" ], "variable": [ { "id": "f8a2908a-3a74-4b19-9e95-4aba69b044fc", "key": "id", "value": "", "description": "(Required) The ID of the notice to update" } ] }, "description": "Update an existing notice" }, "response": [ { "id": "8963e87b-ec6a-46c0-a210-700bea49c4b5", "name": "The updated Notice object", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"archived_at\": \"\",\n \"version\": \"\",\n \"privacy_experience_id\": \"\",\n \"environment\": \"\",\n \"external_source\": \"\",\n \"external_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/widgets/notices/:id", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"archived_at\": \"\",\n \"version\": \"\",\n \"privacy_experience_id\": \"\",\n \"environment\": \"\",\n \"external_source\": \"\",\n \"external_id\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-8963e87b-ec6a-46c0-a210-700bea49c4b5" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-136bde1b-d950-4800-8135-f8380eda5a9f" }, { "name": "Patch a notice", "id": "803cff47-6937-4df8-b856-f103753a110b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"archived_at\": \"\",\n \"version\": \"\",\n \"privacy_experience_id\": \"\",\n \"environment\": \"\",\n \"external_source\": \"\",\n \"external_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/widgets/notices/:id", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", ":id" ], "variable": [ { "id": "708d2ce2-7a46-46b8-9318-8ac25ff4879c", "key": "id", "value": "", "description": "(Required) The ID of the notice to patch" } ] }, "description": "Partially update a notice" }, "response": [ { "id": "2e6b3cd5-0c71-4d37-8992-a6ce877aff4a", "name": "The patched Notice object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"archived_at\": \"\",\n \"version\": \"\",\n \"privacy_experience_id\": \"\",\n \"environment\": \"\",\n \"external_source\": \"\",\n \"external_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/widgets/notices/:id", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"archived_at\": \"\",\n \"version\": \"\",\n \"privacy_experience_id\": \"\",\n \"environment\": \"\",\n \"external_source\": \"\",\n \"external_id\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-2e6b3cd5-0c71-4d37-8992-a6ce877aff4a" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-803cff47-6937-4df8-b856-f103753a110b" }, { "name": "Delete a notice", "id": "62107703-557f-449e-91dc-1340ef331e40", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/widgets/notices/:id", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", ":id" ], "variable": [ { "id": "27ff7906-85b2-477f-87aa-3c09d1859502", "key": "id", "value": "", "description": "(Required) The ID of the notice to delete" } ] }, "description": "Delete an existing notice" }, "response": [ { "id": "5a49fecc-3cc8-44a5-b196-742fc3be6e12", "name": "The deleted Notice object", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/widgets/notices/:id", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"archived_at\": \"\",\n \"version\": \"\",\n \"privacy_experience_id\": \"\",\n \"environment\": \"\",\n \"external_source\": \"\",\n \"external_id\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-5a49fecc-3cc8-44a5-b196-742fc3be6e12" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-62107703-557f-449e-91dc-1340ef331e40" } ], "id": "74a7b8bb-b269-4869-b1ce-218923a4ba35", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-74a7b8bb-b269-4869-b1ce-218923a4ba35" }, { "name": "Retrieve a list of notices", "id": "fbe5a664-e5f1-42f2-85f7-e46a3c106770", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/widgets/notices", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices" ] }, "description": "Returns a list of notices" }, "response": [ { "id": "86f08ffc-39bf-470e-b64b-8f5ecff305e6", "name": "A list of Notice objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/widgets/notices", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"archived_at\": \"\",\n \"version\": \"\",\n \"privacy_experience_id\": \"\",\n \"environment\": \"\",\n \"external_source\": \"\",\n \"external_id\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"archived_at\": \"\",\n \"version\": \"\",\n \"privacy_experience_id\": \"\",\n \"environment\": \"\",\n \"external_source\": \"\",\n \"external_id\": \"\"\n }\n]", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-86f08ffc-39bf-470e-b64b-8f5ecff305e6" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-fbe5a664-e5f1-42f2-85f7-e46a3c106770" }, { "name": "Create a notice", "id": "31795e16-b16f-442c-a6fe-5ff2f7eb8f6d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"archived_at\": \"\",\n \"version\": \"\",\n \"privacy_experience_id\": \"\",\n \"environment\": \"\",\n \"external_source\": \"\",\n \"external_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/widgets/notices?duplicate=", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices" ], "query": [ { "description": "The ID of the notice you want to duplicate", "key": "duplicate", "value": "" } ] }, "description": "Create a new notice for an organization" }, "response": [ { "id": "796a24c0-c77b-4bd0-83a1-a5ba3885d5fb", "name": "The created Notice object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"archived_at\": \"\",\n \"version\": \"\",\n \"privacy_experience_id\": \"\",\n \"environment\": \"\",\n \"external_source\": \"\",\n \"external_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/widgets/notices?duplicate=", "host": [ "{{baseUrl}}" ], "path": [ "widgets", "notices" ], "query": [ { "description": "The ID of the notice you want to duplicate", "key": "duplicate", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"archived_at\": \"\",\n \"version\": \"\",\n \"privacy_experience_id\": \"\",\n \"environment\": \"\",\n \"external_source\": \"\",\n \"external_id\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-796a24c0-c77b-4bd0-83a1-a5ba3885d5fb" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-31795e16-b16f-442c-a6fe-5ff2f7eb8f6d" } ], "id": "d5c76749-2057-4d94-9693-1040af902e40", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-d5c76749-2057-4d94-9693-1040af902e40" } ], "id": "912345c0-8098-4271-80ac-a0a4180a03e4", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-912345c0-8098-4271-80ac-a0a4180a03e4" }, { "name": "sessions", "item": [ { "name": "{id}", "item": [ { "name": "Retrieves a single resource with the given id from the service.", "id": "3ebc6a3d-d67c-4770-b324-20a0fdb21991", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/sessions/:id", "host": [ "{{baseUrl}}" ], "path": [ "sessions", ":id" ], "variable": [ { "id": "41a5cffb-5044-4726-9627-c323f32f352b", "key": "id", "value": "", "description": "(Required) ID of sessions to return" } ] }, "description": "Retrieves a single resource with the given id from the service." }, "response": [ { "id": "91910b2d-c944-4753-b0bf-a8db5c46bd5d", "name": "success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/sessions/:id", "host": [ "{{baseUrl}}" ], "path": [ "sessions", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"key\": \"\",\n \"access_token\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-91910b2d-c944-4753-b0bf-a8db5c46bd5d" }, { "id": "c5ac9e24-0df0-4e19-8d64-f8b859721a51", "name": "not authenticated", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/sessions/:id", "host": [ "{{baseUrl}}" ], "path": [ "sessions", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-c5ac9e24-0df0-4e19-8d64-f8b859721a51" }, { "id": "10dd8481-a4a4-4f3d-ba4d-2b8a5925068d", "name": "not found", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/sessions/:id", "host": [ "{{baseUrl}}" ], "path": [ "sessions", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-10dd8481-a4a4-4f3d-ba4d-2b8a5925068d" }, { "id": "5e5cc86d-a041-4d08-a4a2-94f1285500ea", "name": "general error", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/sessions/:id", "host": [ "{{baseUrl}}" ], "path": [ "sessions", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-5e5cc86d-a041-4d08-a4a2-94f1285500ea" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-3ebc6a3d-d67c-4770-b324-20a0fdb21991" } ], "id": "6f2ab991-7bb5-48c1-9d0a-2f141586a994", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-6f2ab991-7bb5-48c1-9d0a-2f141586a994" }, { "name": "Create a new session", "id": "eb16ef77-6229-4572-9578-4d4e7fe1d06a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"\",\n \"key\": \"\",\n \"access_token\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sessions", "host": [ "{{baseUrl}}" ], "path": [ "sessions" ] }, "description": "Authenticate against the Didomi API and get an access token to use for calls requiring authorization" }, "response": [ { "id": "06aa9088-2b5e-45da-a091-0f622f6e9e46", "name": "The created Session object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"\",\n \"key\": \"\",\n \"access_token\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sessions", "host": [ "{{baseUrl}}" ], "path": [ "sessions" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"key\": \"\",\n \"access_token\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-06aa9088-2b5e-45da-a091-0f622f6e9e46" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-eb16ef77-6229-4572-9578-4d4e7fe1d06a" } ], "id": "a66d0470-78b2-41e9-b5f2-791d544ee958", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-a66d0470-78b2-41e9-b5f2-791d544ee958" }, { "name": "keys", "item": [ { "name": "{id}", "item": [ { "name": "Retrieve an API key", "id": "4f854136-5bbd-4783-a90b-f10e7eeaf802", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/keys/:id", "host": [ "{{baseUrl}}" ], "path": [ "keys", ":id" ], "variable": [ { "id": "bc34d7cf-01b1-4562-9f07-e2ed490e1607", "key": "id", "value": "", "description": "(Required) The ID of the API key to retrieve" } ] }, "description": "Returns a single API key with the given ID" }, "response": [ { "id": "af22d97a-c49b-4161-b572-45c0ab05197a", "name": "An APIKey object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/keys/:id", "host": [ "{{baseUrl}}" ], "path": [ "keys", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"enabled\": \"\",\n \"is_internal\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-af22d97a-c49b-4161-b572-45c0ab05197a" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-4f854136-5bbd-4783-a90b-f10e7eeaf802" }, { "name": "Update an API key", "id": "df953510-808e-4854-b422-dce2a583ab30", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"enabled\": \"\",\n \"is_internal\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/keys/:id", "host": [ "{{baseUrl}}" ], "path": [ "keys", ":id" ], "variable": [ { "id": "885c2c0f-e9e3-43bb-b5e7-728af8067954", "key": "id", "value": "", "description": "(Required) The ID of the API key to update" } ] }, "description": "Update an existing API key" }, "response": [ { "id": "336b3a44-12e1-4f43-ac98-ed577be33090", "name": "The updated APIKey object", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"enabled\": \"\",\n \"is_internal\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/keys/:id", "host": [ "{{baseUrl}}" ], "path": [ "keys", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"enabled\": \"\",\n \"is_internal\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-336b3a44-12e1-4f43-ac98-ed577be33090" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-df953510-808e-4854-b422-dce2a583ab30" }, { "name": "Patch an API key", "id": "3c83bb17-9c0a-49cf-830a-a10f82adcd72", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"enabled\": \"\",\n \"is_internal\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/keys/:id", "host": [ "{{baseUrl}}" ], "path": [ "keys", ":id" ], "variable": [ { "id": "443cb069-cee9-42b9-9ea2-cc8e8665382f", "key": "id", "value": "", "description": "(Required) The ID of the API key to patch" } ] }, "description": "Patch an existing API key" }, "response": [ { "id": "8fb34e7d-b1e4-4bc6-90d1-4ba9f9b238b1", "name": "The patched APIKey object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"enabled\": \"\",\n \"is_internal\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/keys/:id", "host": [ "{{baseUrl}}" ], "path": [ "keys", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"enabled\": \"\",\n \"is_internal\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-8fb34e7d-b1e4-4bc6-90d1-4ba9f9b238b1" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-3c83bb17-9c0a-49cf-830a-a10f82adcd72" }, { "name": "Delete an API key", "id": "4c6fa525-aeee-469a-9dbd-f23c6ed91550", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/keys/:id", "host": [ "{{baseUrl}}" ], "path": [ "keys", ":id" ], "variable": [ { "id": "336e7a7d-f34b-47cf-88c4-30d81f3515a0", "key": "id", "value": "", "description": "(Required) The ID of the API key to delete" } ] }, "description": "Delete an existing API key" }, "response": [ { "id": "450c338c-fe3b-4d8d-830c-336b0e9898a0", "name": "The deleted APIKey object", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/keys/:id", "host": [ "{{baseUrl}}" ], "path": [ "keys", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"enabled\": \"\",\n \"is_internal\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-450c338c-fe3b-4d8d-830c-336b0e9898a0" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-4c6fa525-aeee-469a-9dbd-f23c6ed91550" } ], "id": "a7a22305-7541-4f99-96c5-46cde6cd2d87", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-a7a22305-7541-4f99-96c5-46cde6cd2d87" }, { "name": "Retrieve a list of API keys", "id": "22b3341d-5be8-43b8-aefd-692f861c1604", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/keys?$limit=&$skip=&id=&name=&description=&organization_id=&created_at=&enabled=&is_internal=", "host": [ "{{baseUrl}}" ], "path": [ "keys" ], "query": [ { "description": "Number of results to return", "key": "$limit", "value": "" }, { "description": "Number of results to skip", "key": "$skip", "value": "" }, { "description": "Query parameters to filter", "key": "id", "value": "" }, { "description": "Query parameters to filter", "key": "name", "value": "" }, { "description": "Query parameters to filter", "key": "description", "value": "" }, { "description": "Query parameters to filter", "key": "organization_id", "value": "" }, { "description": "Query parameters to filter", "key": "created_at", "value": "" }, { "description": "Query parameters to filter", "key": "enabled", "value": "" }, { "description": "Query parameters to filter", "key": "is_internal", "value": "" } ] }, "description": "Returns a list of all API keys the user has access to" }, "response": [ { "id": "407f8ba6-77ee-4302-af3a-b9e33a9b1ab8", "name": "A list of APIKey objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/keys?$limit=&$skip=&id=&name=&description=&organization_id=&created_at=&enabled=&is_internal=", "host": [ "{{baseUrl}}" ], "path": [ "keys" ], "query": [ { "description": "Number of results to return", "key": "$limit", "value": "" }, { "description": "Number of results to skip", "key": "$skip", "value": "" }, { "description": "Query parameters to filter", "key": "id", "value": "" }, { "description": "Query parameters to filter", "key": "name", "value": "" }, { "description": "Query parameters to filter", "key": "description", "value": "" }, { "description": "Query parameters to filter", "key": "organization_id", "value": "" }, { "description": "Query parameters to filter", "key": "created_at", "value": "" }, { "description": "Query parameters to filter", "key": "enabled", "value": "" }, { "description": "Query parameters to filter", "key": "is_internal", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"enabled\": \"\",\n \"is_internal\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"enabled\": \"\",\n \"is_internal\": \"\"\n }\n]", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-407f8ba6-77ee-4302-af3a-b9e33a9b1ab8" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-22b3341d-5be8-43b8-aefd-692f861c1604" }, { "name": "Create a new API key", "id": "7cbbc03b-cea7-4e60-9b9b-e79ee65f45fa", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"enabled\": \"\",\n \"is_internal\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/keys", "host": [ "{{baseUrl}}" ], "path": [ "keys" ] }, "description": "Create a new API key that can be used for authenticating HTTP requests to the Didomi API" }, "response": [ { "id": "d48a1be7-54d1-4f01-aaab-e41ffb26951c", "name": "The created APIKey object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"enabled\": \"\",\n \"is_internal\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/keys", "host": [ "{{baseUrl}}" ], "path": [ "keys" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"enabled\": \"\",\n \"secret\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-d48a1be7-54d1-4f01-aaab-e41ffb26951c" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-7cbbc03b-cea7-4e60-9b9b-e79ee65f45fa" } ], "id": "e9bd5f22-de7c-4697-86d8-c3385a2089ed", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-e9bd5f22-de7c-4697-86d8-c3385a2089ed" }, { "name": "quotas", "item": [ { "name": "{id}", "item": [ { "name": "Retrieve a quota", "id": "3bc2231a-18a1-4285-a85d-01f81d3c0f8a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/quotas/:id", "host": [ "{{baseUrl}}" ], "path": [ "quotas", ":id" ], "variable": [ { "id": "aec8bfda-7110-4052-a103-dac3dc04841c", "key": "id", "value": "", "description": "(Required) The ID of the quota to retrieve" } ] }, "description": "Returns a single quota with the given ID" }, "response": [ { "id": "e8efab2b-f099-4f0f-a052-abe50343265c", "name": "A Quota object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/quotas/:id", "host": [ "{{baseUrl}}" ], "path": [ "quotas", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"exports_configs\": \"\",\n \"exports_destinations\": \"\",\n \"scraper_enabled_properties\": \"\",\n \"parallel_notices_deployments\": \"\",\n \"consent_proof_reports\": \"\",\n \"api_requests\": \"\",\n \"delivery_clouds\": \"\",\n \"services_per_delivery_cloud\": \"\",\n \"regions_per_delivery_cloud\": \"\",\n \"domains_per_delivery_cloud\": \"\",\n \"acm_scan_max_pages_per_property\": \"\",\n \"secrets\": \"\",\n \"metadata_purposes\": \"\",\n \"metadata_partners\": \"\",\n \"version\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-e8efab2b-f099-4f0f-a052-abe50343265c" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-3bc2231a-18a1-4285-a85d-01f81d3c0f8a" } ], "id": "76cfe57d-b7ce-42ac-8967-779ef8617a23", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-76cfe57d-b7ce-42ac-8967-779ef8617a23" }, { "name": "Retrieve a list of quotas", "id": "015f7f47-3256-4afc-bdf8-651420cae89e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/quotas?$limit=&$skip=&id=&organization_id=&created_at=&updated_at=&exports_configs=&exports_destinations=&scraper_enabled_properties=¶llel_notices_deployments=&consent_proof_reports=&api_requests=&delivery_clouds=&services_per_delivery_cloud=®ions_per_delivery_cloud=&domains_per_delivery_cloud=&acm_scan_max_pages_per_property=&secrets=&metadata_purposes=&metadata_partners=&version=", "host": [ "{{baseUrl}}" ], "path": [ "quotas" ], "query": [ { "description": "Number of results to return", "key": "$limit", "value": "" }, { "description": "Number of results to skip", "key": "$skip", "value": "" }, { "description": "Query parameters to filter", "key": "id", "value": "" }, { "description": "Query parameters to filter", "key": "organization_id", "value": "" }, { "description": "Query parameters to filter", "key": "created_at", "value": "" }, { "description": "Query parameters to filter", "key": "updated_at", "value": "" }, { "description": "Query parameters to filter", "key": "exports_configs", "value": "" }, { "description": "Query parameters to filter", "key": "exports_destinations", "value": "" }, { "description": "Query parameters to filter", "key": "scraper_enabled_properties", "value": "" }, { "description": "Query parameters to filter", "key": "parallel_notices_deployments", "value": "" }, { "description": "Query parameters to filter", "key": "consent_proof_reports", "value": "" }, { "description": "Query parameters to filter", "key": "api_requests", "value": "" }, { "description": "Query parameters to filter", "key": "delivery_clouds", "value": "" }, { "description": "Query parameters to filter", "key": "services_per_delivery_cloud", "value": "" }, { "description": "Query parameters to filter", "key": "regions_per_delivery_cloud", "value": "" }, { "description": "Query parameters to filter", "key": "domains_per_delivery_cloud", "value": "" }, { "description": "Query parameters to filter", "key": "acm_scan_max_pages_per_property", "value": "" }, { "description": "Query parameters to filter", "key": "secrets", "value": "" }, { "description": "Query parameters to filter", "key": "metadata_purposes", "value": "" }, { "description": "Query parameters to filter", "key": "metadata_partners", "value": "" }, { "description": "Query parameters to filter", "key": "version", "value": "" } ] }, "description": "Returns a list of all quotas for the organizations the user belongs to" }, "response": [ { "id": "a5cf1eb8-ca43-4248-9e73-8f51ac30cb0f", "name": "A list of Quota objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/quotas?$limit=&$skip=&id=&organization_id=&created_at=&updated_at=&exports_configs=&exports_destinations=&scraper_enabled_properties=¶llel_notices_deployments=&consent_proof_reports=&api_requests=&delivery_clouds=&services_per_delivery_cloud=®ions_per_delivery_cloud=&domains_per_delivery_cloud=&acm_scan_max_pages_per_property=&secrets=&metadata_purposes=&metadata_partners=&version=", "host": [ "{{baseUrl}}" ], "path": [ "quotas" ], "query": [ { "description": "Number of results to return", "key": "$limit", "value": "" }, { "description": "Number of results to skip", "key": "$skip", "value": "" }, { "description": "Query parameters to filter", "key": "id", "value": "" }, { "description": "Query parameters to filter", "key": "organization_id", "value": "" }, { "description": "Query parameters to filter", "key": "created_at", "value": "" }, { "description": "Query parameters to filter", "key": "updated_at", "value": "" }, { "description": "Query parameters to filter", "key": "exports_configs", "value": "" }, { "description": "Query parameters to filter", "key": "exports_destinations", "value": "" }, { "description": "Query parameters to filter", "key": "scraper_enabled_properties", "value": "" }, { "description": "Query parameters to filter", "key": "parallel_notices_deployments", "value": "" }, { "description": "Query parameters to filter", "key": "consent_proof_reports", "value": "" }, { "description": "Query parameters to filter", "key": "api_requests", "value": "" }, { "description": "Query parameters to filter", "key": "delivery_clouds", "value": "" }, { "description": "Query parameters to filter", "key": "services_per_delivery_cloud", "value": "" }, { "description": "Query parameters to filter", "key": "regions_per_delivery_cloud", "value": "" }, { "description": "Query parameters to filter", "key": "domains_per_delivery_cloud", "value": "" }, { "description": "Query parameters to filter", "key": "acm_scan_max_pages_per_property", "value": "" }, { "description": "Query parameters to filter", "key": "secrets", "value": "" }, { "description": "Query parameters to filter", "key": "metadata_purposes", "value": "" }, { "description": "Query parameters to filter", "key": "metadata_partners", "value": "" }, { "description": "Query parameters to filter", "key": "version", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"exports_configs\": \"\",\n \"exports_destinations\": \"\",\n \"scraper_enabled_properties\": \"\",\n \"parallel_notices_deployments\": \"\",\n \"consent_proof_reports\": \"\",\n \"api_requests\": \"\",\n \"delivery_clouds\": \"\",\n \"services_per_delivery_cloud\": \"\",\n \"regions_per_delivery_cloud\": \"\",\n \"domains_per_delivery_cloud\": \"\",\n \"acm_scan_max_pages_per_property\": \"\",\n \"secrets\": \"\",\n \"metadata_purposes\": \"\",\n \"metadata_partners\": \"\",\n \"version\": \"\"\n },\n {\n \"id\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"exports_configs\": \"\",\n \"exports_destinations\": \"\",\n \"scraper_enabled_properties\": \"\",\n \"parallel_notices_deployments\": \"\",\n \"consent_proof_reports\": \"\",\n \"api_requests\": \"\",\n \"delivery_clouds\": \"\",\n \"services_per_delivery_cloud\": \"\",\n \"regions_per_delivery_cloud\": \"\",\n \"domains_per_delivery_cloud\": \"\",\n \"acm_scan_max_pages_per_property\": \"\",\n \"secrets\": \"\",\n \"metadata_purposes\": \"\",\n \"metadata_partners\": \"\",\n \"version\": \"\"\n }\n]", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-a5cf1eb8-ca43-4248-9e73-8f51ac30cb0f" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-015f7f47-3256-4afc-bdf8-651420cae89e" } ], "id": "066dc8c6-dd60-4f06-b209-0023d9cd3ba1", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-066dc8c6-dd60-4f06-b209-0023d9cd3ba1" }, { "name": "domains", "item": [ { "name": "{id}", "item": [ { "name": "Retrieve a domain", "id": "18409348-849b-4636-977e-992f34277074", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/domains/:id", "host": [ "{{baseUrl}}" ], "path": [ "domains", ":id" ], "variable": [ { "id": "a16e2c7c-d9e5-4437-9b18-63137a8b7364", "key": "id", "value": "", "description": "(Required) The ID of the domain to retrieve" } ] }, "description": "Returns a domain by its ID" }, "response": [ { "id": "fae2538d-e87a-428f-8441-2b11bba2247e", "name": "A Domain object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/domains/:id", "host": [ "{{baseUrl}}" ], "path": [ "domains", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"organization_id\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"entity_id\": \"\",\n \"type\": \"\",\n \"status\": \"\",\n \"usage\": \"\",\n \"bots_crawl\": \"disallow_all\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-fae2538d-e87a-428f-8441-2b11bba2247e" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-18409348-849b-4636-977e-992f34277074" }, { "name": "Update a domain", "id": "d4126245-09da-420a-ab70-15e4358ce3b7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"organization_id\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"entity_id\": \"\",\n \"type\": \"\",\n \"status\": \"\",\n \"usage\": \"\",\n \"bots_crawl\": \"disallow_all\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/domains/:id", "host": [ "{{baseUrl}}" ], "path": [ "domains", ":id" ], "variable": [ { "id": "4c8db97e-43c4-4948-a8f8-fba26959e057", "key": "id", "value": "", "description": "(Required) The ID of the domain to update" } ] }, "description": "Update an existing domain" }, "response": [ { "id": "5677b156-9505-463e-a0a4-2766e442555d", "name": "The updated Domain object", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"organization_id\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"entity_id\": \"\",\n \"type\": \"\",\n \"status\": \"\",\n \"usage\": \"\",\n \"bots_crawl\": \"disallow_all\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/domains/:id", "host": [ "{{baseUrl}}" ], "path": [ "domains", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"organization_id\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"entity_id\": \"\",\n \"type\": \"\",\n \"status\": \"\",\n \"usage\": \"\",\n \"bots_crawl\": \"disallow_all\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-5677b156-9505-463e-a0a4-2766e442555d" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-d4126245-09da-420a-ab70-15e4358ce3b7" }, { "name": "Patch a domain", "id": "a0baa707-76aa-41ba-88bb-ba2c1417a2ba", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"organization_id\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"entity_id\": \"\",\n \"type\": \"\",\n \"status\": \"\",\n \"usage\": \"\",\n \"bots_crawl\": \"disallow_all\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/domains/:id", "host": [ "{{baseUrl}}" ], "path": [ "domains", ":id" ], "variable": [ { "id": "86d6cb69-e084-4ea8-bf5d-9d4a828c9657", "key": "id", "value": "", "description": "(Required) The ID of the domain to patch" } ] }, "description": "Partially update a domain" }, "response": [ { "id": "32d30766-93ea-4ad9-ac5c-bb6b33f835f8", "name": "The patched Domain object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"organization_id\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"entity_id\": \"\",\n \"type\": \"\",\n \"status\": \"\",\n \"usage\": \"\",\n \"bots_crawl\": \"disallow_all\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/domains/:id", "host": [ "{{baseUrl}}" ], "path": [ "domains", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"organization_id\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"entity_id\": \"\",\n \"type\": \"\",\n \"status\": \"\",\n \"usage\": \"\",\n \"bots_crawl\": \"disallow_all\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-32d30766-93ea-4ad9-ac5c-bb6b33f835f8" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-a0baa707-76aa-41ba-88bb-ba2c1417a2ba" }, { "name": "Delete a domain", "id": "279ea229-c112-4d0a-841c-e2287a740f1a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/domains/:id", "host": [ "{{baseUrl}}" ], "path": [ "domains", ":id" ], "variable": [ { "id": "4e0e906a-1e9a-424b-b98b-52f08e60bb06", "key": "id", "value": "", "description": "(Required) The ID of the domain to delete" } ] }, "description": "Delete a domain with type \"managed\" by its ID" }, "response": [ { "id": "d3058fc1-fbac-49e2-b9de-686051de0617", "name": "A Domain object", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/domains/:id", "host": [ "{{baseUrl}}" ], "path": [ "domains", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"organization_id\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"entity_id\": \"\",\n \"type\": \"\",\n \"status\": \"\",\n \"usage\": \"\",\n \"bots_crawl\": \"disallow_all\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-d3058fc1-fbac-49e2-b9de-686051de0617" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-279ea229-c112-4d0a-841c-e2287a740f1a" } ], "id": "c794597b-495a-4689-b81c-9f9804177658", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-c794597b-495a-4689-b81c-9f9804177658" }, { "name": "Retrieve a list of domains", "id": "2d9a0d2b-94d9-4b26-acdc-7bc0a4a6edc8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/domains?$limit=&$skip=&id=&organization_id=&description=&enabled=&entity_id=&type=&status=&usage=&bots_crawl=disallow_all&created_at=&updated_at=&version=", "host": [ "{{baseUrl}}" ], "path": [ "domains" ], "query": [ { "description": "Number of results to return", "key": "$limit", "value": "" }, { "description": "Number of results to skip", "key": "$skip", "value": "" }, { "description": "Query parameters to filter", "key": "id", "value": "" }, { "description": "Query parameters to filter", "key": "organization_id", "value": "" }, { "description": "Query parameters to filter", "key": "description", "value": "" }, { "description": "Query parameters to filter", "key": "enabled", "value": "" }, { "description": "Query parameters to filter", "key": "entity_id", "value": "" }, { "description": "Query parameters to filter", "key": "type", "value": "" }, { "description": "Query parameters to filter", "key": "status", "value": "" }, { "description": "Query parameters to filter", "key": "usage", "value": "" }, { "description": "Query parameters to filter", "key": "bots_crawl", "value": "disallow_all" }, { "description": "Query parameters to filter", "key": "created_at", "value": "" }, { "description": "Query parameters to filter", "key": "updated_at", "value": "" }, { "description": "Query parameters to filter", "key": "version", "value": "" } ] }, "description": "Returns a list of domains" }, "response": [ { "id": "fa061657-b721-40ac-bb56-06ea51f03e31", "name": "A list of Domain objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/domains?$limit=&$skip=&id=&organization_id=&description=&enabled=&entity_id=&type=&status=&usage=&bots_crawl=disallow_all&created_at=&updated_at=&version=", "host": [ "{{baseUrl}}" ], "path": [ "domains" ], "query": [ { "description": "Number of results to return", "key": "$limit", "value": "" }, { "description": "Number of results to skip", "key": "$skip", "value": "" }, { "description": "Query parameters to filter", "key": "id", "value": "" }, { "description": "Query parameters to filter", "key": "organization_id", "value": "" }, { "description": "Query parameters to filter", "key": "description", "value": "" }, { "description": "Query parameters to filter", "key": "enabled", "value": "" }, { "description": "Query parameters to filter", "key": "entity_id", "value": "" }, { "description": "Query parameters to filter", "key": "type", "value": "" }, { "description": "Query parameters to filter", "key": "status", "value": "" }, { "description": "Query parameters to filter", "key": "usage", "value": "" }, { "description": "Query parameters to filter", "key": "bots_crawl", "value": "disallow_all" }, { "description": "Query parameters to filter", "key": "created_at", "value": "" }, { "description": "Query parameters to filter", "key": "updated_at", "value": "" }, { "description": "Query parameters to filter", "key": "version", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"organization_id\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"entity_id\": \"\",\n \"type\": \"\",\n \"status\": \"\",\n \"usage\": \"\",\n \"bots_crawl\": \"disallow_all\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n },\n {\n \"id\": \"\",\n \"organization_id\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"entity_id\": \"\",\n \"type\": \"\",\n \"status\": \"\",\n \"usage\": \"\",\n \"bots_crawl\": \"allow_all\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n }\n]", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-fa061657-b721-40ac-bb56-06ea51f03e31" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-2d9a0d2b-94d9-4b26-acdc-7bc0a4a6edc8" }, { "name": "Create a domain", "id": "d561a02d-19f2-4fa5-94b9-08057441fc32", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"organization_id\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"entity_id\": \"\",\n \"type\": \"\",\n \"status\": \"\",\n \"usage\": \"\",\n \"bots_crawl\": \"disallow_all\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/domains", "host": [ "{{baseUrl}}" ], "path": [ "domains" ] }, "description": "Create a new domain" }, "response": [ { "id": "48c2c0df-3709-4eca-b729-258673102ce1", "name": "The created Domain object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"organization_id\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"entity_id\": \"\",\n \"type\": \"\",\n \"status\": \"\",\n \"usage\": \"\",\n \"bots_crawl\": \"disallow_all\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/domains", "host": [ "{{baseUrl}}" ], "path": [ "domains" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"organization_id\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"entity_id\": \"\",\n \"type\": \"\",\n \"status\": \"\",\n \"usage\": \"\",\n \"bots_crawl\": \"disallow_all\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-48c2c0df-3709-4eca-b729-258673102ce1" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-d561a02d-19f2-4fa5-94b9-08057441fc32" } ], "id": "c4e382d0-62d0-46b1-a249-ac2871e815d1", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-c4e382d0-62d0-46b1-a249-ac2871e815d1" }, { "name": "secrets", "item": [ { "name": "{id}", "item": [ { "name": "Retrieve a secret", "id": "6a3adde6-9ec4-4e1d-bb75-bc178270b910", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/secrets/:id", "host": [ "{{baseUrl}}" ], "path": [ "secrets", ":id" ], "variable": [ { "id": "94e8e376-c187-471d-9d62-b061cbd7df41", "key": "id", "value": "", "description": "(Required) The ID of the secret to retrieve" } ] }, "description": "Returns a single secret with the given ID" }, "response": [ { "id": "a46e5186-4f38-49be-b17d-01e4c595cd25", "name": "A Secret object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/secrets/:id", "host": [ "{{baseUrl}}" ], "path": [ "secrets", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"organization_id\": \"\",\n \"description\": \"\",\n \"secret\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-a46e5186-4f38-49be-b17d-01e4c595cd25" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-6a3adde6-9ec4-4e1d-bb75-bc178270b910" }, { "name": "Update a secret", "id": "824db53f-cfda-4ea5-9781-f0420b28aa0f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"organization_id\": \"\",\n \"description\": \"\",\n \"secret\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/secrets/:id", "host": [ "{{baseUrl}}" ], "path": [ "secrets", ":id" ], "variable": [ { "id": "8f521ae9-771b-43e3-b384-2e319d5d7a0b", "key": "id", "value": "", "description": "(Required) The ID of the secret to update" } ] }, "description": "Update an existing secret" }, "response": [ { "id": "effa001e-542f-49b7-9ab5-0cec6f0f8d1e", "name": "The updated Secret object", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"organization_id\": \"\",\n \"description\": \"\",\n \"secret\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/secrets/:id", "host": [ "{{baseUrl}}" ], "path": [ "secrets", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"organization_id\": \"\",\n \"description\": \"\",\n \"secret\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-effa001e-542f-49b7-9ab5-0cec6f0f8d1e" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-824db53f-cfda-4ea5-9781-f0420b28aa0f" }, { "name": "Patch a secret", "id": "a9cbb81a-f1ae-442b-a526-dc0b88b69e35", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"organization_id\": \"\",\n \"description\": \"\",\n \"secret\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/secrets/:id", "host": [ "{{baseUrl}}" ], "path": [ "secrets", ":id" ], "variable": [ { "id": "be42e3a0-0d6a-40f2-93bd-f6b666ea30ea", "key": "id", "value": "", "description": "(Required) The ID of the secret to patch" } ] }, "description": "Partially update a secret" }, "response": [ { "id": "4202a638-920f-4576-8527-f1b777b5ca0c", "name": "The patched Secret object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"organization_id\": \"\",\n \"description\": \"\",\n \"secret\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/secrets/:id", "host": [ "{{baseUrl}}" ], "path": [ "secrets", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"organization_id\": \"\",\n \"description\": \"\",\n \"secret\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-4202a638-920f-4576-8527-f1b777b5ca0c" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-a9cbb81a-f1ae-442b-a526-dc0b88b69e35" }, { "name": "Delete a secret", "id": "4ad1f592-0618-4cd5-8846-1b7de28c8962", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/secrets/:id", "host": [ "{{baseUrl}}" ], "path": [ "secrets", ":id" ], "variable": [ { "id": "f7b9ed38-f012-493f-a4e1-93da4b7d3c3c", "key": "id", "value": "", "description": "(Required) The ID of the secret to delete" } ] }, "description": "Delete an existing secret. Secrets are unrecoverable after being deleted so make sure that they are not in-use before deleting them." }, "response": [ { "id": "4bd24536-00da-43c7-b256-1c3f8fefabe1", "name": "The deleted Secret object", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/secrets/:id", "host": [ "{{baseUrl}}" ], "path": [ "secrets", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"organization_id\": \"\",\n \"description\": \"\",\n \"secret\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-4bd24536-00da-43c7-b256-1c3f8fefabe1" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-4ad1f592-0618-4cd5-8846-1b7de28c8962" } ], "id": "b9155d1d-f971-4c85-b699-fa1f379c343f", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-b9155d1d-f971-4c85-b699-fa1f379c343f" }, { "name": "Retrieve a list of secrets", "id": "6b6fcf42-959d-4b0a-a1ec-1ca9e7b40bf0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/secrets?$limit=&$skip=&id=&name=&organization_id=&description=&secret=&created_at=&updated_at=&version=", "host": [ "{{baseUrl}}" ], "path": [ "secrets" ], "query": [ { "description": "Number of results to return", "key": "$limit", "value": "" }, { "description": "Number of results to skip", "key": "$skip", "value": "" }, { "description": "Query parameters to filter", "key": "id", "value": "" }, { "description": "Query parameters to filter", "key": "name", "value": "" }, { "description": "Query parameters to filter", "key": "organization_id", "value": "" }, { "description": "Query parameters to filter", "key": "description", "value": "" }, { "description": "Query parameters to filter", "key": "secret", "value": "" }, { "description": "Query parameters to filter", "key": "created_at", "value": "" }, { "description": "Query parameters to filter", "key": "updated_at", "value": "" }, { "description": "Query parameters to filter", "key": "version", "value": "" } ] }, "description": "Returns a list of all the secrets the user has access to" }, "response": [ { "id": "4d604a3b-00f2-414b-8816-a2470f05a677", "name": "A list of Secret objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/secrets?$limit=&$skip=&id=&name=&organization_id=&description=&secret=&created_at=&updated_at=&version=", "host": [ "{{baseUrl}}" ], "path": [ "secrets" ], "query": [ { "description": "Number of results to return", "key": "$limit", "value": "" }, { "description": "Number of results to skip", "key": "$skip", "value": "" }, { "description": "Query parameters to filter", "key": "id", "value": "" }, { "description": "Query parameters to filter", "key": "name", "value": "" }, { "description": "Query parameters to filter", "key": "organization_id", "value": "" }, { "description": "Query parameters to filter", "key": "description", "value": "" }, { "description": "Query parameters to filter", "key": "secret", "value": "" }, { "description": "Query parameters to filter", "key": "created_at", "value": "" }, { "description": "Query parameters to filter", "key": "updated_at", "value": "" }, { "description": "Query parameters to filter", "key": "version", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"organization_id\": \"\",\n \"description\": \"\",\n \"secret\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"organization_id\": \"\",\n \"description\": \"\",\n \"secret\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n }\n]", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-4d604a3b-00f2-414b-8816-a2470f05a677" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-6b6fcf42-959d-4b0a-a1ec-1ca9e7b40bf0" }, { "name": "Create a secret", "id": "553230cd-1651-47dc-8a92-7560977f2a15", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"organization_id\": \"\",\n \"description\": \"\",\n \"secret\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/secrets", "host": [ "{{baseUrl}}" ], "path": [ "secrets" ] }, "description": "Create a new secret" }, "response": [ { "id": "03e611a9-6b5b-436e-87c6-c13e27385d95", "name": "The created Secret object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"organization_id\": \"\",\n \"description\": \"\",\n \"secret\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/secrets", "host": [ "{{baseUrl}}" ], "path": [ "secrets" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"organization_id\": \"\",\n \"description\": \"\",\n \"secret\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-03e611a9-6b5b-436e-87c6-c13e27385d95" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-553230cd-1651-47dc-8a92-7560977f2a15" } ], "id": "ffd6d3fd-68cc-43c0-a687-3ca293ecca38", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-ffd6d3fd-68cc-43c0-a687-3ca293ecca38" }, { "name": "platform-integrations", "item": [ { "name": "sessions", "item": [ { "name": "Mint JWT token for custodial platform integration", "id": "43c21dd8-9425-435f-852d-56a067dcda07", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) Shopify session token (JWT) from App Bridge", "key": "X-Shopify-Authorization", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/platform-integrations/sessions", "host": [ "{{baseUrl}}" ], "path": [ "platform-integrations", "sessions" ] }, "description": "Authenticates using platform-specific session token (e.g., Shopify Session Token) and returns a session response with a short-lived JWT token for accessing Didomi Admin API resources. The token is scoped to the integration's role (external-integrations-notices-manager) and organization. Only custodial integrations are supported." }, "response": [ { "id": "f2620c02-8332-4a73-b4fb-058040c41abf", "name": "JWT token successfully minted", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) Shopify session token (JWT) from App Bridge", "key": "X-Shopify-Authorization", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/platform-integrations/sessions", "host": [ "{{baseUrl}}" ], "path": [ "platform-integrations", "sessions" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"key\": \"\",\n \"access_token\": \"\",\n \"platform_integration_id\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-f2620c02-8332-4a73-b4fb-058040c41abf" }, { "id": "a085e259-c11e-4874-ab7f-c2f20ca96faf", "name": "Invalid request or integration configuration error", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) Shopify session token (JWT) from App Bridge", "key": "X-Shopify-Authorization", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/platform-integrations/sessions", "host": [ "{{baseUrl}}" ], "path": [ "platform-integrations", "sessions" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-a085e259-c11e-4874-ab7f-c2f20ca96faf" }, { "id": "8c041962-915b-40a7-b438-adfb06a3003d", "name": "Platform authentication failed or missing", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) Shopify session token (JWT) from App Bridge", "key": "X-Shopify-Authorization", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/platform-integrations/sessions", "host": [ "{{baseUrl}}" ], "path": [ "platform-integrations", "sessions" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-8c041962-915b-40a7-b438-adfb06a3003d" }, { "id": "e3c791b2-b1b1-456d-a10b-73c4ec07fe59", "name": "Platform integration not found", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) Shopify session token (JWT) from App Bridge", "key": "X-Shopify-Authorization", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/platform-integrations/sessions", "host": [ "{{baseUrl}}" ], "path": [ "platform-integrations", "sessions" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-e3c791b2-b1b1-456d-a10b-73c4ec07fe59" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-43c21dd8-9425-435f-852d-56a067dcda07" } ], "id": "be2e03c7-0b90-4717-b23e-4584893ba44d", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-be2e03c7-0b90-4717-b23e-4584893ba44d" } ], "id": "cb6184c7-1a96-475f-9bc9-5c8fbfce2604", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-cb6184c7-1a96-475f-9bc9-5c8fbfce2604" }, { "name": "cookies", "item": [ { "name": "{id}", "item": [ { "name": "Retrieve a cookie", "id": "6188fb41-d0fb-4263-9854-94495b0a5a67", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/cookies/:id", "host": [ "{{baseUrl}}" ], "path": [ "cookies", ":id" ], "variable": [ { "id": "b6e94e51-4530-40cc-924c-0043b38425df", "key": "id", "value": "", "description": "(Required) The ID of the cookie to retrieve" } ] }, "description": "Returns a single cookie set by a property" }, "response": [ { "id": "a5564add-2595-4df6-8f63-4ffd3dc89652", "name": "A Cookie object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/cookies/:id", "host": [ "{{baseUrl}}" ], "path": [ "cookies", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"taxonomy_id\": \"\",\n \"property_id\": \"\",\n \"domain\": \"\",\n \"lifetime\": \"\",\n \"status\": \"\",\n \"vendor_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-a5564add-2595-4df6-8f63-4ffd3dc89652" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-6188fb41-d0fb-4263-9854-94495b0a5a67" }, { "name": "Update a cookie", "id": "cd7ca262-a1a3-4236-a21d-2b8ecbc206c5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"taxonomy_id\": \"\",\n \"property_id\": \"\",\n \"domain\": \"\",\n \"lifetime\": \"\",\n \"status\": \"\",\n \"vendor_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/cookies/:id", "host": [ "{{baseUrl}}" ], "path": [ "cookies", ":id" ], "variable": [ { "id": "95f66529-be81-444e-a0e8-0085adeb49e0", "key": "id", "value": "", "description": "(Required) The ID of the cookie to update" } ] }, "description": "Update an existing cookie set by a property and replace all its properties" }, "response": [ { "id": "7a0947a9-1575-4bd5-a503-efb95de7af29", "name": "The updated Cookie object", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"taxonomy_id\": \"\",\n \"property_id\": \"\",\n \"domain\": \"\",\n \"lifetime\": \"\",\n \"status\": \"\",\n \"vendor_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/cookies/:id", "host": [ "{{baseUrl}}" ], "path": [ "cookies", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"taxonomy_id\": \"\",\n \"property_id\": \"\",\n \"domain\": \"\",\n \"lifetime\": \"\",\n \"status\": \"\",\n \"vendor_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-7a0947a9-1575-4bd5-a503-efb95de7af29" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-cd7ca262-a1a3-4236-a21d-2b8ecbc206c5" }, { "name": "Patch a cookie", "id": "19dfd45b-322b-483a-b969-22b086f5db89", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"taxonomy_id\": \"\",\n \"property_id\": \"\",\n \"domain\": \"\",\n \"lifetime\": \"\",\n \"status\": \"\",\n \"vendor_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/cookies/:id", "host": [ "{{baseUrl}}" ], "path": [ "cookies", ":id" ], "variable": [ { "id": "c9f79c98-e610-4781-8679-48bdb389bae1", "key": "id", "value": "", "description": "(Required) The ID of the cookie to patch" } ] }, "description": "Partially update a cookie set by a property" }, "response": [ { "id": "a653d4fb-7415-4a59-a8b4-63d675241cbe", "name": "The patched Cookie object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"taxonomy_id\": \"\",\n \"property_id\": \"\",\n \"domain\": \"\",\n \"lifetime\": \"\",\n \"status\": \"\",\n \"vendor_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/cookies/:id", "host": [ "{{baseUrl}}" ], "path": [ "cookies", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"taxonomy_id\": \"\",\n \"property_id\": \"\",\n \"domain\": \"\",\n \"lifetime\": \"\",\n \"status\": \"\",\n \"vendor_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-a653d4fb-7415-4a59-a8b4-63d675241cbe" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-19dfd45b-322b-483a-b969-22b086f5db89" }, { "name": "Delete a cookie", "id": "f9eb3a4f-723e-48c5-8286-4b65d7a11d40", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/cookies/:id", "host": [ "{{baseUrl}}" ], "path": [ "cookies", ":id" ], "variable": [ { "id": "78d2046f-2e29-437d-987e-09f51a338fe1", "key": "id", "value": "", "description": "(Required) The ID of the cookie to delete" } ] }, "description": "Delete an existing cookie" }, "response": [ { "id": "b0846714-baba-44c3-b0a2-4534ba0186ad", "name": "The deleted Cookie object", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/cookies/:id", "host": [ "{{baseUrl}}" ], "path": [ "cookies", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"taxonomy_id\": \"\",\n \"property_id\": \"\",\n \"domain\": \"\",\n \"lifetime\": \"\",\n \"status\": \"\",\n \"vendor_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-b0846714-baba-44c3-b0a2-4534ba0186ad" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-f9eb3a4f-723e-48c5-8286-4b65d7a11d40" } ], "id": "b7101a14-d9ee-4e69-9923-94772d3f8c67", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-b7101a14-d9ee-4e69-9923-94772d3f8c67" }, { "name": "Retrieve a list of cookies", "id": "ac24df58-9bd7-48ae-9b3e-b34579125581", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/cookies?property_id=", "host": [ "{{baseUrl}}" ], "path": [ "cookies" ], "query": [ { "description": "The ID of the property", "key": "property_id", "value": "" } ] }, "description": "Returns a list of cookies set by a property" }, "response": [ { "id": "c51df789-0791-4785-99bb-1f641b36618c", "name": "A list of Cookie objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/cookies?property_id=", "host": [ "{{baseUrl}}" ], "path": [ "cookies" ], "query": [ { "description": "The ID of the property", "key": "property_id", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"taxonomy_id\": \"\",\n \"property_id\": \"\",\n \"domain\": \"\",\n \"lifetime\": \"\",\n \"status\": \"\",\n \"vendor_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"taxonomy_id\": \"\",\n \"property_id\": \"\",\n \"domain\": \"\",\n \"lifetime\": \"\",\n \"status\": \"\",\n \"vendor_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n }\n]", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-c51df789-0791-4785-99bb-1f641b36618c" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-ac24df58-9bd7-48ae-9b3e-b34579125581" }, { "name": "Create a cookie", "id": "e27ef481-d932-4ca4-ad3e-9bf6b9919646", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"taxonomy_id\": \"\",\n \"property_id\": \"\",\n \"domain\": \"\",\n \"lifetime\": \"\",\n \"status\": \"\",\n \"vendor_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/cookies", "host": [ "{{baseUrl}}" ], "path": [ "cookies" ] }, "description": "Create a new cookie for a property" }, "response": [ { "id": "8549db8b-aa0f-4707-8d36-f4a8bd07dab0", "name": "The created Cookie object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"taxonomy_id\": \"\",\n \"property_id\": \"\",\n \"domain\": \"\",\n \"lifetime\": \"\",\n \"status\": \"\",\n \"vendor_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/cookies", "host": [ "{{baseUrl}}" ], "path": [ "cookies" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"taxonomy_id\": \"\",\n \"property_id\": \"\",\n \"domain\": \"\",\n \"lifetime\": \"\",\n \"status\": \"\",\n \"vendor_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-8549db8b-aa0f-4707-8d36-f4a8bd07dab0" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-e27ef481-d932-4ca4-ad3e-9bf6b9919646" } ], "id": "b05bdd60-075d-47be-998b-6a18d98446b1", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-b05bdd60-075d-47be-998b-6a18d98446b1" }, { "name": "languages", "item": [ { "name": "Retrieve list of available languages/locales", "id": "af34e41f-f74f-4f45-913b-631376941df0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/languages", "host": [ "{{baseUrl}}" ], "path": [ "languages" ] }, "description": "Returns list of available languages/locales" }, "response": [ { "id": "1b03cac6-913b-4b6e-b583-20b3329d65bb", "name": "List of Languages object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/languages", "host": [ "{{baseUrl}}" ], "path": [ "languages" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"available\": [\n \"\",\n \"\"\n ],\n \"default\": \"\",\n \"defaultCountries\": {}\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-1b03cac6-913b-4b6e-b583-20b3329d65bb" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-af34e41f-f74f-4f45-913b-631376941df0" } ], "id": "9abf8f52-e746-4d04-bcab-affcb5d57851", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-9abf8f52-e746-4d04-bcab-affcb5d57851" }, { "name": "analytics", "item": [ { "name": "dashboards-urls", "item": [ { "name": "Retrieve a list of dashboards with signed URLs", "id": "dc8b6fe3-3198-4c47-a4fb-cb4cfc8bb03d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/analytics/dashboards-urls?category=analytics&organization_id=&$limit=&$skip=&updated_at=&created_at=", "host": [ "{{baseUrl}}" ], "path": [ "analytics", "dashboards-urls" ], "query": [ { "description": "The category of the dashboard. Used for grouping dashboard (per page for example).", "key": "category", "value": "analytics" }, { "description": "The ID of the organization that the user belongs to", "key": "organization_id", "value": "" }, { "description": "Number of max results to return", "key": "$limit", "value": "" }, { "description": "Number of results to skip", "key": "$skip", "value": "" }, { "description": "Object representing sorting options. Accepts properties to sort as keys and -1 or 1 for sort direction", "key": "updated_at", "value": "" }, { "description": "Object representing sorting options. Accepts properties to sort as keys and -1 or 1 for sort direction", "key": "created_at", "value": "" } ] }, "description": "Returns a list of all dashboards with signed URLs" }, "response": [ { "id": "11f689fa-ee76-448c-9971-15d51bf28c0c", "name": "200 response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/analytics/dashboards-urls?category=analytics&organization_id=&$limit=&$skip=&updated_at=&created_at=", "host": [ "{{baseUrl}}" ], "path": [ "analytics", "dashboards-urls" ], "query": [ { "description": "The category of the dashboard. Used for grouping dashboard (per page for example).", "key": "category", "value": "analytics" }, { "description": "The ID of the organization that the user belongs to", "key": "organization_id", "value": "" }, { "description": "Number of max results to return", "key": "$limit", "value": "" }, { "description": "Number of results to skip", "key": "$skip", "value": "" }, { "description": "Object representing sorting options. Accepts properties to sort as keys and -1 or 1 for sort direction", "key": "updated_at", "value": "" }, { "description": "Object representing sorting options. Accepts properties to sort as keys and -1 or 1 for sort direction", "key": "created_at", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"total\": \"\",\n \"limit\": \"\",\n \"skip\": \"\",\n \"data\": [\n {\n \"id\": \"\",\n \"url\": \"\",\n \"type\": \"redash\",\n \"aggregation_period\": \"hourly\",\n \"product\": \"integration\",\n \"name\": \"\",\n \"order\": \"\",\n \"category\": \"analytics\",\n \"description\": \"\",\n \"illustration_ref\": \"\"\n },\n {\n \"id\": \"\",\n \"url\": \"\",\n \"type\": \"redash\",\n \"aggregation_period\": \"hourly\",\n \"product\": \"cmp\",\n \"name\": \"\",\n \"order\": \"\",\n \"category\": \"analytics\",\n \"description\": \"\",\n \"illustration_ref\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-11f689fa-ee76-448c-9971-15d51bf28c0c" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-dc8b6fe3-3198-4c47-a4fb-cb4cfc8bb03d" } ], "id": "069153f1-6330-426f-9dbd-a43b607eca15", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-069153f1-6330-426f-9dbd-a43b607eca15" } ], "id": "273e5564-8b99-4256-bbce-3a5a2e663ff4", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-273e5564-8b99-4256-bbce-3a5a2e663ff4" }, { "name": "organizations", "item": [ { "name": "{id}", "item": [ { "name": "Retrieve an organization", "id": "be47fbff-c996-4cc8-b947-958392e0af8e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/organizations/:id", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":id" ], "variable": [ { "id": "6e7dda8d-8780-4520-9fbe-ae80f69aa596", "key": "id", "value": "", "description": "(Required) The ID of the organization to retrieve" } ] }, "description": "Returns a single organization with the given ID" }, "response": [ { "id": "669cdd18-d781-4e57-8f70-21d2dfb70347", "name": "An Organization object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/organizations/:id", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"website\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"industry_id\": \"\",\n \"analytics_url\": \"\",\n \"public_api_key\": \"\",\n \"version\": \"\",\n \"validate_purpose_id\": \"\",\n \"disable_preferences_in_consents\": \"\",\n \"auth_enabled\": \"\",\n \"auth_allow_user_creation\": \"\",\n \"auth_message_priority\": [\n \"\",\n \"\"\n ],\n \"allow_tcf_with_custom_text\": \"\",\n \"self_register\": \"\",\n \"organization_group_id\": \"\",\n \"organization_group_name\": \"\",\n \"iab_tcf_cmp_id\": \"\",\n \"allow_chat_support\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-669cdd18-d781-4e57-8f70-21d2dfb70347" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-be47fbff-c996-4cc8-b947-958392e0af8e" }, { "name": "Update an organization", "id": "10506362-5605-49aa-97d3-e5a331889480", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"website\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"industry_id\": \"\",\n \"analytics_url\": \"\",\n \"public_api_key\": \"\",\n \"version\": \"\",\n \"validate_purpose_id\": \"\",\n \"disable_preferences_in_consents\": \"\",\n \"auth_enabled\": \"\",\n \"auth_allow_user_creation\": \"\",\n \"auth_message_priority\": [\n \"\",\n \"\"\n ],\n \"allow_tcf_with_custom_text\": \"\",\n \"self_register\": \"\",\n \"organization_group_id\": \"\",\n \"organization_group_name\": \"\",\n \"iab_tcf_cmp_id\": \"\",\n \"allow_chat_support\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/organizations/:id", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":id" ], "variable": [ { "id": "fa367b76-058f-4aa2-a62f-ed1f0e1d6c35", "key": "id", "value": "", "description": "(Required) The ID of the organization to update" } ] }, "description": "Update an existing organization and replace all its properties" }, "response": [ { "id": "3db1163b-6695-4cd8-8f75-b01c955292c9", "name": "The updated Organization object", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"website\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"industry_id\": \"\",\n \"analytics_url\": \"\",\n \"public_api_key\": \"\",\n \"version\": \"\",\n \"validate_purpose_id\": \"\",\n \"disable_preferences_in_consents\": \"\",\n \"auth_enabled\": \"\",\n \"auth_allow_user_creation\": \"\",\n \"auth_message_priority\": [\n \"\",\n \"\"\n ],\n \"allow_tcf_with_custom_text\": \"\",\n \"self_register\": \"\",\n \"organization_group_id\": \"\",\n \"organization_group_name\": \"\",\n \"iab_tcf_cmp_id\": \"\",\n \"allow_chat_support\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/organizations/:id", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"website\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"industry_id\": \"\",\n \"analytics_url\": \"\",\n \"public_api_key\": \"\",\n \"version\": \"\",\n \"validate_purpose_id\": \"\",\n \"disable_preferences_in_consents\": \"\",\n \"auth_enabled\": \"\",\n \"auth_allow_user_creation\": \"\",\n \"auth_message_priority\": [\n \"\",\n \"\"\n ],\n \"allow_tcf_with_custom_text\": \"\",\n \"self_register\": \"\",\n \"organization_group_id\": \"\",\n \"organization_group_name\": \"\",\n \"iab_tcf_cmp_id\": \"\",\n \"allow_chat_support\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-3db1163b-6695-4cd8-8f75-b01c955292c9" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-10506362-5605-49aa-97d3-e5a331889480" }, { "name": "Patch an organization", "id": "91e55a97-d82a-4945-8a21-3f4225ea2eb1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"website\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"industry_id\": \"\",\n \"analytics_url\": \"\",\n \"public_api_key\": \"\",\n \"version\": \"\",\n \"validate_purpose_id\": \"\",\n \"disable_preferences_in_consents\": \"\",\n \"auth_enabled\": \"\",\n \"auth_allow_user_creation\": \"\",\n \"auth_message_priority\": [\n \"\",\n \"\"\n ],\n \"allow_tcf_with_custom_text\": \"\",\n \"self_register\": \"\",\n \"organization_group_id\": \"\",\n \"organization_group_name\": \"\",\n \"iab_tcf_cmp_id\": \"\",\n \"allow_chat_support\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/organizations/:id", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":id" ], "variable": [ { "id": "553e17e6-02c7-4cc3-bfaa-171f0e51362d", "key": "id", "value": "", "description": "(Required) The ID of the organization to patch" } ] }, "description": "Partially update an organization" }, "response": [ { "id": "bb8fa15e-89b0-4357-bd8a-08509f7676ec", "name": "The patched Organization object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"website\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"industry_id\": \"\",\n \"analytics_url\": \"\",\n \"public_api_key\": \"\",\n \"version\": \"\",\n \"validate_purpose_id\": \"\",\n \"disable_preferences_in_consents\": \"\",\n \"auth_enabled\": \"\",\n \"auth_allow_user_creation\": \"\",\n \"auth_message_priority\": [\n \"\",\n \"\"\n ],\n \"allow_tcf_with_custom_text\": \"\",\n \"self_register\": \"\",\n \"organization_group_id\": \"\",\n \"organization_group_name\": \"\",\n \"iab_tcf_cmp_id\": \"\",\n \"allow_chat_support\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/organizations/:id", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"website\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"industry_id\": \"\",\n \"analytics_url\": \"\",\n \"public_api_key\": \"\",\n \"version\": \"\",\n \"validate_purpose_id\": \"\",\n \"disable_preferences_in_consents\": \"\",\n \"auth_enabled\": \"\",\n \"auth_allow_user_creation\": \"\",\n \"auth_message_priority\": [\n \"\",\n \"\"\n ],\n \"allow_tcf_with_custom_text\": \"\",\n \"self_register\": \"\",\n \"organization_group_id\": \"\",\n \"organization_group_name\": \"\",\n \"iab_tcf_cmp_id\": \"\",\n \"allow_chat_support\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-bb8fa15e-89b0-4357-bd8a-08509f7676ec" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-91e55a97-d82a-4945-8a21-3f4225ea2eb1" }, { "name": "Delete an organization", "id": "268e8cd0-233f-46bd-823f-2b4a5d425b0b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/organizations/:id", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":id" ], "variable": [ { "id": "185f7b1b-9e30-43cb-8492-d0f2e3675d45", "key": "id", "value": "", "description": "(Required) The ID of the organization to delete" } ] }, "description": "Delete an existing organization" }, "response": [ { "id": "d454a912-0050-453b-8875-0e227a36fd11", "name": "The deleted Organization object", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/organizations/:id", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"website\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"industry_id\": \"\",\n \"analytics_url\": \"\",\n \"public_api_key\": \"\",\n \"version\": \"\",\n \"validate_purpose_id\": \"\",\n \"disable_preferences_in_consents\": \"\",\n \"auth_enabled\": \"\",\n \"auth_allow_user_creation\": \"\",\n \"auth_message_priority\": [\n \"\",\n \"\"\n ],\n \"allow_tcf_with_custom_text\": \"\",\n \"self_register\": \"\",\n \"organization_group_id\": \"\",\n \"organization_group_name\": \"\",\n \"iab_tcf_cmp_id\": \"\",\n \"allow_chat_support\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-d454a912-0050-453b-8875-0e227a36fd11" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-268e8cd0-233f-46bd-823f-2b4a5d425b0b" } ], "id": "6824ad54-cee5-456f-aee5-47be04008e6e", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-6824ad54-cee5-456f-aee5-47be04008e6e" }, { "name": "Retrieve a list of organizations", "id": "bc4bfddf-7068-4fdc-b71f-6cee812bffd7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/organizations?$limit=&$skip=&id=&name=&website=&created_at=&updated_at=&industry_id=&analytics_url=&public_api_key=&version=&validate_purpose_id=&disable_preferences_in_consents=&auth_enabled=&auth_allow_user_creation=&auth_message_priority=,&allow_tcf_with_custom_text=&self_register=&organization_group_id=&organization_group_name=&iab_tcf_cmp_id=&allow_chat_support=", "host": [ "{{baseUrl}}" ], "path": [ "organizations" ], "query": [ { "description": "Number of results to return", "key": "$limit", "value": "" }, { "description": "Number of results to skip", "key": "$skip", "value": "" }, { "description": "Query parameters to filter", "key": "id", "value": "" }, { "description": "Query parameters to filter", "key": "name", "value": "" }, { "description": "Query parameters to filter", "key": "website", "value": "" }, { "description": "Query parameters to filter", "key": "created_at", "value": "" }, { "description": "Query parameters to filter", "key": "updated_at", "value": "" }, { "description": "Query parameters to filter", "key": "industry_id", "value": "" }, { "description": "Query parameters to filter", "key": "analytics_url", "value": "" }, { "description": "Query parameters to filter", "key": "public_api_key", "value": "" }, { "description": "Query parameters to filter", "key": "version", "value": "" }, { "description": "Query parameters to filter", "key": "validate_purpose_id", "value": "" }, { "description": "Query parameters to filter", "key": "disable_preferences_in_consents", "value": "" }, { "description": "Query parameters to filter", "key": "auth_enabled", "value": "" }, { "description": "Query parameters to filter", "key": "auth_allow_user_creation", "value": "" }, { "description": "Query parameters to filter", "key": "auth_message_priority", "value": "," }, { "description": "Query parameters to filter", "key": "allow_tcf_with_custom_text", "value": "" }, { "description": "Query parameters to filter", "key": "self_register", "value": "" }, { "description": "Query parameters to filter", "key": "organization_group_id", "value": "" }, { "description": "Query parameters to filter", "key": "organization_group_name", "value": "" }, { "description": "Query parameters to filter", "key": "iab_tcf_cmp_id", "value": "" }, { "description": "Query parameters to filter", "key": "allow_chat_support", "value": "" } ] }, "description": "Returns a list of all organizations the user belongs to" }, "response": [ { "id": "653c629c-3e51-4713-99e6-4328cc367147", "name": "A list of Organization objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/organizations?$limit=&$skip=&id=&name=&website=&created_at=&updated_at=&industry_id=&analytics_url=&public_api_key=&version=&validate_purpose_id=&disable_preferences_in_consents=&auth_enabled=&auth_allow_user_creation=&auth_message_priority=,&allow_tcf_with_custom_text=&self_register=&organization_group_id=&organization_group_name=&iab_tcf_cmp_id=&allow_chat_support=", "host": [ "{{baseUrl}}" ], "path": [ "organizations" ], "query": [ { "description": "Number of results to return", "key": "$limit", "value": "" }, { "description": "Number of results to skip", "key": "$skip", "value": "" }, { "description": "Query parameters to filter", "key": "id", "value": "" }, { "description": "Query parameters to filter", "key": "name", "value": "" }, { "description": "Query parameters to filter", "key": "website", "value": "" }, { "description": "Query parameters to filter", "key": "created_at", "value": "" }, { "description": "Query parameters to filter", "key": "updated_at", "value": "" }, { "description": "Query parameters to filter", "key": "industry_id", "value": "" }, { "description": "Query parameters to filter", "key": "analytics_url", "value": "" }, { "description": "Query parameters to filter", "key": "public_api_key", "value": "" }, { "description": "Query parameters to filter", "key": "version", "value": "" }, { "description": "Query parameters to filter", "key": "validate_purpose_id", "value": "" }, { "description": "Query parameters to filter", "key": "disable_preferences_in_consents", "value": "" }, { "description": "Query parameters to filter", "key": "auth_enabled", "value": "" }, { "description": "Query parameters to filter", "key": "auth_allow_user_creation", "value": "" }, { "description": "Query parameters to filter", "key": "auth_message_priority", "value": "," }, { "description": "Query parameters to filter", "key": "allow_tcf_with_custom_text", "value": "" }, { "description": "Query parameters to filter", "key": "self_register", "value": "" }, { "description": "Query parameters to filter", "key": "organization_group_id", "value": "" }, { "description": "Query parameters to filter", "key": "organization_group_name", "value": "" }, { "description": "Query parameters to filter", "key": "iab_tcf_cmp_id", "value": "" }, { "description": "Query parameters to filter", "key": "allow_chat_support", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"website\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"industry_id\": \"\",\n \"analytics_url\": \"\",\n \"public_api_key\": \"\",\n \"version\": \"\",\n \"validate_purpose_id\": \"\",\n \"disable_preferences_in_consents\": \"\",\n \"auth_enabled\": \"\",\n \"auth_allow_user_creation\": \"\",\n \"auth_message_priority\": [\n \"\",\n \"\"\n ],\n \"allow_tcf_with_custom_text\": \"\",\n \"self_register\": \"\",\n \"organization_group_id\": \"\",\n \"organization_group_name\": \"\",\n \"iab_tcf_cmp_id\": \"\",\n \"allow_chat_support\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"website\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"industry_id\": \"\",\n \"analytics_url\": \"\",\n \"public_api_key\": \"\",\n \"version\": \"\",\n \"validate_purpose_id\": \"\",\n \"disable_preferences_in_consents\": \"\",\n \"auth_enabled\": \"\",\n \"auth_allow_user_creation\": \"\",\n \"auth_message_priority\": [\n \"\",\n \"\"\n ],\n \"allow_tcf_with_custom_text\": \"\",\n \"self_register\": \"\",\n \"organization_group_id\": \"\",\n \"organization_group_name\": \"\",\n \"iab_tcf_cmp_id\": \"\",\n \"allow_chat_support\": \"\"\n }\n]", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-653c629c-3e51-4713-99e6-4328cc367147" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-bc4bfddf-7068-4fdc-b71f-6cee812bffd7" }, { "name": "Create an organization", "id": "0f4fa418-ab82-4281-9aa1-31841408eec4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"website\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"industry_id\": \"\",\n \"analytics_url\": \"\",\n \"public_api_key\": \"\",\n \"version\": \"\",\n \"validate_purpose_id\": \"\",\n \"disable_preferences_in_consents\": \"\",\n \"auth_enabled\": \"\",\n \"auth_allow_user_creation\": \"\",\n \"auth_message_priority\": [\n \"\",\n \"\"\n ],\n \"allow_tcf_with_custom_text\": \"\",\n \"self_register\": \"\",\n \"organization_group_id\": \"\",\n \"organization_group_name\": \"\",\n \"iab_tcf_cmp_id\": \"\",\n \"allow_chat_support\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/organizations", "host": [ "{{baseUrl}}" ], "path": [ "organizations" ] }, "description": "Create a new organization" }, "response": [ { "id": "f27d771b-85c5-4b52-87f1-1de4bfe0293e", "name": "The created Organization object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"website\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"industry_id\": \"\",\n \"analytics_url\": \"\",\n \"public_api_key\": \"\",\n \"version\": \"\",\n \"validate_purpose_id\": \"\",\n \"disable_preferences_in_consents\": \"\",\n \"auth_enabled\": \"\",\n \"auth_allow_user_creation\": \"\",\n \"auth_message_priority\": [\n \"\",\n \"\"\n ],\n \"allow_tcf_with_custom_text\": \"\",\n \"self_register\": \"\",\n \"organization_group_id\": \"\",\n \"organization_group_name\": \"\",\n \"iab_tcf_cmp_id\": \"\",\n \"allow_chat_support\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/organizations", "host": [ "{{baseUrl}}" ], "path": [ "organizations" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"website\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"industry_id\": \"\",\n \"analytics_url\": \"\",\n \"public_api_key\": \"\",\n \"version\": \"\",\n \"validate_purpose_id\": \"\",\n \"disable_preferences_in_consents\": \"\",\n \"auth_enabled\": \"\",\n \"auth_allow_user_creation\": \"\",\n \"auth_message_priority\": [\n \"\",\n \"\"\n ],\n \"allow_tcf_with_custom_text\": \"\",\n \"self_register\": \"\",\n \"organization_group_id\": \"\",\n \"organization_group_name\": \"\",\n \"iab_tcf_cmp_id\": \"\",\n \"allow_chat_support\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-f27d771b-85c5-4b52-87f1-1de4bfe0293e" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-0f4fa418-ab82-4281-9aa1-31841408eec4" } ], "id": "c8d7d65b-862e-4b71-995d-a1b471e32ccb", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-c8d7d65b-862e-4b71-995d-a1b471e32ccb" }, { "name": "members", "item": [ { "name": "{id}", "item": [ { "name": "Retrieve a member", "id": "0d208737-2ba3-4cfb-8f1d-0e7c5a0f6e44", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/members/:id", "host": [ "{{baseUrl}}" ], "path": [ "members", ":id" ], "variable": [ { "id": "4cab9a35-b0b2-4ca7-8ac6-cd5f11ab4f93", "key": "id", "value": "", "description": "(Required) The ID of the member to retrieve" } ] }, "description": "Returns a single member of an organization" }, "response": [ { "id": "98595ad2-3ba4-43df-9238-852bf88fe517", "name": "A Member object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/members/:id", "host": [ "{{baseUrl}}" ], "path": [ "members", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"organization_id\": \"\",\n \"user_id\": \"\",\n \"role_id\": \"\",\n \"authentication_method\": \"email_password\",\n \"saml_active\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-98595ad2-3ba4-43df-9238-852bf88fe517" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-0d208737-2ba3-4cfb-8f1d-0e7c5a0f6e44" }, { "name": "Updates the resource identified by id using data.", "id": "67e97285-ae06-4141-9be2-3a0841026a09", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"organization_id\": \"\",\n \"user_id\": \"\",\n \"role_id\": \"\",\n \"authentication_method\": \"email_password\",\n \"saml_active\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/members/:id", "host": [ "{{baseUrl}}" ], "path": [ "members", ":id" ], "variable": [ { "id": "63717561-dec2-4aca-8f54-57c97399773d", "key": "id", "value": "", "description": "(Required) ID of members to update" } ] }, "description": "Updates the resource identified by id using data." }, "response": [ { "id": "1060cfcc-9c21-44ed-8b3b-193c90323b54", "name": "success", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"organization_id\": \"\",\n \"user_id\": \"\",\n \"role_id\": \"\",\n \"authentication_method\": \"email_password\",\n \"saml_active\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/members/:id", "host": [ "{{baseUrl}}" ], "path": [ "members", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"organization_id\": \"\",\n \"user_id\": \"\",\n \"role_id\": \"\",\n \"authentication_method\": \"email_password\",\n \"saml_active\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-1060cfcc-9c21-44ed-8b3b-193c90323b54" }, { "id": "82a0a35e-564c-437f-94be-f993a43a8755", "name": "not authenticated", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"organization_id\": \"\",\n \"user_id\": \"\",\n \"role_id\": \"\",\n \"authentication_method\": \"email_password\",\n \"saml_active\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/members/:id", "host": [ "{{baseUrl}}" ], "path": [ "members", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-82a0a35e-564c-437f-94be-f993a43a8755" }, { "id": "559e0926-48cc-49e0-a522-5f3c409484fb", "name": "not found", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"organization_id\": \"\",\n \"user_id\": \"\",\n \"role_id\": \"\",\n \"authentication_method\": \"email_password\",\n \"saml_active\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/members/:id", "host": [ "{{baseUrl}}" ], "path": [ "members", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-559e0926-48cc-49e0-a522-5f3c409484fb" }, { "id": "252c3015-ca50-4b12-adf5-62117e2599b0", "name": "general error", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"organization_id\": \"\",\n \"user_id\": \"\",\n \"role_id\": \"\",\n \"authentication_method\": \"email_password\",\n \"saml_active\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/members/:id", "host": [ "{{baseUrl}}" ], "path": [ "members", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-252c3015-ca50-4b12-adf5-62117e2599b0" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-67e97285-ae06-4141-9be2-3a0841026a09" }, { "name": "Remove a user from an organization", "id": "60ba72ac-c161-4771-9fa4-b800d1e2b265", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/members/:id", "host": [ "{{baseUrl}}" ], "path": [ "members", ":id" ], "variable": [ { "id": "a0c0609f-7440-45b6-8a31-8381bce7ea5a", "key": "id", "value": "", "description": "(Required) The ID of the member to delete" } ] }, "description": "Delete an existing member of an organization" }, "response": [ { "id": "e1d101d8-8185-4225-bf90-df56bcb4a8d3", "name": "The deleted Member object", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/members/:id", "host": [ "{{baseUrl}}" ], "path": [ "members", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"organization_id\": \"\",\n \"user_id\": \"\",\n \"role_id\": \"\",\n \"authentication_method\": \"email_password\",\n \"saml_active\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-e1d101d8-8185-4225-bf90-df56bcb4a8d3" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-60ba72ac-c161-4771-9fa4-b800d1e2b265" } ], "id": "16ae80db-ad44-4427-b3cc-ebcdff575d90", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-16ae80db-ad44-4427-b3cc-ebcdff575d90" }, { "name": "Retrieve a list of members of an organization", "id": "1e7081cc-47e2-4029-8a0d-a04c55f2f963", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/members?organization_id=", "host": [ "{{baseUrl}}" ], "path": [ "members" ], "query": [ { "description": "(Required) The ID of the organization", "key": "organization_id", "value": "" } ] }, "description": "Returns a list of members of an organization" }, "response": [ { "id": "60208c6c-cb42-4c70-a8dc-bc2e889d243b", "name": "A list of Member objects", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/members?organization_id=", "host": [ "{{baseUrl}}" ], "path": [ "members" ], "query": [ { "description": "(Required) The ID of the organization", "key": "organization_id", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-60208c6c-cb42-4c70-a8dc-bc2e889d243b" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-1e7081cc-47e2-4029-8a0d-a04c55f2f963" }, { "name": "Add a user to an organization", "id": "be339d73-8bbb-4ce3-9778-a1725c655bc0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"organization_id\": \"\",\n \"user_id\": \"\",\n \"role_id\": \"\",\n \"authentication_method\": \"email_password\",\n \"saml_active\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/members", "host": [ "{{baseUrl}}" ], "path": [ "members" ] }, "description": "Add a new member to an organization. If the user is new it will send an email with a password reset link. Finally it will send an added to organization notification" }, "response": [ { "id": "27d52a3a-7a35-482e-9cf0-500ce379eb74", "name": "The created Member object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"organization_id\": \"\",\n \"user_id\": \"\",\n \"role_id\": \"\",\n \"authentication_method\": \"email_password\",\n \"saml_active\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/members", "host": [ "{{baseUrl}}" ], "path": [ "members" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"organization_id\": \"\",\n \"user_id\": \"\",\n \"role_id\": \"\",\n \"authentication_method\": \"email_password\",\n \"saml_active\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-27d52a3a-7a35-482e-9cf0-500ce379eb74" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-be339d73-8bbb-4ce3-9778-a1725c655bc0" } ], "id": "6ada9da8-d0dd-46ac-b92d-8204c58366a1", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-6ada9da8-d0dd-46ac-b92d-8204c58366a1" }, { "name": "privacy-centers", "item": [ { "name": "{id}", "item": [ { "name": "Retrieve a privacy center", "id": "52202603-c441-4ab8-9f06-26201cf9ebed", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/privacy-centers/:id", "host": [ "{{baseUrl}}" ], "path": [ "privacy-centers", ":id" ], "variable": [ { "id": "bd1768e7-7b84-4591-adb0-3b547626687e", "key": "id", "value": "", "description": "(Required) The ID of the privacy center to retrieve" } ] }, "description": "Returns a single privacy center with the given ID" }, "response": [ { "id": "8276fbdd-b447-4970-bf36-ce5e596383d5", "name": "A PrivacyCenter object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/privacy-centers/:id", "host": [ "{{baseUrl}}" ], "path": [ "privacy-centers", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"website\": \"\",\n \"custom_domains\": [\n \"\",\n \"\"\n ],\n \"contact\": {\n \"email\": \"\",\n \"schedule\": \"\",\n \"address\": \"\"\n },\n \"customization\": {\n \"logo\": \"\",\n \"colors\": {\n \"primary\": \"\"\n }\n },\n \"legal_name\": \"\",\n \"display_cookies\": \"list\",\n \"privacy_policy\": \"\",\n \"content\": {},\n \"languages\": [\n \"\",\n \"\"\n ],\n \"auth_required\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-8276fbdd-b447-4970-bf36-ce5e596383d5" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-52202603-c441-4ab8-9f06-26201cf9ebed" }, { "name": "Update a privacy center", "id": "9bac8391-e240-44f9-92d2-ef2ffe9444fa", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"website\": \"\",\n \"custom_domains\": [\n \"\",\n \"\"\n ],\n \"contact\": {\n \"email\": \"\",\n \"schedule\": \"\",\n \"address\": \"\"\n },\n \"customization\": {\n \"logo\": \"\",\n \"colors\": {\n \"primary\": \"\"\n }\n },\n \"legal_name\": \"\",\n \"display_cookies\": \"list\",\n \"privacy_policy\": \"\",\n \"content\": {},\n \"languages\": [\n \"\",\n \"\"\n ],\n \"auth_required\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/privacy-centers/:id", "host": [ "{{baseUrl}}" ], "path": [ "privacy-centers", ":id" ], "variable": [ { "id": "a71374df-78ac-4949-b8bc-c37d6b4ba49a", "key": "id", "value": "", "description": "(Required) The ID of the session to update" } ] }, "description": "Update an existing privacy center and replace all its properties" }, "response": [ { "id": "38fcf31c-24fe-4491-bb80-4793801b1bbc", "name": "The updated PrivacyCenter object", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"website\": \"\",\n \"custom_domains\": [\n \"\",\n \"\"\n ],\n \"contact\": {\n \"email\": \"\",\n \"schedule\": \"\",\n \"address\": \"\"\n },\n \"customization\": {\n \"logo\": \"\",\n \"colors\": {\n \"primary\": \"\"\n }\n },\n \"legal_name\": \"\",\n \"display_cookies\": \"list\",\n \"privacy_policy\": \"\",\n \"content\": {},\n \"languages\": [\n \"\",\n \"\"\n ],\n \"auth_required\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/privacy-centers/:id", "host": [ "{{baseUrl}}" ], "path": [ "privacy-centers", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"website\": \"\",\n \"custom_domains\": [\n \"\",\n \"\"\n ],\n \"contact\": {\n \"email\": \"\",\n \"schedule\": \"\",\n \"address\": \"\"\n },\n \"customization\": {\n \"logo\": \"\",\n \"colors\": {\n \"primary\": \"\"\n }\n },\n \"legal_name\": \"\",\n \"display_cookies\": \"list\",\n \"privacy_policy\": \"\",\n \"content\": {},\n \"languages\": [\n \"\",\n \"\"\n ],\n \"auth_required\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-38fcf31c-24fe-4491-bb80-4793801b1bbc" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-9bac8391-e240-44f9-92d2-ef2ffe9444fa" }, { "name": "Patch a privacy center", "id": "7843108b-f85a-429a-acaa-a0deb4c5dd8c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"website\": \"\",\n \"custom_domains\": [\n \"\",\n \"\"\n ],\n \"contact\": {\n \"email\": \"\",\n \"schedule\": \"\",\n \"address\": \"\"\n },\n \"customization\": {\n \"logo\": \"\",\n \"colors\": {\n \"primary\": \"\"\n }\n },\n \"legal_name\": \"\",\n \"display_cookies\": \"list\",\n \"privacy_policy\": \"\",\n \"content\": {},\n \"languages\": [\n \"\",\n \"\"\n ],\n \"auth_required\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/privacy-centers/:id", "host": [ "{{baseUrl}}" ], "path": [ "privacy-centers", ":id" ], "variable": [ { "id": "9761221a-0583-47df-ba07-5d4a82696248", "key": "id", "value": "", "description": "(Required) The ID of the session to patch" } ] }, "description": "Partially update a privacy center" }, "response": [ { "id": "035d8697-5d54-421e-a4cc-19c16a8860a0", "name": "The patched PrivacyCenter object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"website\": \"\",\n \"custom_domains\": [\n \"\",\n \"\"\n ],\n \"contact\": {\n \"email\": \"\",\n \"schedule\": \"\",\n \"address\": \"\"\n },\n \"customization\": {\n \"logo\": \"\",\n \"colors\": {\n \"primary\": \"\"\n }\n },\n \"legal_name\": \"\",\n \"display_cookies\": \"list\",\n \"privacy_policy\": \"\",\n \"content\": {},\n \"languages\": [\n \"\",\n \"\"\n ],\n \"auth_required\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/privacy-centers/:id", "host": [ "{{baseUrl}}" ], "path": [ "privacy-centers", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"website\": \"\",\n \"custom_domains\": [\n \"\",\n \"\"\n ],\n \"contact\": {\n \"email\": \"\",\n \"schedule\": \"\",\n \"address\": \"\"\n },\n \"customization\": {\n \"logo\": \"\",\n \"colors\": {\n \"primary\": \"\"\n }\n },\n \"legal_name\": \"\",\n \"display_cookies\": \"list\",\n \"privacy_policy\": \"\",\n \"content\": {},\n \"languages\": [\n \"\",\n \"\"\n ],\n \"auth_required\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-035d8697-5d54-421e-a4cc-19c16a8860a0" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-7843108b-f85a-429a-acaa-a0deb4c5dd8c" }, { "name": "Delete a privacy center", "id": "c3c78b13-3a6f-4377-84ac-6cf3236abe61", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/privacy-centers/:id", "host": [ "{{baseUrl}}" ], "path": [ "privacy-centers", ":id" ], "variable": [ { "id": "ed1a1015-7557-411e-8e3d-9d9d5bb46b8d", "key": "id", "value": "", "description": "(Required) The ID of the privacy center to delete" } ] }, "description": "Delete an existing privacy center" }, "response": [ { "id": "de9254a7-000d-4473-911e-23b3cd5882c2", "name": "The deleted PrivacyCenter object", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/privacy-centers/:id", "host": [ "{{baseUrl}}" ], "path": [ "privacy-centers", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"website\": \"\",\n \"custom_domains\": [\n \"\",\n \"\"\n ],\n \"contact\": {\n \"email\": \"\",\n \"schedule\": \"\",\n \"address\": \"\"\n },\n \"customization\": {\n \"logo\": \"\",\n \"colors\": {\n \"primary\": \"\"\n }\n },\n \"legal_name\": \"\",\n \"display_cookies\": \"list\",\n \"privacy_policy\": \"\",\n \"content\": {},\n \"languages\": [\n \"\",\n \"\"\n ],\n \"auth_required\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-de9254a7-000d-4473-911e-23b3cd5882c2" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-c3c78b13-3a6f-4377-84ac-6cf3236abe61" } ], "id": "e4b7ea32-9edd-4647-acc8-1c50c4920bbd", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-e4b7ea32-9edd-4647-acc8-1c50c4920bbd" }, { "name": "Retrieve a list of privacy centers", "id": "daed4e42-1142-4cb4-b676-79cc595933eb", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/privacy-centers?privacy_center_id=", "host": [ "{{baseUrl}}" ], "path": [ "privacy-centers" ], "query": [ { "description": "The ID of the privacy center", "key": "privacy_center_id", "value": "" } ] }, "description": "Returns a list of all the privacy centers the user has access to" }, "response": [ { "id": "cb03b604-7ffe-4042-b58e-56f0613e2bd4", "name": "A list of PrivacyCenter objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/privacy-centers?privacy_center_id=", "host": [ "{{baseUrl}}" ], "path": [ "privacy-centers" ], "query": [ { "description": "The ID of the privacy center", "key": "privacy_center_id", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"website\": \"\",\n \"custom_domains\": [\n \"\",\n \"\"\n ],\n \"contact\": {\n \"email\": \"\",\n \"schedule\": \"\",\n \"address\": \"\"\n },\n \"customization\": {\n \"logo\": \"\",\n \"colors\": {\n \"primary\": \"\"\n }\n },\n \"legal_name\": \"\",\n \"display_cookies\": \"list\",\n \"privacy_policy\": \"\",\n \"content\": {},\n \"languages\": [\n \"\",\n \"\"\n ],\n \"auth_required\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"website\": \"\",\n \"custom_domains\": [\n \"\",\n \"\"\n ],\n \"contact\": {\n \"email\": \"\",\n \"schedule\": \"\",\n \"address\": \"\"\n },\n \"customization\": {\n \"logo\": \"\",\n \"colors\": {\n \"primary\": \"\"\n }\n },\n \"legal_name\": \"\",\n \"display_cookies\": \"none\",\n \"privacy_policy\": \"\",\n \"content\": {},\n \"languages\": [\n \"\",\n \"\"\n ],\n \"auth_required\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n }\n]", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-cb03b604-7ffe-4042-b58e-56f0613e2bd4" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-daed4e42-1142-4cb4-b676-79cc595933eb" }, { "name": "Create a privacy center", "id": "53a4a50d-bb46-4ce8-a425-169686a04f44", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"website\": \"\",\n \"custom_domains\": [\n \"\",\n \"\"\n ],\n \"contact\": {\n \"email\": \"\",\n \"schedule\": \"\",\n \"address\": \"\"\n },\n \"customization\": {\n \"logo\": \"\",\n \"colors\": {\n \"primary\": \"\"\n }\n },\n \"legal_name\": \"\",\n \"display_cookies\": \"list\",\n \"privacy_policy\": \"\",\n \"content\": {},\n \"languages\": [\n \"\",\n \"\"\n ],\n \"auth_required\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/privacy-centers", "host": [ "{{baseUrl}}" ], "path": [ "privacy-centers" ] }, "description": "Create a new privacy center" }, "response": [ { "id": "56dfbb87-f839-4961-aac5-ac101503613c", "name": "The created PrivacyCenter object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"website\": \"\",\n \"custom_domains\": [\n \"\",\n \"\"\n ],\n \"contact\": {\n \"email\": \"\",\n \"schedule\": \"\",\n \"address\": \"\"\n },\n \"customization\": {\n \"logo\": \"\",\n \"colors\": {\n \"primary\": \"\"\n }\n },\n \"legal_name\": \"\",\n \"display_cookies\": \"list\",\n \"privacy_policy\": \"\",\n \"content\": {},\n \"languages\": [\n \"\",\n \"\"\n ],\n \"auth_required\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/privacy-centers", "host": [ "{{baseUrl}}" ], "path": [ "privacy-centers" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"website\": \"\",\n \"custom_domains\": [\n \"\",\n \"\"\n ],\n \"contact\": {\n \"email\": \"\",\n \"schedule\": \"\",\n \"address\": \"\"\n },\n \"customization\": {\n \"logo\": \"\",\n \"colors\": {\n \"primary\": \"\"\n }\n },\n \"legal_name\": \"\",\n \"display_cookies\": \"list\",\n \"privacy_policy\": \"\",\n \"content\": {},\n \"languages\": [\n \"\",\n \"\"\n ],\n \"auth_required\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-56dfbb87-f839-4961-aac5-ac101503613c" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-53a4a50d-bb46-4ce8-a425-169686a04f44" } ], "id": "8d58a1a7-7c9f-425b-8c51-ba0593aaabc7", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-8d58a1a7-7c9f-425b-8c51-ba0593aaabc7" }, { "name": "vendors", "item": [ { "name": "{id}", "item": [ { "name": "Retrieve a vendor", "id": "f5fad1db-3369-4507-a8ef-e0b50c847699", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/vendors/:id", "host": [ "{{baseUrl}}" ], "path": [ "vendors", ":id" ], "variable": [ { "id": "728266bb-15a6-4081-8fc2-6fbde50130cd", "key": "id", "value": "", "description": "(Required) The ID of the vendor to retrieve" } ] }, "description": "Returns a single vendor used by a property" }, "response": [ { "id": "130a5cd5-58f6-4b0b-96e0-f54448d331fc", "name": "A Vendor object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/vendors/:id", "host": [ "{{baseUrl}}" ], "path": [ "vendors", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"property_id\": \"\",\n \"metadata_id\": \"\",\n \"status\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-130a5cd5-58f6-4b0b-96e0-f54448d331fc" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-f5fad1db-3369-4507-a8ef-e0b50c847699" }, { "name": "Update a vendor", "id": "3eb4c081-0936-4328-892e-e2e42fbd9fa7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"property_id\": \"\",\n \"metadata_id\": \"\",\n \"status\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/vendors/:id", "host": [ "{{baseUrl}}" ], "path": [ "vendors", ":id" ], "variable": [ { "id": "e009e1e4-0d22-4d5d-a225-155db4ea1c89", "key": "id", "value": "", "description": "(Required) The ID of the vendor to update" } ] }, "description": "Update an existing vendor used by a property and replace all its properties" }, "response": [ { "id": "da1e99ae-452b-40c4-812a-834053989ce3", "name": "The updated Vendor object", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"property_id\": \"\",\n \"metadata_id\": \"\",\n \"status\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/vendors/:id", "host": [ "{{baseUrl}}" ], "path": [ "vendors", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"property_id\": \"\",\n \"metadata_id\": \"\",\n \"status\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-da1e99ae-452b-40c4-812a-834053989ce3" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-3eb4c081-0936-4328-892e-e2e42fbd9fa7" }, { "name": "Patch a vendor", "id": "8b1f5ce1-1de8-4d6a-9b0b-ab95bcb8f8f1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"property_id\": \"\",\n \"metadata_id\": \"\",\n \"status\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/vendors/:id", "host": [ "{{baseUrl}}" ], "path": [ "vendors", ":id" ], "variable": [ { "id": "c63a4118-d3e0-4766-be58-8619571c9e19", "key": "id", "value": "", "description": "(Required) The ID of the vendor to patch" } ] }, "description": "Partially update a vendor used by a property" }, "response": [ { "id": "6b32a720-83d9-4fce-8d8c-21ee1a9271b2", "name": "The patched Vendor object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"property_id\": \"\",\n \"metadata_id\": \"\",\n \"status\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/vendors/:id", "host": [ "{{baseUrl}}" ], "path": [ "vendors", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"property_id\": \"\",\n \"metadata_id\": \"\",\n \"status\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-6b32a720-83d9-4fce-8d8c-21ee1a9271b2" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-8b1f5ce1-1de8-4d6a-9b0b-ab95bcb8f8f1" }, { "name": "Delete a vendor", "id": "e11bc23e-370f-487d-a179-a0e57644c87c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/vendors/:id", "host": [ "{{baseUrl}}" ], "path": [ "vendors", ":id" ], "variable": [ { "id": "842925fa-299a-4b63-a9c5-c8900d126f5e", "key": "id", "value": "", "description": "(Required) The ID of the vendor to delete" } ] }, "description": "Delete an existing vendor" }, "response": [ { "id": "4137f1b0-81a8-4bb7-80e2-def747065c2a", "name": "The deleted Vendor object", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/vendors/:id", "host": [ "{{baseUrl}}" ], "path": [ "vendors", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"property_id\": \"\",\n \"metadata_id\": \"\",\n \"status\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-4137f1b0-81a8-4bb7-80e2-def747065c2a" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-e11bc23e-370f-487d-a179-a0e57644c87c" } ], "id": "d30502d8-a7a3-4e1e-9aee-0506ebf063b4", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-d30502d8-a7a3-4e1e-9aee-0506ebf063b4" }, { "name": "Retrieve a list of vendors", "id": "003b9436-1d70-441b-a568-ce71099b40d7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/vendors?property_id=", "host": [ "{{baseUrl}}" ], "path": [ "vendors" ], "query": [ { "description": "The ID of the property", "key": "property_id", "value": "" } ] }, "description": "Returns a list of vendors used by a property" }, "response": [ { "id": "f802b24a-7af2-416b-b40b-9f3f95be1652", "name": "A list of Vendor objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/vendors?property_id=", "host": [ "{{baseUrl}}" ], "path": [ "vendors" ], "query": [ { "description": "The ID of the property", "key": "property_id", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"property_id\": \"\",\n \"metadata_id\": \"\",\n \"status\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n },\n {\n \"id\": \"\",\n \"property_id\": \"\",\n \"metadata_id\": \"\",\n \"status\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n }\n]", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-f802b24a-7af2-416b-b40b-9f3f95be1652" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-003b9436-1d70-441b-a568-ce71099b40d7" }, { "name": "Create a vendor", "id": "b64fd75e-1329-4919-a2c2-bf5e9d3efb41", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"property_id\": \"\",\n \"metadata_id\": \"\",\n \"status\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/vendors", "host": [ "{{baseUrl}}" ], "path": [ "vendors" ] }, "description": "Create a new vendor for a property" }, "response": [ { "id": "fd09b659-3137-4b6e-9c40-53208d2a0ad7", "name": "The created Vendor object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"property_id\": \"\",\n \"metadata_id\": \"\",\n \"status\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/vendors", "host": [ "{{baseUrl}}" ], "path": [ "vendors" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"property_id\": \"\",\n \"metadata_id\": \"\",\n \"status\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-fd09b659-3137-4b6e-9c40-53208d2a0ad7" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-b64fd75e-1329-4919-a2c2-bf5e9d3efb41" } ], "id": "e47186c2-3ff9-41b0-8dc7-1818e27e9e25", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-e47186c2-3ff9-41b0-8dc7-1818e27e9e25" }, { "name": "premium-features", "item": [ { "name": "{id}", "item": [ { "name": "Retrieve a premium-feature", "id": "21edf62a-4d94-4cc6-a7a3-2950aa731fd4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/premium-features/:id", "host": [ "{{baseUrl}}" ], "path": [ "premium-features", ":id" ], "variable": [ { "id": "b701b590-de6b-4a40-97fc-e7cbc97af739", "key": "id", "value": "", "description": "(Required) The ID of the premium feature to retrieve" } ] }, "description": "Returns a single premium feature with the given ID" }, "response": [ { "id": "0831af44-5123-4ff0-8a9f-73a86413fe7b", "name": "A PremiumFeature object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/premium-features/:id", "host": [ "{{baseUrl}}" ], "path": [ "premium-features", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"preference_center\": \"\",\n \"preference_management_platform\": \"\",\n \"propagate_consents_on_sync\": \"\",\n \"consent_management_platform\": \"\",\n \"cross_device\": \"\",\n \"batch_exports\": \"\",\n \"batch_exports_manual_run\": \"\",\n \"batch_exports_analytics\": \"\",\n \"data_residency_russia\": \"\",\n \"integrations\": \"\",\n \"integrations_v2\": \"\",\n \"smart_vendor_list\": \"\",\n \"compliance_report_v2\": \"\",\n \"versions_and_proofs\": \"\",\n \"mass_update\": \"\",\n \"consents_api\": \"\",\n \"store_cmp_consents\": \"\",\n \"store_guest_cmp_consents\": \"\",\n \"sso\": \"\",\n \"version\": \"\",\n \"mailchimp\": \"\",\n \"actito\": \"\",\n \"hubspot\": \"\",\n \"sendinblue\": \"\",\n \"selligent\": \"\",\n \"adobe_campaign_classic\": \"\",\n \"adobe_campaign_standard\": \"\",\n \"webhooks\": \"\",\n \"sf_marketing_cloud\": \"\",\n \"braze\": \"\",\n \"marketo\": \"\",\n \"microsoft_dynamics\": \"\",\n \"microsoft_dynamics_cpc\": \"\",\n \"dotdigital\": \"\",\n \"adobe_experience_cloud\": \"\",\n \"advanced_internal_monitoring\": \"\",\n \"sf_sales_cloud\": \"\",\n \"server_side\": \"\",\n \"acm_static_ip\": \"\",\n \"acm_vendor_templates\": \"\",\n \"acm_data_exports\": \"\",\n \"acm_high_frequency\": \"\",\n \"acm_full_website_scan\": \"\",\n \"web_sdk_versioning\": \"\",\n \"web_sdk_fixed_versioning\": \"\",\n \"privacy_widgets_advanced\": \"\",\n \"cmp_consent_or_pay\": \"\",\n \"cmp_rules_underage\": \"\",\n \"privacy_widgets_versions\": \"\",\n \"dsar_experience\": \"\",\n \"brand_manager\": \"\",\n \"cmp_advanced_widgets\": \"\",\n \"pmp_data_exports\": \"\",\n \"cmp_data_exports\": \"\",\n \"cmp_ctv_widgets\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-0831af44-5123-4ff0-8a9f-73a86413fe7b" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-21edf62a-4d94-4cc6-a7a3-2950aa731fd4" }, { "name": "Update a premium feature", "id": "9a830186-b178-4163-8f20-ad870a311220", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"preference_center\": \"\",\n \"preference_management_platform\": \"\",\n \"propagate_consents_on_sync\": \"\",\n \"consent_management_platform\": \"\",\n \"cross_device\": \"\",\n \"batch_exports\": \"\",\n \"batch_exports_manual_run\": \"\",\n \"batch_exports_analytics\": \"\",\n \"data_residency_russia\": \"\",\n \"integrations\": \"\",\n \"integrations_v2\": \"\",\n \"smart_vendor_list\": \"\",\n \"compliance_report_v2\": \"\",\n \"versions_and_proofs\": \"\",\n \"mass_update\": \"\",\n \"consents_api\": \"\",\n \"store_cmp_consents\": \"\",\n \"store_guest_cmp_consents\": \"\",\n \"sso\": \"\",\n \"version\": \"\",\n \"mailchimp\": \"\",\n \"actito\": \"\",\n \"hubspot\": \"\",\n \"sendinblue\": \"\",\n \"selligent\": \"\",\n \"adobe_campaign_classic\": \"\",\n \"adobe_campaign_standard\": \"\",\n \"webhooks\": \"\",\n \"sf_marketing_cloud\": \"\",\n \"braze\": \"\",\n \"marketo\": \"\",\n \"microsoft_dynamics\": \"\",\n \"microsoft_dynamics_cpc\": \"\",\n \"dotdigital\": \"\",\n \"adobe_experience_cloud\": \"\",\n \"advanced_internal_monitoring\": \"\",\n \"sf_sales_cloud\": \"\",\n \"server_side\": \"\",\n \"acm_static_ip\": \"\",\n \"acm_vendor_templates\": \"\",\n \"acm_data_exports\": \"\",\n \"acm_high_frequency\": \"\",\n \"acm_full_website_scan\": \"\",\n \"web_sdk_versioning\": \"\",\n \"web_sdk_fixed_versioning\": \"\",\n \"privacy_widgets_advanced\": \"\",\n \"cmp_consent_or_pay\": \"\",\n \"cmp_rules_underage\": \"\",\n \"privacy_widgets_versions\": \"\",\n \"dsar_experience\": \"\",\n \"brand_manager\": \"\",\n \"cmp_advanced_widgets\": \"\",\n \"pmp_data_exports\": \"\",\n \"cmp_data_exports\": \"\",\n \"cmp_ctv_widgets\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/premium-features/:id", "host": [ "{{baseUrl}}" ], "path": [ "premium-features", ":id" ], "variable": [ { "id": "4ecba694-a25b-4cbe-a89f-762bf1fbea2f", "key": "id", "value": "", "description": "(Required) The ID of the premium feature to update" } ] }, "description": "Update an existing premium feature" }, "response": [ { "id": "4f56f4dc-686e-4c74-8168-0879efa61fbf", "name": "The updated PremiumFeature object", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"preference_center\": \"\",\n \"preference_management_platform\": \"\",\n \"propagate_consents_on_sync\": \"\",\n \"consent_management_platform\": \"\",\n \"cross_device\": \"\",\n \"batch_exports\": \"\",\n \"batch_exports_manual_run\": \"\",\n \"batch_exports_analytics\": \"\",\n \"data_residency_russia\": \"\",\n \"integrations\": \"\",\n \"integrations_v2\": \"\",\n \"smart_vendor_list\": \"\",\n \"compliance_report_v2\": \"\",\n \"versions_and_proofs\": \"\",\n \"mass_update\": \"\",\n \"consents_api\": \"\",\n \"store_cmp_consents\": \"\",\n \"store_guest_cmp_consents\": \"\",\n \"sso\": \"\",\n \"version\": \"\",\n \"mailchimp\": \"\",\n \"actito\": \"\",\n \"hubspot\": \"\",\n \"sendinblue\": \"\",\n \"selligent\": \"\",\n \"adobe_campaign_classic\": \"\",\n \"adobe_campaign_standard\": \"\",\n \"webhooks\": \"\",\n \"sf_marketing_cloud\": \"\",\n \"braze\": \"\",\n \"marketo\": \"\",\n \"microsoft_dynamics\": \"\",\n \"microsoft_dynamics_cpc\": \"\",\n \"dotdigital\": \"\",\n \"adobe_experience_cloud\": \"\",\n \"advanced_internal_monitoring\": \"\",\n \"sf_sales_cloud\": \"\",\n \"server_side\": \"\",\n \"acm_static_ip\": \"\",\n \"acm_vendor_templates\": \"\",\n \"acm_data_exports\": \"\",\n \"acm_high_frequency\": \"\",\n \"acm_full_website_scan\": \"\",\n \"web_sdk_versioning\": \"\",\n \"web_sdk_fixed_versioning\": \"\",\n \"privacy_widgets_advanced\": \"\",\n \"cmp_consent_or_pay\": \"\",\n \"cmp_rules_underage\": \"\",\n \"privacy_widgets_versions\": \"\",\n \"dsar_experience\": \"\",\n \"brand_manager\": \"\",\n \"cmp_advanced_widgets\": \"\",\n \"pmp_data_exports\": \"\",\n \"cmp_data_exports\": \"\",\n \"cmp_ctv_widgets\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/premium-features/:id", "host": [ "{{baseUrl}}" ], "path": [ "premium-features", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"preference_center\": \"\",\n \"preference_management_platform\": \"\",\n \"propagate_consents_on_sync\": \"\",\n \"consent_management_platform\": \"\",\n \"cross_device\": \"\",\n \"batch_exports\": \"\",\n \"batch_exports_manual_run\": \"\",\n \"batch_exports_analytics\": \"\",\n \"data_residency_russia\": \"\",\n \"integrations\": \"\",\n \"integrations_v2\": \"\",\n \"smart_vendor_list\": \"\",\n \"compliance_report_v2\": \"\",\n \"versions_and_proofs\": \"\",\n \"mass_update\": \"\",\n \"consents_api\": \"\",\n \"store_cmp_consents\": \"\",\n \"store_guest_cmp_consents\": \"\",\n \"sso\": \"\",\n \"version\": \"\",\n \"mailchimp\": \"\",\n \"actito\": \"\",\n \"hubspot\": \"\",\n \"sendinblue\": \"\",\n \"selligent\": \"\",\n \"adobe_campaign_classic\": \"\",\n \"adobe_campaign_standard\": \"\",\n \"webhooks\": \"\",\n \"sf_marketing_cloud\": \"\",\n \"braze\": \"\",\n \"marketo\": \"\",\n \"microsoft_dynamics\": \"\",\n \"microsoft_dynamics_cpc\": \"\",\n \"dotdigital\": \"\",\n \"adobe_experience_cloud\": \"\",\n \"advanced_internal_monitoring\": \"\",\n \"sf_sales_cloud\": \"\",\n \"server_side\": \"\",\n \"acm_static_ip\": \"\",\n \"acm_vendor_templates\": \"\",\n \"acm_data_exports\": \"\",\n \"acm_high_frequency\": \"\",\n \"acm_full_website_scan\": \"\",\n \"web_sdk_versioning\": \"\",\n \"web_sdk_fixed_versioning\": \"\",\n \"privacy_widgets_advanced\": \"\",\n \"cmp_consent_or_pay\": \"\",\n \"cmp_rules_underage\": \"\",\n \"privacy_widgets_versions\": \"\",\n \"dsar_experience\": \"\",\n \"brand_manager\": \"\",\n \"cmp_advanced_widgets\": \"\",\n \"pmp_data_exports\": \"\",\n \"cmp_data_exports\": \"\",\n \"cmp_ctv_widgets\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-4f56f4dc-686e-4c74-8168-0879efa61fbf" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-9a830186-b178-4163-8f20-ad870a311220" }, { "name": "Patch a premium feature", "id": "2402ec13-1636-4585-aa15-042fafd5f862", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"preference_center\": \"\",\n \"preference_management_platform\": \"\",\n \"propagate_consents_on_sync\": \"\",\n \"consent_management_platform\": \"\",\n \"cross_device\": \"\",\n \"batch_exports\": \"\",\n \"batch_exports_manual_run\": \"\",\n \"batch_exports_analytics\": \"\",\n \"data_residency_russia\": \"\",\n \"integrations\": \"\",\n \"integrations_v2\": \"\",\n \"smart_vendor_list\": \"\",\n \"compliance_report_v2\": \"\",\n \"versions_and_proofs\": \"\",\n \"mass_update\": \"\",\n \"consents_api\": \"\",\n \"store_cmp_consents\": \"\",\n \"store_guest_cmp_consents\": \"\",\n \"sso\": \"\",\n \"version\": \"\",\n \"mailchimp\": \"\",\n \"actito\": \"\",\n \"hubspot\": \"\",\n \"sendinblue\": \"\",\n \"selligent\": \"\",\n \"adobe_campaign_classic\": \"\",\n \"adobe_campaign_standard\": \"\",\n \"webhooks\": \"\",\n \"sf_marketing_cloud\": \"\",\n \"braze\": \"\",\n \"marketo\": \"\",\n \"microsoft_dynamics\": \"\",\n \"microsoft_dynamics_cpc\": \"\",\n \"dotdigital\": \"\",\n \"adobe_experience_cloud\": \"\",\n \"advanced_internal_monitoring\": \"\",\n \"sf_sales_cloud\": \"\",\n \"server_side\": \"\",\n \"acm_static_ip\": \"\",\n \"acm_vendor_templates\": \"\",\n \"acm_data_exports\": \"\",\n \"acm_high_frequency\": \"\",\n \"acm_full_website_scan\": \"\",\n \"web_sdk_versioning\": \"\",\n \"web_sdk_fixed_versioning\": \"\",\n \"privacy_widgets_advanced\": \"\",\n \"cmp_consent_or_pay\": \"\",\n \"cmp_rules_underage\": \"\",\n \"privacy_widgets_versions\": \"\",\n \"dsar_experience\": \"\",\n \"brand_manager\": \"\",\n \"cmp_advanced_widgets\": \"\",\n \"pmp_data_exports\": \"\",\n \"cmp_data_exports\": \"\",\n \"cmp_ctv_widgets\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/premium-features/:id", "host": [ "{{baseUrl}}" ], "path": [ "premium-features", ":id" ], "variable": [ { "id": "1a1764d0-4c38-41d2-97ef-50d064a1971b", "key": "id", "value": "", "description": "(Required) The ID of the premium feature to patch" } ] }, "description": "Partially update a premium feature" }, "response": [ { "id": "0f825a35-96e9-465d-9e39-137a1504dcbb", "name": "The patched PremiumFeature object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"preference_center\": \"\",\n \"preference_management_platform\": \"\",\n \"propagate_consents_on_sync\": \"\",\n \"consent_management_platform\": \"\",\n \"cross_device\": \"\",\n \"batch_exports\": \"\",\n \"batch_exports_manual_run\": \"\",\n \"batch_exports_analytics\": \"\",\n \"data_residency_russia\": \"\",\n \"integrations\": \"\",\n \"integrations_v2\": \"\",\n \"smart_vendor_list\": \"\",\n \"compliance_report_v2\": \"\",\n \"versions_and_proofs\": \"\",\n \"mass_update\": \"\",\n \"consents_api\": \"\",\n \"store_cmp_consents\": \"\",\n \"store_guest_cmp_consents\": \"\",\n \"sso\": \"\",\n \"version\": \"\",\n \"mailchimp\": \"\",\n \"actito\": \"\",\n \"hubspot\": \"\",\n \"sendinblue\": \"\",\n \"selligent\": \"\",\n \"adobe_campaign_classic\": \"\",\n \"adobe_campaign_standard\": \"\",\n \"webhooks\": \"\",\n \"sf_marketing_cloud\": \"\",\n \"braze\": \"\",\n \"marketo\": \"\",\n \"microsoft_dynamics\": \"\",\n \"microsoft_dynamics_cpc\": \"\",\n \"dotdigital\": \"\",\n \"adobe_experience_cloud\": \"\",\n \"advanced_internal_monitoring\": \"\",\n \"sf_sales_cloud\": \"\",\n \"server_side\": \"\",\n \"acm_static_ip\": \"\",\n \"acm_vendor_templates\": \"\",\n \"acm_data_exports\": \"\",\n \"acm_high_frequency\": \"\",\n \"acm_full_website_scan\": \"\",\n \"web_sdk_versioning\": \"\",\n \"web_sdk_fixed_versioning\": \"\",\n \"privacy_widgets_advanced\": \"\",\n \"cmp_consent_or_pay\": \"\",\n \"cmp_rules_underage\": \"\",\n \"privacy_widgets_versions\": \"\",\n \"dsar_experience\": \"\",\n \"brand_manager\": \"\",\n \"cmp_advanced_widgets\": \"\",\n \"pmp_data_exports\": \"\",\n \"cmp_data_exports\": \"\",\n \"cmp_ctv_widgets\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/premium-features/:id", "host": [ "{{baseUrl}}" ], "path": [ "premium-features", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"preference_center\": \"\",\n \"preference_management_platform\": \"\",\n \"propagate_consents_on_sync\": \"\",\n \"consent_management_platform\": \"\",\n \"cross_device\": \"\",\n \"batch_exports\": \"\",\n \"batch_exports_manual_run\": \"\",\n \"batch_exports_analytics\": \"\",\n \"data_residency_russia\": \"\",\n \"integrations\": \"\",\n \"integrations_v2\": \"\",\n \"smart_vendor_list\": \"\",\n \"compliance_report_v2\": \"\",\n \"versions_and_proofs\": \"\",\n \"mass_update\": \"\",\n \"consents_api\": \"\",\n \"store_cmp_consents\": \"\",\n \"store_guest_cmp_consents\": \"\",\n \"sso\": \"\",\n \"version\": \"\",\n \"mailchimp\": \"\",\n \"actito\": \"\",\n \"hubspot\": \"\",\n \"sendinblue\": \"\",\n \"selligent\": \"\",\n \"adobe_campaign_classic\": \"\",\n \"adobe_campaign_standard\": \"\",\n \"webhooks\": \"\",\n \"sf_marketing_cloud\": \"\",\n \"braze\": \"\",\n \"marketo\": \"\",\n \"microsoft_dynamics\": \"\",\n \"microsoft_dynamics_cpc\": \"\",\n \"dotdigital\": \"\",\n \"adobe_experience_cloud\": \"\",\n \"advanced_internal_monitoring\": \"\",\n \"sf_sales_cloud\": \"\",\n \"server_side\": \"\",\n \"acm_static_ip\": \"\",\n \"acm_vendor_templates\": \"\",\n \"acm_data_exports\": \"\",\n \"acm_high_frequency\": \"\",\n \"acm_full_website_scan\": \"\",\n \"web_sdk_versioning\": \"\",\n \"web_sdk_fixed_versioning\": \"\",\n \"privacy_widgets_advanced\": \"\",\n \"cmp_consent_or_pay\": \"\",\n \"cmp_rules_underage\": \"\",\n \"privacy_widgets_versions\": \"\",\n \"dsar_experience\": \"\",\n \"brand_manager\": \"\",\n \"cmp_advanced_widgets\": \"\",\n \"pmp_data_exports\": \"\",\n \"cmp_data_exports\": \"\",\n \"cmp_ctv_widgets\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-0f825a35-96e9-465d-9e39-137a1504dcbb" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-2402ec13-1636-4585-aa15-042fafd5f862" } ], "id": "f9c4b538-9dd3-4c13-8b96-661e516dda46", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-f9c4b538-9dd3-4c13-8b96-661e516dda46" }, { "name": "Retrieve a list of premium features", "id": "5ce9e8af-f6dc-46db-861b-9cdeae9e1f7a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/premium-features?$limit=&$skip=&id=&organization_id=&created_at=&updated_at=&preference_center=&preference_management_platform=&propagate_consents_on_sync=&consent_management_platform=&cross_device=&batch_exports=&batch_exports_manual_run=&batch_exports_analytics=&data_residency_russia=&integrations=&integrations_v2=&smart_vendor_list=&compliance_report_v2=&versions_and_proofs=&mass_update=&consents_api=&store_cmp_consents=&store_guest_cmp_consents=&sso=&version=&mailchimp=&actito=&hubspot=&sendinblue=&selligent=&adobe_campaign_classic=&adobe_campaign_standard=&webhooks=&sf_marketing_cloud=&braze=&marketo=µsoft_dynamics=µsoft_dynamics_cpc=&dotdigital=&adobe_experience_cloud=&advanced_internal_monitoring=&sf_sales_cloud=&server_side=&acm_static_ip=&acm_vendor_templates=&acm_data_exports=&acm_high_frequency=&acm_full_website_scan=&web_sdk_versioning=&web_sdk_fixed_versioning=&privacy_widgets_advanced=&cmp_consent_or_pay=&cmp_rules_underage=&privacy_widgets_versions=&dsar_experience=&brand_manager=&cmp_advanced_widgets=&pmp_data_exports=&cmp_data_exports=&cmp_ctv_widgets=", "host": [ "{{baseUrl}}" ], "path": [ "premium-features" ], "query": [ { "description": "Number of results to return", "key": "$limit", "value": "" }, { "description": "Number of results to skip", "key": "$skip", "value": "" }, { "description": "Query parameters to filter", "key": "id", "value": "" }, { "description": "Query parameters to filter", "key": "organization_id", "value": "" }, { "description": "Query parameters to filter", "key": "created_at", "value": "" }, { "description": "Query parameters to filter", "key": "updated_at", "value": "" }, { "description": "Query parameters to filter", "key": "preference_center", "value": "" }, { "description": "Query parameters to filter", "key": "preference_management_platform", "value": "" }, { "description": "Query parameters to filter", "key": "propagate_consents_on_sync", "value": "" }, { "description": "Query parameters to filter", "key": "consent_management_platform", "value": "" }, { "description": "Query parameters to filter", "key": "cross_device", "value": "" }, { "description": "Query parameters to filter", "key": "batch_exports", "value": "" }, { "description": "Query parameters to filter", "key": "batch_exports_manual_run", "value": "" }, { "description": "Query parameters to filter", "key": "batch_exports_analytics", "value": "" }, { "description": "Query parameters to filter", "key": "data_residency_russia", "value": "" }, { "description": "Query parameters to filter", "key": "integrations", "value": "" }, { "description": "Query parameters to filter", "key": "integrations_v2", "value": "" }, { "description": "Query parameters to filter", "key": "smart_vendor_list", "value": "" }, { "description": "Query parameters to filter", "key": "compliance_report_v2", "value": "" }, { "description": "Query parameters to filter", "key": "versions_and_proofs", "value": "" }, { "description": "Query parameters to filter", "key": "mass_update", "value": "" }, { "description": "Query parameters to filter", "key": "consents_api", "value": "" }, { "description": "Query parameters to filter", "key": "store_cmp_consents", "value": "" }, { "description": "Query parameters to filter", "key": "store_guest_cmp_consents", "value": "" }, { "description": "Query parameters to filter", "key": "sso", "value": "" }, { "description": "Query parameters to filter", "key": "version", "value": "" }, { "description": "Query parameters to filter", "key": "mailchimp", "value": "" }, { "description": "Query parameters to filter", "key": "actito", "value": "" }, { "description": "Query parameters to filter", "key": "hubspot", "value": "" }, { "description": "Query parameters to filter", "key": "sendinblue", "value": "" }, { "description": "Query parameters to filter", "key": "selligent", "value": "" }, { "description": "Query parameters to filter", "key": "adobe_campaign_classic", "value": "" }, { "description": "Query parameters to filter", "key": "adobe_campaign_standard", "value": "" }, { "description": "Query parameters to filter", "key": "webhooks", "value": "" }, { "description": "Query parameters to filter", "key": "sf_marketing_cloud", "value": "" }, { "description": "Query parameters to filter", "key": "braze", "value": "" }, { "description": "Query parameters to filter", "key": "marketo", "value": "" }, { "description": "Query parameters to filter", "key": "microsoft_dynamics", "value": "" }, { "description": "Query parameters to filter", "key": "microsoft_dynamics_cpc", "value": "" }, { "description": "Query parameters to filter", "key": "dotdigital", "value": "" }, { "description": "Query parameters to filter", "key": "adobe_experience_cloud", "value": "" }, { "description": "Query parameters to filter", "key": "advanced_internal_monitoring", "value": "" }, { "description": "Query parameters to filter", "key": "sf_sales_cloud", "value": "" }, { "description": "Query parameters to filter", "key": "server_side", "value": "" }, { "description": "Query parameters to filter", "key": "acm_static_ip", "value": "" }, { "description": "Query parameters to filter", "key": "acm_vendor_templates", "value": "" }, { "description": "Query parameters to filter", "key": "acm_data_exports", "value": "" }, { "description": "Query parameters to filter", "key": "acm_high_frequency", "value": "" }, { "description": "Query parameters to filter", "key": "acm_full_website_scan", "value": "" }, { "description": "Query parameters to filter", "key": "web_sdk_versioning", "value": "" }, { "description": "Query parameters to filter", "key": "web_sdk_fixed_versioning", "value": "" }, { "description": "Query parameters to filter", "key": "privacy_widgets_advanced", "value": "" }, { "description": "Query parameters to filter", "key": "cmp_consent_or_pay", "value": "" }, { "description": "Query parameters to filter", "key": "cmp_rules_underage", "value": "" }, { "description": "Query parameters to filter", "key": "privacy_widgets_versions", "value": "" }, { "description": "Query parameters to filter", "key": "dsar_experience", "value": "" }, { "description": "Query parameters to filter", "key": "brand_manager", "value": "" }, { "description": "Query parameters to filter", "key": "cmp_advanced_widgets", "value": "" }, { "description": "Query parameters to filter", "key": "pmp_data_exports", "value": "" }, { "description": "Query parameters to filter", "key": "cmp_data_exports", "value": "" }, { "description": "Query parameters to filter", "key": "cmp_ctv_widgets", "value": "" } ] }, "description": "Returns a list of all premium features for the organizations the user belongs to" }, "response": [ { "id": "3ce88a1f-8852-496f-a383-69efaff0c8f8", "name": "A list of PremiumFeature objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/premium-features?$limit=&$skip=&id=&organization_id=&created_at=&updated_at=&preference_center=&preference_management_platform=&propagate_consents_on_sync=&consent_management_platform=&cross_device=&batch_exports=&batch_exports_manual_run=&batch_exports_analytics=&data_residency_russia=&integrations=&integrations_v2=&smart_vendor_list=&compliance_report_v2=&versions_and_proofs=&mass_update=&consents_api=&store_cmp_consents=&store_guest_cmp_consents=&sso=&version=&mailchimp=&actito=&hubspot=&sendinblue=&selligent=&adobe_campaign_classic=&adobe_campaign_standard=&webhooks=&sf_marketing_cloud=&braze=&marketo=µsoft_dynamics=µsoft_dynamics_cpc=&dotdigital=&adobe_experience_cloud=&advanced_internal_monitoring=&sf_sales_cloud=&server_side=&acm_static_ip=&acm_vendor_templates=&acm_data_exports=&acm_high_frequency=&acm_full_website_scan=&web_sdk_versioning=&web_sdk_fixed_versioning=&privacy_widgets_advanced=&cmp_consent_or_pay=&cmp_rules_underage=&privacy_widgets_versions=&dsar_experience=&brand_manager=&cmp_advanced_widgets=&pmp_data_exports=&cmp_data_exports=&cmp_ctv_widgets=", "host": [ "{{baseUrl}}" ], "path": [ "premium-features" ], "query": [ { "description": "Number of results to return", "key": "$limit", "value": "" }, { "description": "Number of results to skip", "key": "$skip", "value": "" }, { "description": "Query parameters to filter", "key": "id", "value": "" }, { "description": "Query parameters to filter", "key": "organization_id", "value": "" }, { "description": "Query parameters to filter", "key": "created_at", "value": "" }, { "description": "Query parameters to filter", "key": "updated_at", "value": "" }, { "description": "Query parameters to filter", "key": "preference_center", "value": "" }, { "description": "Query parameters to filter", "key": "preference_management_platform", "value": "" }, { "description": "Query parameters to filter", "key": "propagate_consents_on_sync", "value": "" }, { "description": "Query parameters to filter", "key": "consent_management_platform", "value": "" }, { "description": "Query parameters to filter", "key": "cross_device", "value": "" }, { "description": "Query parameters to filter", "key": "batch_exports", "value": "" }, { "description": "Query parameters to filter", "key": "batch_exports_manual_run", "value": "" }, { "description": "Query parameters to filter", "key": "batch_exports_analytics", "value": "" }, { "description": "Query parameters to filter", "key": "data_residency_russia", "value": "" }, { "description": "Query parameters to filter", "key": "integrations", "value": "" }, { "description": "Query parameters to filter", "key": "integrations_v2", "value": "" }, { "description": "Query parameters to filter", "key": "smart_vendor_list", "value": "" }, { "description": "Query parameters to filter", "key": "compliance_report_v2", "value": "" }, { "description": "Query parameters to filter", "key": "versions_and_proofs", "value": "" }, { "description": "Query parameters to filter", "key": "mass_update", "value": "" }, { "description": "Query parameters to filter", "key": "consents_api", "value": "" }, { "description": "Query parameters to filter", "key": "store_cmp_consents", "value": "" }, { "description": "Query parameters to filter", "key": "store_guest_cmp_consents", "value": "" }, { "description": "Query parameters to filter", "key": "sso", "value": "" }, { "description": "Query parameters to filter", "key": "version", "value": "" }, { "description": "Query parameters to filter", "key": "mailchimp", "value": "" }, { "description": "Query parameters to filter", "key": "actito", "value": "" }, { "description": "Query parameters to filter", "key": "hubspot", "value": "" }, { "description": "Query parameters to filter", "key": "sendinblue", "value": "" }, { "description": "Query parameters to filter", "key": "selligent", "value": "" }, { "description": "Query parameters to filter", "key": "adobe_campaign_classic", "value": "" }, { "description": "Query parameters to filter", "key": "adobe_campaign_standard", "value": "" }, { "description": "Query parameters to filter", "key": "webhooks", "value": "" }, { "description": "Query parameters to filter", "key": "sf_marketing_cloud", "value": "" }, { "description": "Query parameters to filter", "key": "braze", "value": "" }, { "description": "Query parameters to filter", "key": "marketo", "value": "" }, { "description": "Query parameters to filter", "key": "microsoft_dynamics", "value": "" }, { "description": "Query parameters to filter", "key": "microsoft_dynamics_cpc", "value": "" }, { "description": "Query parameters to filter", "key": "dotdigital", "value": "" }, { "description": "Query parameters to filter", "key": "adobe_experience_cloud", "value": "" }, { "description": "Query parameters to filter", "key": "advanced_internal_monitoring", "value": "" }, { "description": "Query parameters to filter", "key": "sf_sales_cloud", "value": "" }, { "description": "Query parameters to filter", "key": "server_side", "value": "" }, { "description": "Query parameters to filter", "key": "acm_static_ip", "value": "" }, { "description": "Query parameters to filter", "key": "acm_vendor_templates", "value": "" }, { "description": "Query parameters to filter", "key": "acm_data_exports", "value": "" }, { "description": "Query parameters to filter", "key": "acm_high_frequency", "value": "" }, { "description": "Query parameters to filter", "key": "acm_full_website_scan", "value": "" }, { "description": "Query parameters to filter", "key": "web_sdk_versioning", "value": "" }, { "description": "Query parameters to filter", "key": "web_sdk_fixed_versioning", "value": "" }, { "description": "Query parameters to filter", "key": "privacy_widgets_advanced", "value": "" }, { "description": "Query parameters to filter", "key": "cmp_consent_or_pay", "value": "" }, { "description": "Query parameters to filter", "key": "cmp_rules_underage", "value": "" }, { "description": "Query parameters to filter", "key": "privacy_widgets_versions", "value": "" }, { "description": "Query parameters to filter", "key": "dsar_experience", "value": "" }, { "description": "Query parameters to filter", "key": "brand_manager", "value": "" }, { "description": "Query parameters to filter", "key": "cmp_advanced_widgets", "value": "" }, { "description": "Query parameters to filter", "key": "pmp_data_exports", "value": "" }, { "description": "Query parameters to filter", "key": "cmp_data_exports", "value": "" }, { "description": "Query parameters to filter", "key": "cmp_ctv_widgets", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"preference_center\": \"\",\n \"preference_management_platform\": \"\",\n \"propagate_consents_on_sync\": \"\",\n \"consent_management_platform\": \"\",\n \"cross_device\": \"\",\n \"batch_exports\": \"\",\n \"batch_exports_manual_run\": \"\",\n \"batch_exports_analytics\": \"\",\n \"data_residency_russia\": \"\",\n \"integrations\": \"\",\n \"integrations_v2\": \"\",\n \"smart_vendor_list\": \"\",\n \"compliance_report_v2\": \"\",\n \"versions_and_proofs\": \"\",\n \"mass_update\": \"\",\n \"consents_api\": \"\",\n \"store_cmp_consents\": \"\",\n \"store_guest_cmp_consents\": \"\",\n \"sso\": \"\",\n \"version\": \"\",\n \"mailchimp\": \"\",\n \"actito\": \"\",\n \"hubspot\": \"\",\n \"sendinblue\": \"\",\n \"selligent\": \"\",\n \"adobe_campaign_classic\": \"\",\n \"adobe_campaign_standard\": \"\",\n \"webhooks\": \"\",\n \"sf_marketing_cloud\": \"\",\n \"braze\": \"\",\n \"marketo\": \"\",\n \"microsoft_dynamics\": \"\",\n \"microsoft_dynamics_cpc\": \"\",\n \"dotdigital\": \"\",\n \"adobe_experience_cloud\": \"\",\n \"advanced_internal_monitoring\": \"\",\n \"sf_sales_cloud\": \"\",\n \"server_side\": \"\",\n \"acm_static_ip\": \"\",\n \"acm_vendor_templates\": \"\",\n \"acm_data_exports\": \"\",\n \"acm_high_frequency\": \"\",\n \"acm_full_website_scan\": \"\",\n \"web_sdk_versioning\": \"\",\n \"web_sdk_fixed_versioning\": \"\",\n \"privacy_widgets_advanced\": \"\",\n \"cmp_consent_or_pay\": \"\",\n \"cmp_rules_underage\": \"\",\n \"privacy_widgets_versions\": \"\",\n \"dsar_experience\": \"\",\n \"brand_manager\": \"\",\n \"cmp_advanced_widgets\": \"\",\n \"pmp_data_exports\": \"\",\n \"cmp_data_exports\": \"\",\n \"cmp_ctv_widgets\": \"\"\n },\n {\n \"id\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"preference_center\": \"\",\n \"preference_management_platform\": \"\",\n \"propagate_consents_on_sync\": \"\",\n \"consent_management_platform\": \"\",\n \"cross_device\": \"\",\n \"batch_exports\": \"\",\n \"batch_exports_manual_run\": \"\",\n \"batch_exports_analytics\": \"\",\n \"data_residency_russia\": \"\",\n \"integrations\": \"\",\n \"integrations_v2\": \"\",\n \"smart_vendor_list\": \"\",\n \"compliance_report_v2\": \"\",\n \"versions_and_proofs\": \"\",\n \"mass_update\": \"\",\n \"consents_api\": \"\",\n \"store_cmp_consents\": \"\",\n \"store_guest_cmp_consents\": \"\",\n \"sso\": \"\",\n \"version\": \"\",\n \"mailchimp\": \"\",\n \"actito\": \"\",\n \"hubspot\": \"\",\n \"sendinblue\": \"\",\n \"selligent\": \"\",\n \"adobe_campaign_classic\": \"\",\n \"adobe_campaign_standard\": \"\",\n \"webhooks\": \"\",\n \"sf_marketing_cloud\": \"\",\n \"braze\": \"\",\n \"marketo\": \"\",\n \"microsoft_dynamics\": \"\",\n \"microsoft_dynamics_cpc\": \"\",\n \"dotdigital\": \"\",\n \"adobe_experience_cloud\": \"\",\n \"advanced_internal_monitoring\": \"\",\n \"sf_sales_cloud\": \"\",\n \"server_side\": \"\",\n \"acm_static_ip\": \"\",\n \"acm_vendor_templates\": \"\",\n \"acm_data_exports\": \"\",\n \"acm_high_frequency\": \"\",\n \"acm_full_website_scan\": \"\",\n \"web_sdk_versioning\": \"\",\n \"web_sdk_fixed_versioning\": \"\",\n \"privacy_widgets_advanced\": \"\",\n \"cmp_consent_or_pay\": \"\",\n \"cmp_rules_underage\": \"\",\n \"privacy_widgets_versions\": \"\",\n \"dsar_experience\": \"\",\n \"brand_manager\": \"\",\n \"cmp_advanced_widgets\": \"\",\n \"pmp_data_exports\": \"\",\n \"cmp_data_exports\": \"\",\n \"cmp_ctv_widgets\": \"\"\n }\n]", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-3ce88a1f-8852-496f-a383-69efaff0c8f8" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-5ce9e8af-f6dc-46db-861b-9cdeae9e1f7a" } ], "id": "a32cc0ff-5977-4f44-b2ce-c6c5ef12ba3a", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-a32cc0ff-5977-4f44-b2ce-c6c5ef12ba3a" }, { "name": "sso-connections", "item": [ { "name": "{id}", "item": [ { "name": "Patch a SSO connection", "id": "7d7a0e7f-13c9-431f-bb01-c6da493599d5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"auth0_connection_id\": \"\",\n \"auth0_connection_name\": \"\",\n \"auth0_certificate\": \"\",\n \"auth0_domain_aliases\": [\n \"\",\n \"\"\n ],\n \"auth0_sign_in_endpoint\": \"\",\n \"auth0_sign_out_endpoint\": \"\",\n \"auth0_sign_saml_request\": \"\",\n \"organization_group_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sso-connections/:id", "host": [ "{{baseUrl}}" ], "path": [ "sso-connections", ":id" ], "variable": [ { "id": "15e20f5d-c54a-4664-9a32-d606538bc7bd", "key": "id" } ] }, "description": "Patch an existing SSO connection." }, "response": [ { "id": "c42919d9-8f2c-4527-8dbe-c3ef5a6fb485", "name": "200 response", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"auth0_connection_id\": \"\",\n \"auth0_connection_name\": \"\",\n \"auth0_certificate\": \"\",\n \"auth0_domain_aliases\": [\n \"\",\n \"\"\n ],\n \"auth0_sign_in_endpoint\": \"\",\n \"auth0_sign_out_endpoint\": \"\",\n \"auth0_sign_saml_request\": \"\",\n \"organization_group_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sso-connections/:id", "host": [ "{{baseUrl}}" ], "path": [ "sso-connections", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"auth0_connection_id\": \"\",\n \"auth0_connection_name\": \"\",\n \"auth0_certificate\": \"\",\n \"auth0_domain_aliases\": [\n \"\",\n \"\"\n ],\n \"auth0_sign_in_endpoint\": \"\",\n \"auth0_sign_out_endpoint\": \"\",\n \"auth0_sign_saml_request\": \"\",\n \"organization_group_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-c42919d9-8f2c-4527-8dbe-c3ef5a6fb485" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-7d7a0e7f-13c9-431f-bb01-c6da493599d5" } ], "id": "82a899d7-3f1a-4f65-8512-8f8155d3886b", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-82a899d7-3f1a-4f65-8512-8f8155d3886b" }, { "name": "Retrieve a list of SSO connections", "id": "3d333191-688a-4c14-a230-0c0d9fe2b285", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/sso-connections?organization_id=", "host": [ "{{baseUrl}}" ], "path": [ "sso-connections" ], "query": [ { "description": "(Required) The ID of the organization that the user belongs to", "key": "organization_id", "value": "" } ] }, "description": "Returns a list of all SSO connections." }, "response": [ { "id": "88852e1e-1051-4d87-aac8-e14ca8138103", "name": "200 response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/sso-connections?organization_id=", "host": [ "{{baseUrl}}" ], "path": [ "sso-connections" ], "query": [ { "description": "(Required) The ID of the organization that the user belongs to", "key": "organization_id", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"auth0_connection_id\": \"\",\n \"auth0_connection_name\": \"\",\n \"auth0_certificate\": \"\",\n \"auth0_domain_aliases\": [\n \"\",\n \"\"\n ],\n \"auth0_sign_in_endpoint\": \"\",\n \"auth0_sign_out_endpoint\": \"\",\n \"auth0_sign_saml_request\": \"\",\n \"organization_group_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"id\": \"\",\n \"auth0_connection_id\": \"\",\n \"auth0_connection_name\": \"\",\n \"auth0_certificate\": \"\",\n \"auth0_domain_aliases\": [\n \"\",\n \"\"\n ],\n \"auth0_sign_in_endpoint\": \"\",\n \"auth0_sign_out_endpoint\": \"\",\n \"auth0_sign_saml_request\": \"\",\n \"organization_group_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n]", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-88852e1e-1051-4d87-aac8-e14ca8138103" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-3d333191-688a-4c14-a230-0c0d9fe2b285" }, { "name": "Create a SSO connection", "id": "e5f27226-d876-49c6-9090-2aa6804bc622", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"auth0_connection_id\": \"\",\n \"auth0_connection_name\": \"\",\n \"auth0_certificate\": \"\",\n \"auth0_domain_aliases\": [\n \"\",\n \"\"\n ],\n \"auth0_sign_in_endpoint\": \"\",\n \"auth0_sign_out_endpoint\": \"\",\n \"auth0_sign_saml_request\": \"\",\n \"organization_group_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sso-connections", "host": [ "{{baseUrl}}" ], "path": [ "sso-connections" ] }, "description": "Create a new SSO connection." }, "response": [ { "id": "36aaa278-aa51-4d9d-85c3-ae21fa351aa8", "name": "201 response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"auth0_connection_id\": \"\",\n \"auth0_connection_name\": \"\",\n \"auth0_certificate\": \"\",\n \"auth0_domain_aliases\": [\n \"\",\n \"\"\n ],\n \"auth0_sign_in_endpoint\": \"\",\n \"auth0_sign_out_endpoint\": \"\",\n \"auth0_sign_saml_request\": \"\",\n \"organization_group_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sso-connections", "host": [ "{{baseUrl}}" ], "path": [ "sso-connections" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"auth0_connection_id\": \"\",\n \"auth0_connection_name\": \"\",\n \"auth0_certificate\": \"\",\n \"auth0_domain_aliases\": [\n \"\",\n \"\"\n ],\n \"auth0_sign_in_endpoint\": \"\",\n \"auth0_sign_out_endpoint\": \"\",\n \"auth0_sign_saml_request\": \"\",\n \"organization_group_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-36aaa278-aa51-4d9d-85c3-ae21fa351aa8" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-e5f27226-d876-49c6-9090-2aa6804bc622" } ], "id": "ba81895b-aa77-4cdb-a6cb-1f2f40319af9", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-ba81895b-aa77-4cdb-a6cb-1f2f40319af9" }, { "name": "organizations-source-systems", "item": [ { "name": "Retrieve a list of organization source systems", "id": "a570e218-0f4f-4ab3-b07f-480a11859cc3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/organizations-source-systems?$limit=&$skip=&id=&organization_id=&source_system=sp&source_system_id=&created_at=&updated_at=", "host": [ "{{baseUrl}}" ], "path": [ "organizations-source-systems" ], "query": [ { "description": "Number of results to return", "key": "$limit", "value": "" }, { "description": "Number of results to skip", "key": "$skip", "value": "" }, { "description": "Query parameters to filter", "key": "id", "value": "" }, { "description": "Query parameters to filter", "key": "organization_id", "value": "" }, { "description": "Query parameters to filter", "key": "source_system", "value": "sp" }, { "description": "Query parameters to filter", "key": "source_system_id", "value": "" }, { "description": "Query parameters to filter", "key": "created_at", "value": "" }, { "description": "Query parameters to filter", "key": "updated_at", "value": "" } ] }, "description": "Returns a list of organization source system mappings" }, "response": [ { "id": "86fba527-ecf5-4985-9ba2-ed8df8c466b5", "name": "A list of OrganizationSourceSystem objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/organizations-source-systems?$limit=&$skip=&id=&organization_id=&source_system=sp&source_system_id=&created_at=&updated_at=", "host": [ "{{baseUrl}}" ], "path": [ "organizations-source-systems" ], "query": [ { "description": "Number of results to return", "key": "$limit", "value": "" }, { "description": "Number of results to skip", "key": "$skip", "value": "" }, { "description": "Query parameters to filter", "key": "id", "value": "" }, { "description": "Query parameters to filter", "key": "organization_id", "value": "" }, { "description": "Query parameters to filter", "key": "source_system", "value": "sp" }, { "description": "Query parameters to filter", "key": "source_system_id", "value": "" }, { "description": "Query parameters to filter", "key": "created_at", "value": "" }, { "description": "Query parameters to filter", "key": "updated_at", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"total\": \"\",\n \"limit\": \"\",\n \"skip\": \"\",\n \"data\": [\n {\n \"id\": \"\",\n \"organization_id\": \"\",\n \"source_system\": \"sp\",\n \"source_system_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"id\": \"\",\n \"organization_id\": \"\",\n \"source_system\": \"sp\",\n \"source_system_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-86fba527-ecf5-4985-9ba2-ed8df8c466b5" }, { "id": "0707da54-411b-480c-9e16-8cd9fad128bc", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/organizations-source-systems?$limit=&$skip=&id=&organization_id=&source_system=sp&source_system_id=&created_at=&updated_at=", "host": [ "{{baseUrl}}" ], "path": [ "organizations-source-systems" ], "query": [ { "description": "Number of results to return", "key": "$limit", "value": "" }, { "description": "Number of results to skip", "key": "$skip", "value": "" }, { "description": "Query parameters to filter", "key": "id", "value": "" }, { "description": "Query parameters to filter", "key": "organization_id", "value": "" }, { "description": "Query parameters to filter", "key": "source_system", "value": "sp" }, { "description": "Query parameters to filter", "key": "source_system_id", "value": "" }, { "description": "Query parameters to filter", "key": "created_at", "value": "" }, { "description": "Query parameters to filter", "key": "updated_at", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-0707da54-411b-480c-9e16-8cd9fad128bc" }, { "id": "20819cde-8ee4-4420-9ed6-e6d72f58241f", "name": "Internal server error", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/organizations-source-systems?$limit=&$skip=&id=&organization_id=&source_system=sp&source_system_id=&created_at=&updated_at=", "host": [ "{{baseUrl}}" ], "path": [ "organizations-source-systems" ], "query": [ { "description": "Number of results to return", "key": "$limit", "value": "" }, { "description": "Number of results to skip", "key": "$skip", "value": "" }, { "description": "Query parameters to filter", "key": "id", "value": "" }, { "description": "Query parameters to filter", "key": "organization_id", "value": "" }, { "description": "Query parameters to filter", "key": "source_system", "value": "sp" }, { "description": "Query parameters to filter", "key": "source_system_id", "value": "" }, { "description": "Query parameters to filter", "key": "created_at", "value": "" }, { "description": "Query parameters to filter", "key": "updated_at", "value": "" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-20819cde-8ee4-4420-9ed6-e6d72f58241f" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-a570e218-0f4f-4ab3-b07f-480a11859cc3" }, { "name": "Create an organization source system mapping", "id": "c3723eda-2be8-4e00-99fa-a37b9fd299cc", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"organization_id\": \"\",\n \"source_system\": \"sp\",\n \"source_system_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/organizations-source-systems", "host": [ "{{baseUrl}}" ], "path": [ "organizations-source-systems" ] }, "description": "Create a new organization source system mapping" }, "response": [ { "id": "68f483cb-990a-4c5d-bfb0-624c194aca78", "name": "The created OrganizationSourceSystem object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"organization_id\": \"\",\n \"source_system\": \"sp\",\n \"source_system_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/organizations-source-systems", "host": [ "{{baseUrl}}" ], "path": [ "organizations-source-systems" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"organization_id\": \"\",\n \"source_system\": \"sp\",\n \"source_system_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-68f483cb-990a-4c5d-bfb0-624c194aca78" }, { "id": "c179e332-5475-4467-8d20-672812f27d41", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"organization_id\": \"\",\n \"source_system\": \"sp\",\n \"source_system_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/organizations-source-systems", "host": [ "{{baseUrl}}" ], "path": [ "organizations-source-systems" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-c179e332-5475-4467-8d20-672812f27d41" }, { "id": "8b656463-b6c5-49a1-b9bc-3ab41edd0f0b", "name": "Internal server error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"organization_id\": \"\",\n \"source_system\": \"sp\",\n \"source_system_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/organizations-source-systems", "host": [ "{{baseUrl}}" ], "path": [ "organizations-source-systems" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-8b656463-b6c5-49a1-b9bc-3ab41edd0f0b" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-c3723eda-2be8-4e00-99fa-a37b9fd299cc" } ], "id": "5f6a4f0a-47ee-41ca-9823-4842bc023a36", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-5f6a4f0a-47ee-41ca-9823-4842bc023a36" }, { "name": "metadata", "item": [ { "name": "partners", "item": [ { "name": "deprecate", "item": [ { "name": "Creates a new resource with data.", "id": "98f1732a-5407-43a6-95d2-20633bcf8d80", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"category_id\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"contact\": \"\",\n \"website\": \"\",\n \"website_optout\": \"\",\n \"hosts\": [\n \"\",\n \"\"\n ],\n \"url_patterns\": [\n \"\",\n \"\"\n ],\n \"urls\": [\n \"\",\n \"\"\n ],\n \"taxonomy_id\": \"\",\n \"organization_id\": \"\",\n \"country\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\",\n \"namespaces\": {\n \"iab\": \"\",\n \"iab2\": \"\",\n \"didomi\": \"\",\n \"custom\": \"\",\n \"google\": \"\"\n },\n \"default_purposes_id\": [\n \"\",\n \"\"\n ],\n \"legitimate_interest_purposes_id\": [\n \"\",\n \"\"\n ],\n \"spi_purposes_id\": [\n \"\",\n \"\"\n ],\n \"cookie_max_duration\": \"\",\n \"cookie_max_duration_unit\": \"months\",\n \"uses_non_cookie_access\": \"\",\n \"deprecated\": \"\",\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/partners/deprecate", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners", "deprecate" ] }, "description": "Creates a new resource with data." }, "response": [ { "id": "ae9cafc0-e7fe-498b-a78e-985a6f7a799a", "name": "created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"category_id\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"contact\": \"\",\n \"website\": \"\",\n \"website_optout\": \"\",\n \"hosts\": [\n \"\",\n \"\"\n ],\n \"url_patterns\": [\n \"\",\n \"\"\n ],\n \"urls\": [\n \"\",\n \"\"\n ],\n \"taxonomy_id\": \"\",\n \"organization_id\": \"\",\n \"country\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\",\n \"namespaces\": {\n \"iab\": \"\",\n \"iab2\": \"\",\n \"didomi\": \"\",\n \"custom\": \"\",\n \"google\": \"\"\n },\n \"default_purposes_id\": [\n \"\",\n \"\"\n ],\n \"legitimate_interest_purposes_id\": [\n \"\",\n \"\"\n ],\n \"spi_purposes_id\": [\n \"\",\n \"\"\n ],\n \"cookie_max_duration\": \"\",\n \"cookie_max_duration_unit\": \"months\",\n \"uses_non_cookie_access\": \"\",\n \"deprecated\": \"\",\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/partners/deprecate", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners", "deprecate" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"category_id\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"contact\": \"\",\n \"website\": \"\",\n \"website_optout\": \"\",\n \"hosts\": [\n \"\",\n \"\"\n ],\n \"url_patterns\": [\n \"\",\n \"\"\n ],\n \"urls\": [\n \"\",\n \"\"\n ],\n \"taxonomy_id\": \"\",\n \"organization_id\": \"\",\n \"country\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\",\n \"namespaces\": {\n \"iab\": \"\",\n \"iab2\": \"\",\n \"didomi\": \"\",\n \"custom\": \"\",\n \"google\": \"\"\n },\n \"default_purposes_id\": [\n \"\",\n \"\"\n ],\n \"legitimate_interest_purposes_id\": [\n \"\",\n \"\"\n ],\n \"spi_purposes_id\": [\n \"\",\n \"\"\n ],\n \"cookie_max_duration\": \"\",\n \"cookie_max_duration_unit\": \"months\",\n \"uses_non_cookie_access\": \"\",\n \"deprecated\": \"\",\n \"notes\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-ae9cafc0-e7fe-498b-a78e-985a6f7a799a" }, { "id": "61576d3a-fd33-4250-9933-208d8c787652", "name": "not authenticated", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"category_id\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"contact\": \"\",\n \"website\": \"\",\n \"website_optout\": \"\",\n \"hosts\": [\n \"\",\n \"\"\n ],\n \"url_patterns\": [\n \"\",\n \"\"\n ],\n \"urls\": [\n \"\",\n \"\"\n ],\n \"taxonomy_id\": \"\",\n \"organization_id\": \"\",\n \"country\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\",\n \"namespaces\": {\n \"iab\": \"\",\n \"iab2\": \"\",\n \"didomi\": \"\",\n \"custom\": \"\",\n \"google\": \"\"\n },\n \"default_purposes_id\": [\n \"\",\n \"\"\n ],\n \"legitimate_interest_purposes_id\": [\n \"\",\n \"\"\n ],\n \"spi_purposes_id\": [\n \"\",\n \"\"\n ],\n \"cookie_max_duration\": \"\",\n \"cookie_max_duration_unit\": \"months\",\n \"uses_non_cookie_access\": \"\",\n \"deprecated\": \"\",\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/partners/deprecate", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners", "deprecate" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-61576d3a-fd33-4250-9933-208d8c787652" }, { "id": "ae0f6089-2823-425c-a362-ee295f837951", "name": "general error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"category_id\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"contact\": \"\",\n \"website\": \"\",\n \"website_optout\": \"\",\n \"hosts\": [\n \"\",\n \"\"\n ],\n \"url_patterns\": [\n \"\",\n \"\"\n ],\n \"urls\": [\n \"\",\n \"\"\n ],\n \"taxonomy_id\": \"\",\n \"organization_id\": \"\",\n \"country\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\",\n \"namespaces\": {\n \"iab\": \"\",\n \"iab2\": \"\",\n \"didomi\": \"\",\n \"custom\": \"\",\n \"google\": \"\"\n },\n \"default_purposes_id\": [\n \"\",\n \"\"\n ],\n \"legitimate_interest_purposes_id\": [\n \"\",\n \"\"\n ],\n \"spi_purposes_id\": [\n \"\",\n \"\"\n ],\n \"cookie_max_duration\": \"\",\n \"cookie_max_duration_unit\": \"months\",\n \"uses_non_cookie_access\": \"\",\n \"deprecated\": \"\",\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/partners/deprecate", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners", "deprecate" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-ae0f6089-2823-425c-a362-ee295f837951" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-98f1732a-5407-43a6-95d2-20633bcf8d80" } ], "id": "111e0b8c-48eb-43fb-83d4-f207ab30a2eb", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-111e0b8c-48eb-43fb-83d4-f207ab30a2eb" }, { "name": "{id}", "item": [ { "name": "Retrieve a partner", "id": "aba36bc1-4814-4634-9264-808f7bcda714", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/metadata/partners/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners", ":id" ], "variable": [ { "id": "a323c82d-ee2c-49b9-8624-b126ec2512d9", "key": "id", "value": "", "description": "(Required) The ID of the partner to retrieve" } ] }, "description": "Returns a single partner with the given ID" }, "response": [ { "id": "622e532f-b289-45da-9860-fb2240e4ab89", "name": "A Partner object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/metadata/partners/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"category_id\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"contact\": \"\",\n \"website\": \"\",\n \"website_optout\": \"\",\n \"hosts\": [\n \"\",\n \"\"\n ],\n \"url_patterns\": [\n \"\",\n \"\"\n ],\n \"urls\": [\n \"\",\n \"\"\n ],\n \"taxonomy_id\": \"\",\n \"organization_id\": \"\",\n \"country\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\",\n \"namespaces\": {\n \"iab\": \"\",\n \"iab2\": \"\",\n \"didomi\": \"\",\n \"custom\": \"\",\n \"google\": \"\"\n },\n \"default_purposes_id\": [\n \"\",\n \"\"\n ],\n \"legitimate_interest_purposes_id\": [\n \"\",\n \"\"\n ],\n \"spi_purposes_id\": [\n \"\",\n \"\"\n ],\n \"cookie_max_duration\": \"\",\n \"cookie_max_duration_unit\": \"months\",\n \"uses_non_cookie_access\": \"\",\n \"deprecated\": \"\",\n \"notes\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-622e532f-b289-45da-9860-fb2240e4ab89" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-aba36bc1-4814-4634-9264-808f7bcda714" }, { "name": "Update a partner", "id": "2fba61f9-b582-4663-b7be-800dc4ab15a5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"category_id\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"contact\": \"\",\n \"website\": \"\",\n \"website_optout\": \"\",\n \"hosts\": [\n \"\",\n \"\"\n ],\n \"url_patterns\": [\n \"\",\n \"\"\n ],\n \"urls\": [\n \"\",\n \"\"\n ],\n \"taxonomy_id\": \"\",\n \"organization_id\": \"\",\n \"country\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\",\n \"namespaces\": {\n \"iab\": \"\",\n \"iab2\": \"\",\n \"didomi\": \"\",\n \"custom\": \"\",\n \"google\": \"\"\n },\n \"default_purposes_id\": [\n \"\",\n \"\"\n ],\n \"legitimate_interest_purposes_id\": [\n \"\",\n \"\"\n ],\n \"spi_purposes_id\": [\n \"\",\n \"\"\n ],\n \"cookie_max_duration\": \"\",\n \"cookie_max_duration_unit\": \"months\",\n \"uses_non_cookie_access\": \"\",\n \"deprecated\": \"\",\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/partners/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners", ":id" ], "variable": [ { "id": "0b29414c-a6a8-41e6-8707-e35cb61594fe", "key": "id", "value": "", "description": "(Required) The ID of the partner to update" } ] }, "description": "Update an existing a partner" }, "response": [ { "id": "56b59cd1-03f0-479d-aa30-ffe32a8270aa", "name": "The updated Partner object", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"category_id\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"contact\": \"\",\n \"website\": \"\",\n \"website_optout\": \"\",\n \"hosts\": [\n \"\",\n \"\"\n ],\n \"url_patterns\": [\n \"\",\n \"\"\n ],\n \"urls\": [\n \"\",\n \"\"\n ],\n \"taxonomy_id\": \"\",\n \"organization_id\": \"\",\n \"country\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\",\n \"namespaces\": {\n \"iab\": \"\",\n \"iab2\": \"\",\n \"didomi\": \"\",\n \"custom\": \"\",\n \"google\": \"\"\n },\n \"default_purposes_id\": [\n \"\",\n \"\"\n ],\n \"legitimate_interest_purposes_id\": [\n \"\",\n \"\"\n ],\n \"spi_purposes_id\": [\n \"\",\n \"\"\n ],\n \"cookie_max_duration\": \"\",\n \"cookie_max_duration_unit\": \"months\",\n \"uses_non_cookie_access\": \"\",\n \"deprecated\": \"\",\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/partners/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"category_id\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"contact\": \"\",\n \"website\": \"\",\n \"website_optout\": \"\",\n \"hosts\": [\n \"\",\n \"\"\n ],\n \"url_patterns\": [\n \"\",\n \"\"\n ],\n \"urls\": [\n \"\",\n \"\"\n ],\n \"taxonomy_id\": \"\",\n \"organization_id\": \"\",\n \"country\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\",\n \"namespaces\": {\n \"iab\": \"\",\n \"iab2\": \"\",\n \"didomi\": \"\",\n \"custom\": \"\",\n \"google\": \"\"\n },\n \"default_purposes_id\": [\n \"\",\n \"\"\n ],\n \"legitimate_interest_purposes_id\": [\n \"\",\n \"\"\n ],\n \"spi_purposes_id\": [\n \"\",\n \"\"\n ],\n \"cookie_max_duration\": \"\",\n \"cookie_max_duration_unit\": \"months\",\n \"uses_non_cookie_access\": \"\",\n \"deprecated\": \"\",\n \"notes\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-56b59cd1-03f0-479d-aa30-ffe32a8270aa" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-2fba61f9-b582-4663-b7be-800dc4ab15a5" }, { "name": "Patch a partner", "id": "99aa0676-9372-44b9-a62d-1e3994303208", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"category_id\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"contact\": \"\",\n \"website\": \"\",\n \"website_optout\": \"\",\n \"hosts\": [\n \"\",\n \"\"\n ],\n \"url_patterns\": [\n \"\",\n \"\"\n ],\n \"urls\": [\n \"\",\n \"\"\n ],\n \"taxonomy_id\": \"\",\n \"organization_id\": \"\",\n \"country\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\",\n \"namespaces\": {\n \"iab\": \"\",\n \"iab2\": \"\",\n \"didomi\": \"\",\n \"custom\": \"\",\n \"google\": \"\"\n },\n \"default_purposes_id\": [\n \"\",\n \"\"\n ],\n \"legitimate_interest_purposes_id\": [\n \"\",\n \"\"\n ],\n \"spi_purposes_id\": [\n \"\",\n \"\"\n ],\n \"cookie_max_duration\": \"\",\n \"cookie_max_duration_unit\": \"months\",\n \"uses_non_cookie_access\": \"\",\n \"deprecated\": \"\",\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/partners/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners", ":id" ], "variable": [ { "id": "ad2a02a6-3cab-46c2-9ab5-20fad43ea8f9", "key": "id", "value": "", "description": "(Required) The ID of the partner to patch" } ] }, "description": "Partially update the partner" }, "response": [ { "id": "01fe755c-73dc-4b39-aca6-217896a5aa14", "name": "The patched Partner object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"category_id\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"contact\": \"\",\n \"website\": \"\",\n \"website_optout\": \"\",\n \"hosts\": [\n \"\",\n \"\"\n ],\n \"url_patterns\": [\n \"\",\n \"\"\n ],\n \"urls\": [\n \"\",\n \"\"\n ],\n \"taxonomy_id\": \"\",\n \"organization_id\": \"\",\n \"country\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\",\n \"namespaces\": {\n \"iab\": \"\",\n \"iab2\": \"\",\n \"didomi\": \"\",\n \"custom\": \"\",\n \"google\": \"\"\n },\n \"default_purposes_id\": [\n \"\",\n \"\"\n ],\n \"legitimate_interest_purposes_id\": [\n \"\",\n \"\"\n ],\n \"spi_purposes_id\": [\n \"\",\n \"\"\n ],\n \"cookie_max_duration\": \"\",\n \"cookie_max_duration_unit\": \"months\",\n \"uses_non_cookie_access\": \"\",\n \"deprecated\": \"\",\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/partners/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"category_id\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"contact\": \"\",\n \"website\": \"\",\n \"website_optout\": \"\",\n \"hosts\": [\n \"\",\n \"\"\n ],\n \"url_patterns\": [\n \"\",\n \"\"\n ],\n \"urls\": [\n \"\",\n \"\"\n ],\n \"taxonomy_id\": \"\",\n \"organization_id\": \"\",\n \"country\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\",\n \"namespaces\": {\n \"iab\": \"\",\n \"iab2\": \"\",\n \"didomi\": \"\",\n \"custom\": \"\",\n \"google\": \"\"\n },\n \"default_purposes_id\": [\n \"\",\n \"\"\n ],\n \"legitimate_interest_purposes_id\": [\n \"\",\n \"\"\n ],\n \"spi_purposes_id\": [\n \"\",\n \"\"\n ],\n \"cookie_max_duration\": \"\",\n \"cookie_max_duration_unit\": \"months\",\n \"uses_non_cookie_access\": \"\",\n \"deprecated\": \"\",\n \"notes\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-01fe755c-73dc-4b39-aca6-217896a5aa14" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-99aa0676-9372-44b9-a62d-1e3994303208" }, { "name": "Delete a partner", "id": "2ebfc794-bc76-43f2-a668-1b9d5506dcfc", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/metadata/partners/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners", ":id" ], "variable": [ { "id": "46565898-f093-4838-8a71-729981bf8411", "key": "id", "value": "", "description": "(Required) The ID of the partner to delete" } ] }, "description": "Delete the partner" }, "response": [ { "id": "607c5cc3-1242-450a-9999-d0d6b123b384", "name": "The deleted Partner object", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/metadata/partners/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"category_id\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"contact\": \"\",\n \"website\": \"\",\n \"website_optout\": \"\",\n \"hosts\": [\n \"\",\n \"\"\n ],\n \"url_patterns\": [\n \"\",\n \"\"\n ],\n \"urls\": [\n \"\",\n \"\"\n ],\n \"taxonomy_id\": \"\",\n \"organization_id\": \"\",\n \"country\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\",\n \"namespaces\": {\n \"iab\": \"\",\n \"iab2\": \"\",\n \"didomi\": \"\",\n \"custom\": \"\",\n \"google\": \"\"\n },\n \"default_purposes_id\": [\n \"\",\n \"\"\n ],\n \"legitimate_interest_purposes_id\": [\n \"\",\n \"\"\n ],\n \"spi_purposes_id\": [\n \"\",\n \"\"\n ],\n \"cookie_max_duration\": \"\",\n \"cookie_max_duration_unit\": \"months\",\n \"uses_non_cookie_access\": \"\",\n \"deprecated\": \"\",\n \"notes\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-607c5cc3-1242-450a-9999-d0d6b123b384" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-2ebfc794-bc76-43f2-a668-1b9d5506dcfc" } ], "id": "162032ab-ed70-4950-8512-f5fe78ea21b7", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-162032ab-ed70-4950-8512-f5fe78ea21b7" }, { "name": "Retrieve a list of partners", "id": "fcbb5331-a14c-4919-9b0c-9d476d556558", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/metadata/partners?url=", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners" ], "query": [ { "description": "An URL to match to a partner. This parameter can be repeated multiple times to identify multiple partners at once.", "key": "url", "value": "" } ] }, "description": "Returns a list of partners" }, "response": [ { "id": "2eaf8dff-587f-4cee-90f3-de2e999f7823", "name": "A list of Partner objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/metadata/partners?url=", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners" ], "query": [ { "description": "An URL to match to a partner. This parameter can be repeated multiple times to identify multiple partners at once.", "key": "url", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"category_id\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"contact\": \"\",\n \"website\": \"\",\n \"website_optout\": \"\",\n \"hosts\": [\n \"\",\n \"\"\n ],\n \"url_patterns\": [\n \"\",\n \"\"\n ],\n \"urls\": [\n \"\",\n \"\"\n ],\n \"taxonomy_id\": \"\",\n \"organization_id\": \"\",\n \"country\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\",\n \"namespaces\": {\n \"iab\": \"\",\n \"iab2\": \"\",\n \"didomi\": \"\",\n \"custom\": \"\",\n \"google\": \"\"\n },\n \"default_purposes_id\": [\n \"\",\n \"\"\n ],\n \"legitimate_interest_purposes_id\": [\n \"\",\n \"\"\n ],\n \"spi_purposes_id\": [\n \"\",\n \"\"\n ],\n \"cookie_max_duration\": \"\",\n \"cookie_max_duration_unit\": \"seconds\",\n \"uses_non_cookie_access\": \"\",\n \"deprecated\": \"\",\n \"notes\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"category_id\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"contact\": \"\",\n \"website\": \"\",\n \"website_optout\": \"\",\n \"hosts\": [\n \"\",\n \"\"\n ],\n \"url_patterns\": [\n \"\",\n \"\"\n ],\n \"urls\": [\n \"\",\n \"\"\n ],\n \"taxonomy_id\": \"\",\n \"organization_id\": \"\",\n \"country\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\",\n \"namespaces\": {\n \"iab\": \"\",\n \"iab2\": \"\",\n \"didomi\": \"\",\n \"custom\": \"\",\n \"google\": \"\"\n },\n \"default_purposes_id\": [\n \"\",\n \"\"\n ],\n \"legitimate_interest_purposes_id\": [\n \"\",\n \"\"\n ],\n \"spi_purposes_id\": [\n \"\",\n \"\"\n ],\n \"cookie_max_duration\": \"\",\n \"cookie_max_duration_unit\": \"days\",\n \"uses_non_cookie_access\": \"\",\n \"deprecated\": \"\",\n \"notes\": \"\"\n }\n]", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-2eaf8dff-587f-4cee-90f3-de2e999f7823" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-fcbb5331-a14c-4919-9b0c-9d476d556558" }, { "name": "Create a partner", "id": "81d8e4ca-40b3-4aa6-bbc7-dcadbb2201ba", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"category_id\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"contact\": \"\",\n \"website\": \"\",\n \"website_optout\": \"\",\n \"hosts\": [\n \"\",\n \"\"\n ],\n \"url_patterns\": [\n \"\",\n \"\"\n ],\n \"urls\": [\n \"\",\n \"\"\n ],\n \"taxonomy_id\": \"\",\n \"organization_id\": \"\",\n \"country\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\",\n \"namespaces\": {\n \"iab\": \"\",\n \"iab2\": \"\",\n \"didomi\": \"\",\n \"custom\": \"\",\n \"google\": \"\"\n },\n \"default_purposes_id\": [\n \"\",\n \"\"\n ],\n \"legitimate_interest_purposes_id\": [\n \"\",\n \"\"\n ],\n \"spi_purposes_id\": [\n \"\",\n \"\"\n ],\n \"cookie_max_duration\": \"\",\n \"cookie_max_duration_unit\": \"months\",\n \"uses_non_cookie_access\": \"\",\n \"deprecated\": \"\",\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/partners", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners" ] }, "description": "Create a new partner" }, "response": [ { "id": "b8e97ce9-ee2a-493f-b765-2b3edaa0beb0", "name": "The created Partner object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"category_id\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"contact\": \"\",\n \"website\": \"\",\n \"website_optout\": \"\",\n \"hosts\": [\n \"\",\n \"\"\n ],\n \"url_patterns\": [\n \"\",\n \"\"\n ],\n \"urls\": [\n \"\",\n \"\"\n ],\n \"taxonomy_id\": \"\",\n \"organization_id\": \"\",\n \"country\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\",\n \"namespaces\": {\n \"iab\": \"\",\n \"iab2\": \"\",\n \"didomi\": \"\",\n \"custom\": \"\",\n \"google\": \"\"\n },\n \"default_purposes_id\": [\n \"\",\n \"\"\n ],\n \"legitimate_interest_purposes_id\": [\n \"\",\n \"\"\n ],\n \"spi_purposes_id\": [\n \"\",\n \"\"\n ],\n \"cookie_max_duration\": \"\",\n \"cookie_max_duration_unit\": \"months\",\n \"uses_non_cookie_access\": \"\",\n \"deprecated\": \"\",\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/partners", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"category_id\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"contact\": \"\",\n \"website\": \"\",\n \"website_optout\": \"\",\n \"hosts\": [\n \"\",\n \"\"\n ],\n \"url_patterns\": [\n \"\",\n \"\"\n ],\n \"urls\": [\n \"\",\n \"\"\n ],\n \"taxonomy_id\": \"\",\n \"organization_id\": \"\",\n \"country\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\",\n \"namespaces\": {\n \"iab\": \"\",\n \"iab2\": \"\",\n \"didomi\": \"\",\n \"custom\": \"\",\n \"google\": \"\"\n },\n \"default_purposes_id\": [\n \"\",\n \"\"\n ],\n \"legitimate_interest_purposes_id\": [\n \"\",\n \"\"\n ],\n \"spi_purposes_id\": [\n \"\",\n \"\"\n ],\n \"cookie_max_duration\": \"\",\n \"cookie_max_duration_unit\": \"months\",\n \"uses_non_cookie_access\": \"\",\n \"deprecated\": \"\",\n \"notes\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-b8e97ce9-ee2a-493f-b765-2b3edaa0beb0" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-81d8e4ca-40b3-4aa6-bbc7-dcadbb2201ba" } ], "id": "68b19716-eaf6-4577-b748-155a1c115eae", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-68b19716-eaf6-4577-b748-155a1c115eae" }, { "name": "purposes", "item": [ { "name": "restrictions", "item": [ { "name": "Retrieve a list of available purposes for restrictions. For publisher restriction list.", "id": "5cadf58a-a363-4f87-9e3b-26e42b0c0c0c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/metadata/purposes/restrictions?organization_id=", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "purposes", "restrictions" ], "query": [ { "description": "(Required) The ID of the organization that the user belongs to", "key": "organization_id", "value": "" } ] }, "description": "Returns a list of all purposes" }, "response": [ { "id": "77c467d7-2a68-4abd-97ba-9f61789e8700", "name": "A list of Purpose objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/metadata/purposes/restrictions?organization_id=", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "purposes", "restrictions" ], "query": [ { "description": "(Required) The ID of the organization that the user belongs to", "key": "organization_id", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"total\": \"\",\n \"limit\": \"\",\n \"skip\": \"\",\n \"data\": [\n {\n \"id\": \"\",\n \"description\": {\n \"adipisicing05\": {},\n \"in09\": {},\n \"Utf3\": {}\n },\n \"details\": {\n \"Duis_d7\": {},\n \"cupidatata\": {}\n },\n \"enabled_status_description\": {},\n \"disabled_status_description\": {},\n \"reference\": {\n \"officia_0\": {},\n \"etd\": {},\n \"sunt_8\": {},\n \"adipisicing02b\": {},\n \"occaecat_0_e\": {}\n },\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"namespaces\": {\n \"iab\": \"\",\n \"iab2\": \"\",\n \"iab2_special_feature\": \"\",\n \"didomi\": \"\",\n \"custom\": \"\"\n },\n \"regulations_id\": [\n \"\",\n \"\"\n ],\n \"type\": \"purpose\",\n \"metadata\": {\n \"irure7ae\": {},\n \"laboris_52\": {},\n \"nulla413\": {}\n }\n },\n {\n \"id\": \"\",\n \"description\": {\n \"nulla_850\": {}\n },\n \"details\": {\n \"non_17_\": {}\n },\n \"enabled_status_description\": {},\n \"disabled_status_description\": {},\n \"reference\": {\n \"tempor_c\": {},\n \"eu_6\": {}\n },\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"namespaces\": {\n \"iab\": \"\",\n \"iab2\": \"\",\n \"iab2_special_feature\": \"\",\n \"didomi\": \"\",\n \"custom\": \"\"\n },\n \"regulations_id\": [\n \"\",\n \"\"\n ],\n \"type\": \"purpose\",\n \"metadata\": {\n \"in_32d\": {},\n \"fugiat_9\": {}\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-77c467d7-2a68-4abd-97ba-9f61789e8700" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-5cadf58a-a363-4f87-9e3b-26e42b0c0c0c" } ], "id": "498529a0-2dd5-41e0-8d03-91c87e74a178", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-498529a0-2dd5-41e0-8d03-91c87e74a178" }, { "name": "{id}", "item": [ { "name": "Retrieve a purpose", "id": "d503a1f6-3bde-4431-9fab-6cd88f7514d3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/metadata/purposes/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "purposes", ":id" ], "variable": [ { "id": "71064191-778c-4321-b5fb-b4d2ab28641b", "key": "id", "value": "", "description": "(Required) The ID of the purpose to retrieve" } ] }, "description": "Returns a single purpose with the given ID" }, "response": [ { "id": "e2ffc543-7a26-453f-a6ed-4881f5b5fd11", "name": "A Purpose object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/metadata/purposes/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "purposes", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"description\": {\n \"nisi303\": {},\n \"culpa_f99\": {}\n },\n \"details\": {\n \"nullae78\": {}\n },\n \"enabled_status_description\": {},\n \"disabled_status_description\": {},\n \"reference\": {\n \"aliquaa9\": {}\n },\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"namespaces\": {\n \"iab\": \"\",\n \"iab2\": \"\",\n \"iab2_special_feature\": \"\",\n \"didomi\": \"\",\n \"custom\": \"\"\n },\n \"regulations_id\": [\n \"\",\n \"\"\n ],\n \"type\": \"purpose\",\n \"metadata\": {\n \"in_1\": {},\n \"esse_9f1\": {}\n }\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-e2ffc543-7a26-453f-a6ed-4881f5b5fd11" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-d503a1f6-3bde-4431-9fab-6cd88f7514d3" }, { "name": "Update a purpose", "id": "be7a7f2f-b30c-45e1-84c0-492757499ba1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"description\": {\n \"description\": \"Name of the purpose\",\n \"schema\": {}\n },\n \"details\": {\n \"description\": \"Details of the purpose\",\n \"schema\": {}\n },\n \"enabled_status_description\": {\n \"description\": \"Description of the purpose when the sdk status for the user for this purpose is enabled\",\n \"schema\": {}\n },\n \"disabled_status_description\": {\n \"description\": \"Description of the purpose when the sdk status for the user for this purpose is disabled\",\n \"schema\": {}\n },\n \"reference\": {\n \"description\": \"The reference number uniquely identifies the purpose in an official classification like the one from the CNIL\",\n \"schema\": {}\n },\n \"organization_id\": \"\",\n \"namespaces\": {\n \"iab\": \"\",\n \"iab2\": \"\",\n \"didomi\": \"\",\n \"custom\": \"\"\n },\n \"metadata\": {\n \"esse_a\": {},\n \"nulla_1\": {}\n },\n \"regulations_id\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/purposes/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "purposes", ":id" ], "variable": [ { "id": "3c4bf07a-b52e-4c19-acc5-4435c33cfcc1", "key": "id", "value": "", "description": "(Required) The ID of the purpose to update" } ] }, "description": "Update an existing purpose and replace all its properties" }, "response": [ { "id": "d455b902-a887-476f-bab1-071dd6621055", "name": "The updated Purpose object", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"description\": {\n \"description\": \"Name of the purpose\",\n \"schema\": {}\n },\n \"details\": {\n \"description\": \"Details of the purpose\",\n \"schema\": {}\n },\n \"enabled_status_description\": {\n \"description\": \"Description of the purpose when the sdk status for the user for this purpose is enabled\",\n \"schema\": {}\n },\n \"disabled_status_description\": {\n \"description\": \"Description of the purpose when the sdk status for the user for this purpose is disabled\",\n \"schema\": {}\n },\n \"reference\": {\n \"description\": \"The reference number uniquely identifies the purpose in an official classification like the one from the CNIL\",\n \"schema\": {}\n },\n \"organization_id\": \"\",\n \"namespaces\": {\n \"iab\": \"\",\n \"iab2\": \"\",\n \"didomi\": \"\",\n \"custom\": \"\"\n },\n \"metadata\": {\n \"esse_a\": {},\n \"nulla_1\": {}\n },\n \"regulations_id\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/purposes/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "purposes", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"description\": {\n \"nisi303\": {},\n \"culpa_f99\": {}\n },\n \"details\": {\n \"nullae78\": {}\n },\n \"enabled_status_description\": {},\n \"disabled_status_description\": {},\n \"reference\": {\n \"aliquaa9\": {}\n },\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"namespaces\": {\n \"iab\": \"\",\n \"iab2\": \"\",\n \"iab2_special_feature\": \"\",\n \"didomi\": \"\",\n \"custom\": \"\"\n },\n \"regulations_id\": [\n \"\",\n \"\"\n ],\n \"type\": \"purpose\",\n \"metadata\": {\n \"in_1\": {},\n \"esse_9f1\": {}\n }\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-d455b902-a887-476f-bab1-071dd6621055" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-be7a7f2f-b30c-45e1-84c0-492757499ba1" }, { "name": "Patch a purpose", "id": "261b6f22-e8e2-464c-92e9-737a82d93d93", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"description\": {\n \"description\": \"Name of the purpose\",\n \"schema\": {}\n },\n \"details\": {\n \"description\": \"Details of the purpose\",\n \"schema\": {}\n },\n \"enabled_status_description\": {\n \"description\": \"Description of the purpose when the sdk status for the user for this purpose is enabled\",\n \"schema\": {}\n },\n \"disabled_status_description\": {\n \"description\": \"Description of the purpose when the sdk status for the user for this purpose is disabled\",\n \"schema\": {}\n },\n \"reference\": {\n \"description\": \"The reference number uniquely identifies the purpose in an official classification like the one from the CNIL\",\n \"schema\": {}\n },\n \"organization_id\": \"\",\n \"namespaces\": {\n \"iab\": \"\",\n \"iab2\": \"\",\n \"didomi\": \"\",\n \"custom\": \"\"\n },\n \"metadata\": {\n \"esse_a\": {},\n \"nulla_1\": {}\n },\n \"regulations_id\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/purposes/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "purposes", ":id" ], "variable": [ { "id": "6bea0442-5b17-425c-a375-94c5c254f603", "key": "id", "value": "", "description": "(Required) The ID of the purpose to patch" } ] }, "description": "Partially update a purpose" }, "response": [ { "id": "fe13e6ee-992b-463a-bde6-5b072a1dcc3a", "name": "The patched Purpose object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"description\": {\n \"description\": \"Name of the purpose\",\n \"schema\": {}\n },\n \"details\": {\n \"description\": \"Details of the purpose\",\n \"schema\": {}\n },\n \"enabled_status_description\": {\n \"description\": \"Description of the purpose when the sdk status for the user for this purpose is enabled\",\n \"schema\": {}\n },\n \"disabled_status_description\": {\n \"description\": \"Description of the purpose when the sdk status for the user for this purpose is disabled\",\n \"schema\": {}\n },\n \"reference\": {\n \"description\": \"The reference number uniquely identifies the purpose in an official classification like the one from the CNIL\",\n \"schema\": {}\n },\n \"organization_id\": \"\",\n \"namespaces\": {\n \"iab\": \"\",\n \"iab2\": \"\",\n \"didomi\": \"\",\n \"custom\": \"\"\n },\n \"metadata\": {\n \"esse_a\": {},\n \"nulla_1\": {}\n },\n \"regulations_id\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/purposes/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "purposes", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"description\": {\n \"nisi303\": {},\n \"culpa_f99\": {}\n },\n \"details\": {\n \"nullae78\": {}\n },\n \"enabled_status_description\": {},\n \"disabled_status_description\": {},\n \"reference\": {\n \"aliquaa9\": {}\n },\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"namespaces\": {\n \"iab\": \"\",\n \"iab2\": \"\",\n \"iab2_special_feature\": \"\",\n \"didomi\": \"\",\n \"custom\": \"\"\n },\n \"regulations_id\": [\n \"\",\n \"\"\n ],\n \"type\": \"purpose\",\n \"metadata\": {\n \"in_1\": {},\n \"esse_9f1\": {}\n }\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-fe13e6ee-992b-463a-bde6-5b072a1dcc3a" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-261b6f22-e8e2-464c-92e9-737a82d93d93" }, { "name": "Delete a purpose", "id": "fd303d1e-a2de-4534-b7ac-b6ef0e3d5b6c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/metadata/purposes/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "purposes", ":id" ], "variable": [ { "id": "84403dcb-7188-4dee-9cb5-e401f5692025", "key": "id", "value": "", "description": "(Required) The ID of the purpose to delete" } ] }, "description": "Delete an existing purpose" }, "response": [ { "id": "61843859-0c1d-4ecf-aee6-c0d72238b8b2", "name": "The deleted Purpose object", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/metadata/purposes/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "purposes", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"description\": {\n \"nisi303\": {},\n \"culpa_f99\": {}\n },\n \"details\": {\n \"nullae78\": {}\n },\n \"enabled_status_description\": {},\n \"disabled_status_description\": {},\n \"reference\": {\n \"aliquaa9\": {}\n },\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"namespaces\": {\n \"iab\": \"\",\n \"iab2\": \"\",\n \"iab2_special_feature\": \"\",\n \"didomi\": \"\",\n \"custom\": \"\"\n },\n \"regulations_id\": [\n \"\",\n \"\"\n ],\n \"type\": \"purpose\",\n \"metadata\": {\n \"in_1\": {},\n \"esse_9f1\": {}\n }\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-61843859-0c1d-4ecf-aee6-c0d72238b8b2" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-fd303d1e-a2de-4534-b7ac-b6ef0e3d5b6c" } ], "id": "3574f2e0-722f-4371-8738-397cf2b28603", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-3574f2e0-722f-4371-8738-397cf2b28603" }, { "name": "Retrieve a list of purposes", "id": "8ccc063f-f799-48ad-ac9b-554395d95e81", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/metadata/purposes?$translations=&organization_id=&$limit=&$skip=&updated_at=&created_at=", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "purposes" ], "query": [ { "description": "If true, will return translatable fields as objects with translations", "key": "$translations", "value": "" }, { "description": "(Required) The ID of the organization that the user belongs to", "key": "organization_id", "value": "" }, { "description": "Number of max results to return", "key": "$limit", "value": "" }, { "description": "Number of results to skip", "key": "$skip", "value": "" }, { "description": "Object representing sorting options. Accepts properties to sort as keys and -1 or 1 for sort direction", "key": "updated_at", "value": "" }, { "description": "Object representing sorting options. Accepts properties to sort as keys and -1 or 1 for sort direction", "key": "created_at", "value": "" } ] }, "description": "Returns a list of all purposes" }, "response": [ { "id": "8ac80242-1812-45fe-9eb6-577eb401733a", "name": "A list of Purpose objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/metadata/purposes?$translations=&organization_id=&$limit=&$skip=&updated_at=&created_at=", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "purposes" ], "query": [ { "description": "If true, will return translatable fields as objects with translations", "key": "$translations", "value": "" }, { "description": "(Required) The ID of the organization that the user belongs to", "key": "organization_id", "value": "" }, { "description": "Number of max results to return", "key": "$limit", "value": "" }, { "description": "Number of results to skip", "key": "$skip", "value": "" }, { "description": "Object representing sorting options. Accepts properties to sort as keys and -1 or 1 for sort direction", "key": "updated_at", "value": "" }, { "description": "Object representing sorting options. Accepts properties to sort as keys and -1 or 1 for sort direction", "key": "created_at", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"total\": \"\",\n \"limit\": \"\",\n \"skip\": \"\",\n \"data\": [\n {\n \"id\": \"\",\n \"description\": {\n \"adipisicing05\": {},\n \"in09\": {},\n \"Utf3\": {}\n },\n \"details\": {\n \"Duis_d7\": {},\n \"cupidatata\": {}\n },\n \"enabled_status_description\": {},\n \"disabled_status_description\": {},\n \"reference\": {\n \"officia_0\": {},\n \"etd\": {},\n \"sunt_8\": {},\n \"adipisicing02b\": {},\n \"occaecat_0_e\": {}\n },\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"namespaces\": {\n \"iab\": \"\",\n \"iab2\": \"\",\n \"iab2_special_feature\": \"\",\n \"didomi\": \"\",\n \"custom\": \"\"\n },\n \"regulations_id\": [\n \"\",\n \"\"\n ],\n \"type\": \"purpose\",\n \"metadata\": {\n \"irure7ae\": {},\n \"laboris_52\": {},\n \"nulla413\": {}\n }\n },\n {\n \"id\": \"\",\n \"description\": {\n \"nulla_850\": {}\n },\n \"details\": {\n \"non_17_\": {}\n },\n \"enabled_status_description\": {},\n \"disabled_status_description\": {},\n \"reference\": {\n \"tempor_c\": {},\n \"eu_6\": {}\n },\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"namespaces\": {\n \"iab\": \"\",\n \"iab2\": \"\",\n \"iab2_special_feature\": \"\",\n \"didomi\": \"\",\n \"custom\": \"\"\n },\n \"regulations_id\": [\n \"\",\n \"\"\n ],\n \"type\": \"purpose\",\n \"metadata\": {\n \"in_32d\": {},\n \"fugiat_9\": {}\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-8ac80242-1812-45fe-9eb6-577eb401733a" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-8ccc063f-f799-48ad-ac9b-554395d95e81" }, { "name": "Create a purpose", "id": "7ea91051-ec42-46a1-a3ab-75c9b9edb921", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"description\": {\n \"description\": \"Name of the purpose\",\n \"schema\": {}\n },\n \"details\": {\n \"description\": \"Details of the purpose\",\n \"schema\": {}\n },\n \"enabled_status_description\": {\n \"description\": \"Description of the purpose when the sdk status for the user for this purpose is enabled\",\n \"schema\": {}\n },\n \"disabled_status_description\": {\n \"description\": \"Description of the purpose when the sdk status for the user for this purpose is disabled\",\n \"schema\": {}\n },\n \"reference\": {\n \"description\": \"The reference number uniquely identifies the purpose in an official classification like the one from the CNIL\",\n \"schema\": {}\n },\n \"organization_id\": \"\",\n \"namespaces\": {\n \"iab\": \"\",\n \"iab2\": \"\",\n \"didomi\": \"\",\n \"custom\": \"\"\n },\n \"regulations_id\": [\n \"\",\n \"\"\n ],\n \"metadata\": {\n \"Ut_3\": {},\n \"none6\": {},\n \"reprehenderitf\": {}\n },\n \"type\": \"purpose\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/purposes", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "purposes" ] }, "description": "Create a new purpose" }, "response": [ { "id": "7988e5de-eb30-4076-a18a-1ae25ddba80c", "name": "The created Purpose object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"description\": {\n \"description\": \"Name of the purpose\",\n \"schema\": {}\n },\n \"details\": {\n \"description\": \"Details of the purpose\",\n \"schema\": {}\n },\n \"enabled_status_description\": {\n \"description\": \"Description of the purpose when the sdk status for the user for this purpose is enabled\",\n \"schema\": {}\n },\n \"disabled_status_description\": {\n \"description\": \"Description of the purpose when the sdk status for the user for this purpose is disabled\",\n \"schema\": {}\n },\n \"reference\": {\n \"description\": \"The reference number uniquely identifies the purpose in an official classification like the one from the CNIL\",\n \"schema\": {}\n },\n \"organization_id\": \"\",\n \"namespaces\": {\n \"iab\": \"\",\n \"iab2\": \"\",\n \"didomi\": \"\",\n \"custom\": \"\"\n },\n \"regulations_id\": [\n \"\",\n \"\"\n ],\n \"metadata\": {\n \"Ut_3\": {},\n \"none6\": {},\n \"reprehenderitf\": {}\n },\n \"type\": \"purpose\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/purposes", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "purposes" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"description\": {\n \"nisi303\": {},\n \"culpa_f99\": {}\n },\n \"details\": {\n \"nullae78\": {}\n },\n \"enabled_status_description\": {},\n \"disabled_status_description\": {},\n \"reference\": {\n \"aliquaa9\": {}\n },\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"namespaces\": {\n \"iab\": \"\",\n \"iab2\": \"\",\n \"iab2_special_feature\": \"\",\n \"didomi\": \"\",\n \"custom\": \"\"\n },\n \"regulations_id\": [\n \"\",\n \"\"\n ],\n \"type\": \"purpose\",\n \"metadata\": {\n \"in_1\": {},\n \"esse_9f1\": {}\n }\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-7988e5de-eb30-4076-a18a-1ae25ddba80c" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-7ea91051-ec42-46a1-a3ab-75c9b9edb921" } ], "id": "8844d23b-7f19-4e2d-aee0-c30383f6480f", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-8844d23b-7f19-4e2d-aee0-c30383f6480f" }, { "name": "vendors", "item": [ { "name": "{id}", "item": [ { "name": "Retrieve a vendor", "id": "fa08c03c-a608-4e62-8472-b8e1c12ba51f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/metadata/vendors/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "vendors", ":id" ], "variable": [ { "id": "b70961e9-361d-4e98-ac6c-ef02aa93bd09", "key": "id", "value": "", "description": "(Required) The ID of the vendor to retrieve" } ] }, "description": "Returns a single vendor with the given ID" }, "response": [ { "id": "54e0f917-0bb5-4f5c-a8a1-f35c95f057e6", "name": "A Vendor object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/metadata/vendors/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "vendors", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"website\": \"\",\n \"website_optout\": \"\",\n \"hosts\": [\n \"\",\n \"\"\n ],\n \"url_patterns\": [\n \"\",\n \"\"\n ],\n \"urls\": [\n \"\",\n \"\"\n ],\n \"taxonomy_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-54e0f917-0bb5-4f5c-a8a1-f35c95f057e6" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-fa08c03c-a608-4e62-8472-b8e1c12ba51f" }, { "name": "Update a vendor", "id": "180d06fb-ac88-4e86-bdb0-366fb88849dc", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"property_id\": \"\",\n \"metadata_id\": \"\",\n \"status\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/vendors/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "vendors", ":id" ], "variable": [ { "id": "a13e0657-0f83-4c53-aa8f-e891d043132f", "key": "id", "value": "", "description": "(Required) The ID of the vendor to update" } ] }, "description": "Update an existing vendor" }, "response": [ { "id": "653a74cb-d832-455b-bd7e-46f104685104", "name": "The updated Vendor object", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"property_id\": \"\",\n \"metadata_id\": \"\",\n \"status\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/vendors/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "vendors", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"website\": \"\",\n \"website_optout\": \"\",\n \"hosts\": [\n \"\",\n \"\"\n ],\n \"url_patterns\": [\n \"\",\n \"\"\n ],\n \"urls\": [\n \"\",\n \"\"\n ],\n \"taxonomy_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-653a74cb-d832-455b-bd7e-46f104685104" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-180d06fb-ac88-4e86-bdb0-366fb88849dc" }, { "name": "Patch a vendor", "id": "ad1f0a45-76a2-4343-a763-7b03a445e6b3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"property_id\": \"\",\n \"metadata_id\": \"\",\n \"status\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/vendors/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "vendors", ":id" ], "variable": [ { "id": "bba5ceb9-8b69-40ba-a7d7-3d7c4d234bd8", "key": "id", "value": "", "description": "(Required) The ID of the vendor to patch" } ] }, "description": "Partially update a vendor" }, "response": [ { "id": "85b4b3e9-b8f8-4566-8a33-e4aaebcef94d", "name": "The patched Vendor object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"property_id\": \"\",\n \"metadata_id\": \"\",\n \"status\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/vendors/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "vendors", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"website\": \"\",\n \"website_optout\": \"\",\n \"hosts\": [\n \"\",\n \"\"\n ],\n \"url_patterns\": [\n \"\",\n \"\"\n ],\n \"urls\": [\n \"\",\n \"\"\n ],\n \"taxonomy_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-85b4b3e9-b8f8-4566-8a33-e4aaebcef94d" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-ad1f0a45-76a2-4343-a763-7b03a445e6b3" }, { "name": "Delete a vendor", "id": "d3b2bdc8-578a-48cc-a126-78879ae34860", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/metadata/vendors/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "vendors", ":id" ], "variable": [ { "id": "a4d4f934-5de0-4715-b3f7-64b5ffb32fc7", "key": "id", "value": "", "description": "(Required) The ID of the vendor to delete" } ] }, "description": "Delete the vendor" }, "response": [ { "id": "0dca5a5a-3296-4105-b283-4284e0bb3a2a", "name": "The deleted Vendor object", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/metadata/vendors/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "vendors", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"property_id\": \"\",\n \"metadata_id\": \"\",\n \"status\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-0dca5a5a-3296-4105-b283-4284e0bb3a2a" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-d3b2bdc8-578a-48cc-a126-78879ae34860" } ], "id": "d151af6f-a612-4a92-afdd-140765bab0db", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-d151af6f-a612-4a92-afdd-140765bab0db" }, { "name": "Retrieve a list of vendors", "id": "9e87b0f1-45c8-46a3-8a21-55538ff59b77", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/metadata/vendors?url=", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "vendors" ], "query": [ { "description": "An URL to match to a vendor. This parameter can be repeated multiple times to identify multiple vendors at once.", "key": "url", "value": "" } ] }, "description": "Returns a list of vendors" }, "response": [ { "id": "cfe76056-84f6-4ff8-8b1e-09dca466f747", "name": "A list of Vendor objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/metadata/vendors?url=", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "vendors" ], "query": [ { "description": "An URL to match to a vendor. This parameter can be repeated multiple times to identify multiple vendors at once.", "key": "url", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"website\": \"\",\n \"website_optout\": \"\",\n \"hosts\": [\n \"\",\n \"\"\n ],\n \"url_patterns\": [\n \"\",\n \"\"\n ],\n \"urls\": [\n \"\",\n \"\"\n ],\n \"taxonomy_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"website\": \"\",\n \"website_optout\": \"\",\n \"hosts\": [\n \"\",\n \"\"\n ],\n \"url_patterns\": [\n \"\",\n \"\"\n ],\n \"urls\": [\n \"\",\n \"\"\n ],\n \"taxonomy_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n }\n]", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-cfe76056-84f6-4ff8-8b1e-09dca466f747" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-9e87b0f1-45c8-46a3-8a21-55538ff59b77" }, { "name": "Create a vendor", "id": "d949d741-d307-4978-a36d-501c126cb79a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"property_id\": \"\",\n \"metadata_id\": \"\",\n \"status\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/vendors", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "vendors" ] }, "description": "Create a new vendor" }, "response": [ { "id": "2a4aab5a-52bf-42d0-9b2a-7e658fc25fcf", "name": "The created Vendor object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"property_id\": \"\",\n \"metadata_id\": \"\",\n \"status\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/vendors", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "vendors" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"website\": \"\",\n \"website_optout\": \"\",\n \"hosts\": [\n \"\",\n \"\"\n ],\n \"url_patterns\": [\n \"\",\n \"\"\n ],\n \"urls\": [\n \"\",\n \"\"\n ],\n \"taxonomy_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-2a4aab5a-52bf-42d0-9b2a-7e658fc25fcf" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-d949d741-d307-4978-a36d-501c126cb79a" } ], "id": "db361b86-3746-4a8c-81d2-ea143ebcad4b", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-db361b86-3746-4a8c-81d2-ea143ebcad4b" }, { "name": "purposes-groups", "item": [ { "name": "{id}", "item": [ { "name": "Retrieve a group of purposes", "id": "9d9a75e4-1e63-4ec4-a8de-51cba95b1e13", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/metadata/purposes-groups/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "purposes-groups", ":id" ], "variable": [ { "id": "82cb8ea3-d6c9-44f7-bcb8-26605abddfc3", "key": "id", "value": "", "description": "(Required) The ID of the group to retrieve" } ] }, "description": "Returns a single group with the given ID" }, "response": [ { "id": "4586469f-c00b-497b-8843-36b6e4c3f556", "name": "A PurposesGroup object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/metadata/purposes-groups/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "purposes-groups", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"name\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"namespaces\": {\n \"iab2\": \"\"\n },\n \"purposes_id\": [\n \"\",\n \"\"\n ],\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-4586469f-c00b-497b-8843-36b6e4c3f556" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-9d9a75e4-1e63-4ec4-a8de-51cba95b1e13" }, { "name": "Update a group of purposes", "id": "bd4cf5e2-0139-4755-a72a-a1369446b27e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"namespaces\": {\n \"iab2\": \"\"\n },\n \"purposes_id\": [\n \"\",\n \"\"\n ],\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/purposes-groups/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "purposes-groups", ":id" ], "variable": [ { "id": "62332794-df2f-4d79-9d31-3266122c19e7", "key": "id", "value": "", "description": "(Required) The ID of the group to update" } ] }, "description": "Update an existing group of purposes and replace all its properties" }, "response": [ { "id": "20b92594-a74a-4d0f-95ab-490e56a99517", "name": "The updated PurposesGroup object", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"namespaces\": {\n \"iab2\": \"\"\n },\n \"purposes_id\": [\n \"\",\n \"\"\n ],\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/purposes-groups/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "purposes-groups", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"name\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"namespaces\": {\n \"iab2\": \"\"\n },\n \"purposes_id\": [\n \"\",\n \"\"\n ],\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-20b92594-a74a-4d0f-95ab-490e56a99517" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-bd4cf5e2-0139-4755-a72a-a1369446b27e" }, { "name": "Patch a group of purposes", "id": "1a07bb3c-135b-4d2d-b210-7923be8f5b4a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"namespaces\": {\n \"iab2\": \"\"\n },\n \"purposes_id\": [\n \"\",\n \"\"\n ],\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/purposes-groups/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "purposes-groups", ":id" ], "variable": [ { "id": "a027ff58-e7df-45fc-92cb-97ee3d8d9011", "key": "id", "value": "", "description": "(Required) The ID of the group of purposes to patch" } ] }, "description": "Partially update a group of purposes" }, "response": [ { "id": "2a43be66-d7bf-4573-a111-6a34247de061", "name": "The patched PurposesGroup object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"namespaces\": {\n \"iab2\": \"\"\n },\n \"purposes_id\": [\n \"\",\n \"\"\n ],\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/purposes-groups/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "purposes-groups", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"name\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"namespaces\": {\n \"iab2\": \"\"\n },\n \"purposes_id\": [\n \"\",\n \"\"\n ],\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-2a43be66-d7bf-4573-a111-6a34247de061" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-1a07bb3c-135b-4d2d-b210-7923be8f5b4a" }, { "name": "Delete a group of purposes", "id": "37cfb4c1-d8b3-441d-956f-d9b3410bdd76", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/metadata/purposes-groups/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "purposes-groups", ":id" ], "variable": [ { "id": "4a9ead4e-b93a-44c1-80b5-2cc2675752bd", "key": "id", "value": "", "description": "(Required) The ID of the group to delete" } ] }, "description": "Delete an existing group of purposes" }, "response": [ { "id": "d0d6c127-adc6-4939-a36f-94509ee3cf3b", "name": "The deleted PurposesGroup object", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/metadata/purposes-groups/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "purposes-groups", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"name\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"namespaces\": {\n \"iab2\": \"\"\n },\n \"purposes_id\": [\n \"\",\n \"\"\n ],\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-d0d6c127-adc6-4939-a36f-94509ee3cf3b" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-37cfb4c1-d8b3-441d-956f-d9b3410bdd76" } ], "id": "5fb5a43a-01a9-40b0-a991-4fbe46893b45", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-5fb5a43a-01a9-40b0-a991-4fbe46893b45" }, { "name": "Retrieve a list of purposes groups", "id": "f1477db8-7571-4f5d-b6ab-64056b7b118f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/metadata/purposes-groups?$limit=&$skip=&name=&id=&description=&namespaces=[object Object]&purposes_id=,&organization_id=&created_at=&updated_at=", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "purposes-groups" ], "query": [ { "description": "Number of results to return", "key": "$limit", "value": "" }, { "description": "Number of results to skip", "key": "$skip", "value": "" }, { "description": "Query parameters to filter", "key": "name", "value": "" }, { "description": "Query parameters to filter", "key": "id", "value": "" }, { "description": "Query parameters to filter", "key": "description", "value": "" }, { "description": "Query parameters to filter", "key": "namespaces", "value": "[object Object]" }, { "description": "Query parameters to filter", "key": "purposes_id", "value": "," }, { "description": "Query parameters to filter", "key": "organization_id", "value": "" }, { "description": "Query parameters to filter", "key": "created_at", "value": "" }, { "description": "Query parameters to filter", "key": "updated_at", "value": "" } ] }, "description": "Returns a list of all purposes groups" }, "response": [ { "id": "3dc501f9-fe22-4b6b-b8bd-0a5ca367c5ca", "name": "A list of PurposesGroup objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/metadata/purposes-groups?$limit=&$skip=&name=&id=&description=&namespaces=[object Object]&purposes_id=,&organization_id=&created_at=&updated_at=", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "purposes-groups" ], "query": [ { "description": "Number of results to return", "key": "$limit", "value": "" }, { "description": "Number of results to skip", "key": "$skip", "value": "" }, { "description": "Query parameters to filter", "key": "name", "value": "" }, { "description": "Query parameters to filter", "key": "id", "value": "" }, { "description": "Query parameters to filter", "key": "description", "value": "" }, { "description": "Query parameters to filter", "key": "namespaces", "value": "[object Object]" }, { "description": "Query parameters to filter", "key": "purposes_id", "value": "," }, { "description": "Query parameters to filter", "key": "organization_id", "value": "" }, { "description": "Query parameters to filter", "key": "created_at", "value": "" }, { "description": "Query parameters to filter", "key": "updated_at", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"name\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"namespaces\": {\n \"iab2\": \"\"\n },\n \"purposes_id\": [\n \"\",\n \"\"\n ],\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"namespaces\": {\n \"iab2\": \"\"\n },\n \"purposes_id\": [\n \"\",\n \"\"\n ],\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n]", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-3dc501f9-fe22-4b6b-b8bd-0a5ca367c5ca" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-f1477db8-7571-4f5d-b6ab-64056b7b118f" }, { "name": "Create a group of purposes", "id": "40d493d3-5ffa-4434-8ce3-3a41ec5a27bd", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"namespaces\": {\n \"iab2\": \"\"\n },\n \"purposes_id\": [\n \"\",\n \"\"\n ],\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/purposes-groups", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "purposes-groups" ] }, "description": "Create a new group of purposes" }, "response": [ { "id": "4a6a4d4e-f7fa-40b3-a69e-bcfa75b32d09", "name": "The created PurposesGroup object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"namespaces\": {\n \"iab2\": \"\"\n },\n \"purposes_id\": [\n \"\",\n \"\"\n ],\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/purposes-groups", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "purposes-groups" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"name\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"namespaces\": {\n \"iab2\": \"\"\n },\n \"purposes_id\": [\n \"\",\n \"\"\n ],\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-4a6a4d4e-f7fa-40b3-a69e-bcfa75b32d09" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-40d493d3-5ffa-4434-8ce3-3a41ec5a27bd" } ], "id": "db6a5832-22c2-4a18-b360-e8d659cc17cd", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-db6a5832-22c2-4a18-b360-e8d659cc17cd" }, { "name": "purposes-regulations-overrides", "item": [ { "name": "{id}", "item": [ { "name": "Retrieve a MetadataPurposeRegulationOverride", "id": "01bde36c-1afa-4a7d-bd49-19fbc6acc81c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/metadata/purposes-regulations-overrides/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "purposes-regulations-overrides", ":id" ], "variable": [ { "id": "0054ad8e-dc1f-461c-b599-0a45b7983729", "key": "id", "value": "", "description": "(Required) The ID of the MetadataPurposeRegulationOverride to retrieve" } ] }, "description": "Returns a single MetadataPurposeRegulationOverride with the given ID" }, "response": [ { "id": "2c53d24b-5078-4024-919e-7191a4682192", "name": "A MetadataPurposeRegulationOverride", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/metadata/purposes-regulations-overrides/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "purposes-regulations-overrides", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"metadata_purpose_id\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"deleted_at\": \"\",\n \"regulations_id\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-2c53d24b-5078-4024-919e-7191a4682192" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-01bde36c-1afa-4a7d-bd49-19fbc6acc81c" }, { "name": "Update a MetadataPurposeRegulationOverride", "id": "b0c38d92-1c3e-4ae6-8852-5adbe98e8d38", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"regulations_id\": [\n \"\",\n \"\"\n ],\n \"metadata_purpose_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/purposes-regulations-overrides/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "purposes-regulations-overrides", ":id" ], "variable": [ { "id": "efa396a2-c7f9-4942-9a01-d2d5db550ae7", "key": "id", "value": "", "description": "(Required) The ID of the MetadataPurposeRegulationOverride to update" } ] }, "description": "Update an existing MetadataPurposeRegulationOverride and replace all its properties" }, "response": [ { "id": "0f735893-ff1b-43e1-8ef0-a36125407da5", "name": "The updated MetadataPurposeRegulationOverride object", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"regulations_id\": [\n \"\",\n \"\"\n ],\n \"metadata_purpose_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/purposes-regulations-overrides/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "purposes-regulations-overrides", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"metadata_purpose_id\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"deleted_at\": \"\",\n \"regulations_id\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-0f735893-ff1b-43e1-8ef0-a36125407da5" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-b0c38d92-1c3e-4ae6-8852-5adbe98e8d38" }, { "name": "Patch a MetadataPurposeRegulationOverride", "id": "d01a25fe-107a-48ca-867c-193ad0743913", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"regulations_id\": [\n \"\",\n \"\"\n ],\n \"metadata_purpose_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/purposes-regulations-overrides/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "purposes-regulations-overrides", ":id" ], "variable": [ { "id": "0b7e8fb8-46e1-4a19-b944-6b40e4bf300b", "key": "id", "value": "", "description": "(Required) The ID of the MetadataPurposeRegulationOverride to patch" } ] }, "description": "Partially update a MetadataPurposeRegulationOverride" }, "response": [ { "id": "c292d13a-b94e-4164-8110-218a47fea2b8", "name": "The patched MetadataPurposeRegulationOverride object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"regulations_id\": [\n \"\",\n \"\"\n ],\n \"metadata_purpose_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/purposes-regulations-overrides/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "purposes-regulations-overrides", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"metadata_purpose_id\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"deleted_at\": \"\",\n \"regulations_id\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-c292d13a-b94e-4164-8110-218a47fea2b8" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-d01a25fe-107a-48ca-867c-193ad0743913" }, { "name": "Delete a MetadataPurposeRegulationOverride", "id": "fe9acc0e-8c84-4d0a-a51a-412a28bb13f3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/metadata/purposes-regulations-overrides/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "purposes-regulations-overrides", ":id" ], "variable": [ { "id": "62fb740e-f2ae-4a2f-a17d-667e9776d160", "key": "id", "value": "", "description": "(Required) The ID of the MetadataPurposeRegulationOverride to delete" } ] }, "description": "Delete an existing MetadataPurposeRegulationOverride" }, "response": [ { "id": "86eda2a8-bd05-4d0d-8b7f-3cfea4d3ca27", "name": "The deleted MetadataPurposeRegulationOverride object", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/metadata/purposes-regulations-overrides/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "purposes-regulations-overrides", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"metadata_purpose_id\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"deleted_at\": \"\",\n \"regulations_id\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-86eda2a8-bd05-4d0d-8b7f-3cfea4d3ca27" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-fe9acc0e-8c84-4d0a-a51a-412a28bb13f3" } ], "id": "71f72621-7ce6-4123-b81c-6c1d2b39d076", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-71f72621-7ce6-4123-b81c-6c1d2b39d076" }, { "name": "Retrieve a list of MetadataPurposeRegulationOverrides.", "id": "68528139-8cad-4171-ab4a-70bd51e5c2de", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/metadata/purposes-regulations-overrides?organization_id=&$limit=&$skip=&$sort=", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "purposes-regulations-overrides" ], "query": [ { "description": "The ID of the organization for which to filter overrides", "key": "organization_id", "value": "" }, { "description": "Number of max results to return", "key": "$limit", "value": "" }, { "description": "Number of results to skip", "key": "$skip", "value": "" }, { "description": "Object representing sorting options. Accepts properties to sort as keys and -1 or 1 for sort direction", "key": "$sort", "value": "" } ] }, "description": "Returns a list of all MetadataPurposeRegulationOverrides. A null value of `regulations_id` means all regulations are supported, and an empty array means no regulations are supported." }, "response": [ { "id": "2a0cbc26-1175-4290-bff5-bf8aee805188", "name": "A list of MetadataPurposeRegulationOverride objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/metadata/purposes-regulations-overrides?organization_id=&$limit=&$skip=&$sort=", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "purposes-regulations-overrides" ], "query": [ { "description": "The ID of the organization for which to filter overrides", "key": "organization_id", "value": "" }, { "description": "Number of max results to return", "key": "$limit", "value": "" }, { "description": "Number of results to skip", "key": "$skip", "value": "" }, { "description": "Object representing sorting options. Accepts properties to sort as keys and -1 or 1 for sort direction", "key": "$sort", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"total\": \"\",\n \"limit\": \"\",\n \"skip\": \"\",\n \"data\": [\n {\n \"id\": \"\",\n \"metadata_purpose_id\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"deleted_at\": \"\",\n \"regulations_id\": [\n \"\",\n \"\"\n ]\n },\n {\n \"id\": \"\",\n \"metadata_purpose_id\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"deleted_at\": \"\",\n \"regulations_id\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-2a0cbc26-1175-4290-bff5-bf8aee805188" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-68528139-8cad-4171-ab4a-70bd51e5c2de" }, { "name": "Create a MetadataPurposeRegulationOverride", "id": "1d32d4f1-a847-44a5-94ab-fa2d8f484e15", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"organization_id\": \"\",\n \"metadata_purpose_id\": \"\",\n \"regulations_id\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/purposes-regulations-overrides", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "purposes-regulations-overrides" ] }, "description": "Create a new MetadataPurposeRegulationOverride" }, "response": [ { "id": "3ac6269d-d2e8-48fb-9b0e-e2bd3075099e", "name": "The created MetadataPurposeRegulationOverride object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"organization_id\": \"\",\n \"metadata_purpose_id\": \"\",\n \"regulations_id\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/purposes-regulations-overrides", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "purposes-regulations-overrides" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"metadata_purpose_id\": \"\",\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"deleted_at\": \"\",\n \"regulations_id\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-3ac6269d-d2e8-48fb-9b0e-e2bd3075099e" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-1d32d4f1-a847-44a5-94ab-fa2d8f484e15" } ], "id": "7a04a942-cf14-453b-9692-3f1d1691bde8", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-7a04a942-cf14-453b-9692-3f1d1691bde8" }, { "name": "partners-categories", "item": [ { "name": "{id}", "item": [ { "name": "Retrieve a partners category", "id": "411ab5b1-9955-4aae-a832-3ab6965ace8c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/metadata/partners-categories/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-categories", ":id" ], "variable": [ { "id": "e81faa8f-1bb0-4496-9e16-9cc9e6c1c5b3", "key": "id", "value": "", "description": "(Required) The ID of the partners category to retrieve" } ] }, "description": "Returns a single partners category with the given ID" }, "response": [ { "id": "9af8577a-f955-4b05-822b-3db9ff394fc0", "name": "A PartnersCategory object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/metadata/partners-categories/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-categories", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-9af8577a-f955-4b05-822b-3db9ff394fc0" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-411ab5b1-9955-4aae-a832-3ab6965ace8c" }, { "name": "Update a partners category", "id": "a44451bb-f97b-4791-b6c4-f3bd71ea11ec", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/partners-categories/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-categories", ":id" ], "variable": [ { "id": "e4dfade4-ffd8-4b7b-9732-5d8961d3c25f", "key": "id", "value": "", "description": "(Required) The ID of the partners category to update" } ] }, "description": "Update an existing partners category and replace all its properties" }, "response": [ { "id": "f1b767e3-f88e-4d1c-aa3a-9a8b26c4d97c", "name": "The updated PartnersCategory object", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/partners-categories/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-categories", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-f1b767e3-f88e-4d1c-aa3a-9a8b26c4d97c" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-a44451bb-f97b-4791-b6c4-f3bd71ea11ec" }, { "name": "Patch a partners category", "id": "4154e912-1609-41e3-b0e6-9c41ec64549a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/partners-categories/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-categories", ":id" ], "variable": [ { "id": "4d469425-aae1-407e-8d8f-438141aa0750", "key": "id", "value": "", "description": "(Required) The ID of the partners category to patch" } ] }, "description": "Partially update a partners category" }, "response": [ { "id": "999c7e40-b1ae-4381-8031-30ef068aa82a", "name": "The patched PartnersCategory object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/partners-categories/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-categories", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-999c7e40-b1ae-4381-8031-30ef068aa82a" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-4154e912-1609-41e3-b0e6-9c41ec64549a" }, { "name": "Delete a partners category", "id": "a40b1f71-3c66-404a-910a-9a53954e4603", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/metadata/partners-categories/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-categories", ":id" ], "variable": [ { "id": "6b0c3863-1dd5-4d45-b718-ba934fa80fc5", "key": "id", "value": "", "description": "(Required) The ID of the partners category to delete" } ] }, "description": "Delete an existing partners category" }, "response": [ { "id": "39a54e5e-8ec4-4908-a4d7-315fb0590ffe", "name": "The deleted PartnersCategory object", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/metadata/partners-categories/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-categories", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-39a54e5e-8ec4-4908-a4d7-315fb0590ffe" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-a40b1f71-3c66-404a-910a-9a53954e4603" } ], "id": "cbed2a90-6b0b-4836-841a-4982842a4a6a", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-cbed2a90-6b0b-4836-841a-4982842a4a6a" }, { "name": "Retrieve a list of partners categories", "id": "b2ffa260-ba76-495d-9aba-402b3d3dd0ce", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/metadata/partners-categories?$limit=&$skip=&id=&name=&created_at=&updated_at=", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-categories" ], "query": [ { "description": "Number of results to return", "key": "$limit", "value": "" }, { "description": "Number of results to skip", "key": "$skip", "value": "" }, { "description": "Query parameters to filter", "key": "id", "value": "" }, { "description": "Query parameters to filter", "key": "name", "value": "" }, { "description": "Query parameters to filter", "key": "created_at", "value": "" }, { "description": "Query parameters to filter", "key": "updated_at", "value": "" } ] }, "description": "Returns a list of all partners categories" }, "response": [ { "id": "7885dec0-9fe7-475f-8ede-9b949ef2411f", "name": "A list of PartnersCategory objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/metadata/partners-categories?$limit=&$skip=&id=&name=&created_at=&updated_at=", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-categories" ], "query": [ { "description": "Number of results to return", "key": "$limit", "value": "" }, { "description": "Number of results to skip", "key": "$skip", "value": "" }, { "description": "Query parameters to filter", "key": "id", "value": "" }, { "description": "Query parameters to filter", "key": "name", "value": "" }, { "description": "Query parameters to filter", "key": "created_at", "value": "" }, { "description": "Query parameters to filter", "key": "updated_at", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n]", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-7885dec0-9fe7-475f-8ede-9b949ef2411f" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-b2ffa260-ba76-495d-9aba-402b3d3dd0ce" }, { "name": "Create a partners category", "id": "44e9ba20-0c99-4092-af0e-18dc86fa7a7f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/partners-categories", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-categories" ] }, "description": "Create a new partners category" }, "response": [ { "id": "839de252-23e0-4473-b5fc-677ab517f061", "name": "The created PartnersCategory object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/partners-categories", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-categories" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-839de252-23e0-4473-b5fc-677ab517f061" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-44e9ba20-0c99-4092-af0e-18dc86fa7a7f" } ], "id": "201a3162-237a-4713-b6d6-8022dc186b7a", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-201a3162-237a-4713-b6d6-8022dc186b7a" }, { "name": "partners-purposes", "item": [ { "name": "{id}", "item": [ { "name": "Get a partner-purpose association", "id": "0d11839d-8a56-4ee6-b064-2b43aec6923b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/metadata/partners-purposes/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-purposes", ":id" ], "variable": [ { "id": "c229b544-9e31-426c-8bfd-3fe7f77a2819", "key": "id", "value": "", "description": "(Required) " } ] }, "description": "Retrieves a single partner-purpose association by ID" }, "response": [ { "id": "1bb90e45-24ac-4709-b11b-919ae4474949", "name": "200 response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/metadata/partners-purposes/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-purposes", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"metadata_partner_id\": \"\",\n \"metadata_purpose_id\": \"\",\n \"processing_rules\": [\n \"opt-out\"\n ],\n \"organization_id\": \"\",\n \"is_org_override\": \"\",\n \"default_purposes_id\": \"\",\n \"legitimate_interest_purposes_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-1bb90e45-24ac-4709-b11b-919ae4474949" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-0d11839d-8a56-4ee6-b064-2b43aec6923b" }, { "name": "Updates the resource identified by id using data.", "id": "6015ca13-24d7-4ba7-96f2-20cba98bf5e6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"metadata_partner_id\": \"\",\n \"metadata_purpose_id\": \"\",\n \"processing_rules\": [\n \"opt-out\"\n ],\n \"organization_id\": \"\",\n \"is_org_override\": \"\",\n \"default_purposes_id\": \"\",\n \"legitimate_interest_purposes_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/partners-purposes/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-purposes", ":id" ], "variable": [ { "id": "0a8545c3-e02c-44f0-acda-a652cfb1f779", "key": "id", "value": "", "description": "(Required) ID of partners-purposes to update" } ] }, "description": "Updates the resource identified by id using data." }, "response": [ { "id": "110e6a49-6981-4e9e-ad7b-5cb8128c470a", "name": "success", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"metadata_partner_id\": \"\",\n \"metadata_purpose_id\": \"\",\n \"processing_rules\": [\n \"opt-out\"\n ],\n \"organization_id\": \"\",\n \"is_org_override\": \"\",\n \"default_purposes_id\": \"\",\n \"legitimate_interest_purposes_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/partners-purposes/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-purposes", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"metadata_partner_id\": \"\",\n \"metadata_purpose_id\": \"\",\n \"processing_rules\": [\n \"opt-out\"\n ],\n \"organization_id\": \"\",\n \"is_org_override\": \"\",\n \"default_purposes_id\": \"\",\n \"legitimate_interest_purposes_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-110e6a49-6981-4e9e-ad7b-5cb8128c470a" }, { "id": "527db828-c4d7-45d4-a5f3-51b1fbbfd3dd", "name": "not authenticated", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"metadata_partner_id\": \"\",\n \"metadata_purpose_id\": \"\",\n \"processing_rules\": [\n \"opt-out\"\n ],\n \"organization_id\": \"\",\n \"is_org_override\": \"\",\n \"default_purposes_id\": \"\",\n \"legitimate_interest_purposes_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/partners-purposes/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-purposes", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-527db828-c4d7-45d4-a5f3-51b1fbbfd3dd" }, { "id": "8e31966d-f83e-445b-bb39-6ec2b8656f36", "name": "not found", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"metadata_partner_id\": \"\",\n \"metadata_purpose_id\": \"\",\n \"processing_rules\": [\n \"opt-out\"\n ],\n \"organization_id\": \"\",\n \"is_org_override\": \"\",\n \"default_purposes_id\": \"\",\n \"legitimate_interest_purposes_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/partners-purposes/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-purposes", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-8e31966d-f83e-445b-bb39-6ec2b8656f36" }, { "id": "cc39c533-3153-4ec9-8f9c-af0ce98bb5b9", "name": "general error", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"metadata_partner_id\": \"\",\n \"metadata_purpose_id\": \"\",\n \"processing_rules\": [\n \"opt-out\"\n ],\n \"organization_id\": \"\",\n \"is_org_override\": \"\",\n \"default_purposes_id\": \"\",\n \"legitimate_interest_purposes_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/partners-purposes/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-purposes", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-cc39c533-3153-4ec9-8f9c-af0ce98bb5b9" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-6015ca13-24d7-4ba7-96f2-20cba98bf5e6" }, { "name": "Update processing rules", "id": "c7d7ede6-c130-4e74-b197-913555f627cd", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"processing_rules\": [\n \"opt-out\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/partners-purposes/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-purposes", ":id" ], "variable": [ { "id": "a23a3ecb-c638-4934-81c0-35513f04fca0", "key": "id", "value": "", "description": "(Required) " } ] }, "description": "Updates only the processing rules for an existing partner-purpose association" }, "response": [ { "id": "9674294c-cd5e-49ae-a905-a1dda6b0f02e", "name": "200 response", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"processing_rules\": [\n \"opt-out\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/partners-purposes/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-purposes", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"metadata_partner_id\": \"\",\n \"metadata_purpose_id\": \"\",\n \"processing_rules\": [\n \"opt-out\"\n ],\n \"organization_id\": \"\",\n \"is_org_override\": \"\",\n \"default_purposes_id\": \"\",\n \"legitimate_interest_purposes_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-9674294c-cd5e-49ae-a905-a1dda6b0f02e" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-c7d7ede6-c130-4e74-b197-913555f627cd" }, { "name": "Delete a partner-purpose association", "id": "65d909c1-7953-4db1-9f66-90bbb0f5ca0c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/metadata/partners-purposes/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-purposes", ":id" ], "variable": [ { "id": "7904f9e9-4f55-4223-aad6-7378d09e4bbb", "key": "id", "value": "", "description": "(Required) " } ] }, "description": "Permanently removes a partner-purpose association" }, "response": [ { "id": "b0fdc20e-29e9-486f-ba8b-0788347f91e2", "name": "Association successfully deleted", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/metadata/partners-purposes/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-purposes", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-b0fdc20e-29e9-486f-ba8b-0788347f91e2" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-65d909c1-7953-4db1-9f66-90bbb0f5ca0c" } ], "id": "bda98363-0813-4a58-aeb9-211eb9d4f1dc", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-bda98363-0813-4a58-aeb9-211eb9d4f1dc" }, { "name": "List partner-purpose associations", "id": "d2c53ffe-7407-4c96-bd06-d79f203f356d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/metadata/partners-purposes?$limit=&$skip=&id=&metadata_partner_id=&metadata_purpose_id=&processing_rules=opt-out&organization_id=&is_org_override=&default_purposes_id=&legitimate_interest_purposes_id=&created_at=&updated_at=&version=", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-purposes" ], "query": [ { "description": "Number of results to return", "key": "$limit", "value": "" }, { "description": "Number of results to skip", "key": "$skip", "value": "" }, { "description": "Query parameters to filter", "key": "id", "value": "" }, { "description": "Query parameters to filter", "key": "metadata_partner_id", "value": "" }, { "description": "Query parameters to filter", "key": "metadata_purpose_id", "value": "" }, { "description": "Query parameters to filter", "key": "processing_rules", "value": "opt-out" }, { "description": "Query parameters to filter", "key": "organization_id", "value": "" }, { "description": "Query parameters to filter", "key": "is_org_override", "value": "" }, { "description": "Query parameters to filter", "key": "default_purposes_id", "value": "" }, { "description": "Query parameters to filter", "key": "legitimate_interest_purposes_id", "value": "" }, { "description": "Query parameters to filter", "key": "created_at", "value": "" }, { "description": "Query parameters to filter", "key": "updated_at", "value": "" }, { "description": "Query parameters to filter", "key": "version", "value": "" } ] }, "description": "Returns a paginated list of partner-purpose associations the user has access to" }, "response": [ { "id": "2abed67c-0832-4c99-abcd-ea83fd962ff5", "name": "200 response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/metadata/partners-purposes?$limit=&$skip=&id=&metadata_partner_id=&metadata_purpose_id=&processing_rules=opt-out&organization_id=&is_org_override=&default_purposes_id=&legitimate_interest_purposes_id=&created_at=&updated_at=&version=", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-purposes" ], "query": [ { "description": "Number of results to return", "key": "$limit", "value": "" }, { "description": "Number of results to skip", "key": "$skip", "value": "" }, { "description": "Query parameters to filter", "key": "id", "value": "" }, { "description": "Query parameters to filter", "key": "metadata_partner_id", "value": "" }, { "description": "Query parameters to filter", "key": "metadata_purpose_id", "value": "" }, { "description": "Query parameters to filter", "key": "processing_rules", "value": "opt-out" }, { "description": "Query parameters to filter", "key": "organization_id", "value": "" }, { "description": "Query parameters to filter", "key": "is_org_override", "value": "" }, { "description": "Query parameters to filter", "key": "default_purposes_id", "value": "" }, { "description": "Query parameters to filter", "key": "legitimate_interest_purposes_id", "value": "" }, { "description": "Query parameters to filter", "key": "created_at", "value": "" }, { "description": "Query parameters to filter", "key": "updated_at", "value": "" }, { "description": "Query parameters to filter", "key": "version", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"total\": \"\",\n \"limit\": \"\",\n \"skip\": \"\",\n \"data\": [\n {\n \"id\": \"\",\n \"metadata_partner_id\": \"\",\n \"metadata_purpose_id\": \"\",\n \"processing_rules\": [\n \"opt-out\"\n ],\n \"organization_id\": \"\",\n \"is_org_override\": \"\",\n \"default_purposes_id\": \"\",\n \"legitimate_interest_purposes_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n },\n {\n \"id\": \"\",\n \"metadata_partner_id\": \"\",\n \"metadata_purpose_id\": \"\",\n \"processing_rules\": [\n \"opt-out\"\n ],\n \"organization_id\": \"\",\n \"is_org_override\": \"\",\n \"default_purposes_id\": \"\",\n \"legitimate_interest_purposes_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-2abed67c-0832-4c99-abcd-ea83fd962ff5" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-d2c53ffe-7407-4c96-bd06-d79f203f356d" }, { "name": "Create a partner-purpose association", "id": "e36ee31d-dd4c-4ea0-bc32-295b91c406c7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"metadata_partner_id\": \"\",\n \"metadata_purpose_id\": \"\",\n \"processing_rules\": [\n \"opt-in\"\n ],\n \"organization_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/partners-purposes", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-purposes" ] }, "description": "Creates a new association between a partner and purpose, optionally scoped to an organization" }, "response": [ { "id": "bd5efe18-48e4-4392-b9f7-9d0b955b60a1", "name": "201 response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"metadata_partner_id\": \"\",\n \"metadata_purpose_id\": \"\",\n \"processing_rules\": [\n \"opt-in\"\n ],\n \"organization_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/partners-purposes", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-purposes" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"metadata_partner_id\": \"\",\n \"metadata_purpose_id\": \"\",\n \"processing_rules\": [\n \"opt-out\"\n ],\n \"organization_id\": \"\",\n \"is_org_override\": \"\",\n \"default_purposes_id\": \"\",\n \"legitimate_interest_purposes_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-bd5efe18-48e4-4392-b9f7-9d0b955b60a1" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-e36ee31d-dd4c-4ea0-bc32-295b91c406c7" } ], "id": "08c8c6f4-edee-4f7b-860a-1071c8009fc7", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-08c8c6f4-edee-4f7b-860a-1071c8009fc7" }, { "name": "partners-default-purposes", "item": [ { "name": "Retrieve a list of partners-default-purposes objects", "id": "008ceb3c-61ec-4d7b-949e-6f3ca85283b2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/metadata/partners-default-purposes?$limit=&$skip=&metadata_partner_id=&metadata_purpose_id=&organization_id=&is_org_override=&created_at=&updated_at=", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-default-purposes" ], "query": [ { "description": "Number of results to return", "key": "$limit", "value": "" }, { "description": "Number of results to skip", "key": "$skip", "value": "" }, { "description": "Query parameters to filter", "key": "metadata_partner_id", "value": "" }, { "description": "Query parameters to filter", "key": "metadata_purpose_id", "value": "" }, { "description": "Query parameters to filter", "key": "organization_id", "value": "" }, { "description": "Query parameters to filter", "key": "is_org_override", "value": "" }, { "description": "Query parameters to filter", "key": "created_at", "value": "" }, { "description": "Query parameters to filter", "key": "updated_at", "value": "" } ] }, "description": "Returns a list of all partners-default-purposes objects" }, "response": [ { "id": "87b1d11b-7294-4873-9ed1-0145e8c2598c", "name": "200 response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/metadata/partners-default-purposes?$limit=&$skip=&metadata_partner_id=&metadata_purpose_id=&organization_id=&is_org_override=&created_at=&updated_at=", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-default-purposes" ], "query": [ { "description": "Number of results to return", "key": "$limit", "value": "" }, { "description": "Number of results to skip", "key": "$skip", "value": "" }, { "description": "Query parameters to filter", "key": "metadata_partner_id", "value": "" }, { "description": "Query parameters to filter", "key": "metadata_purpose_id", "value": "" }, { "description": "Query parameters to filter", "key": "organization_id", "value": "" }, { "description": "Query parameters to filter", "key": "is_org_override", "value": "" }, { "description": "Query parameters to filter", "key": "created_at", "value": "" }, { "description": "Query parameters to filter", "key": "updated_at", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"metadata_partner_id\": \"\",\n \"metadata_purpose_id\": \"\",\n \"organization_id\": \"\",\n \"is_org_override\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"metadata_partner_id\": \"\",\n \"metadata_purpose_id\": \"\",\n \"organization_id\": \"\",\n \"is_org_override\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n]", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-87b1d11b-7294-4873-9ed1-0145e8c2598c" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-008ceb3c-61ec-4d7b-949e-6f3ca85283b2" }, { "name": "Create a new association between a partner and purpose", "id": "72f50498-cd55-4ea6-ac5d-7e69206fca73", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"metadata_partner_id\": \"\",\n \"metadata_purpose_id\": \"\",\n \"organization_id\": \"\",\n \"is_org_override\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/partners-default-purposes", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-default-purposes" ] }, "description": "Create a new partner purpose association" }, "response": [ { "id": "2b091c93-3f45-4a2d-ae0a-bcdd05566c2b", "name": "201 response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"metadata_partner_id\": \"\",\n \"metadata_purpose_id\": \"\",\n \"organization_id\": \"\",\n \"is_org_override\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/partners-default-purposes", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-default-purposes" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"metadata_partner_id\": \"\",\n \"metadata_purpose_id\": \"\",\n \"organization_id\": \"\",\n \"is_org_override\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"metadata_partner_id\": \"\",\n \"metadata_purpose_id\": \"\",\n \"organization_id\": \"\",\n \"is_org_override\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n]", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-2b091c93-3f45-4a2d-ae0a-bcdd05566c2b" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-72f50498-cd55-4ea6-ac5d-7e69206fca73" } ], "id": "cb57ef8f-aa29-4d1f-a583-31246ec0d583", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-cb57ef8f-aa29-4d1f-a583-31246ec0d583" }, { "name": "partners-legitimate-interest-purposes", "item": [ { "name": "Retrieve a list of partners-legitimate-interest-purposes objects", "id": "7b32ba50-c1f3-452a-98c0-d089506077c1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/metadata/partners-legitimate-interest-purposes?$limit=&$skip=&metadata_partner_id=&metadata_purpose_id=&organization_id=&is_org_override=&created_at=&updated_at=", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-legitimate-interest-purposes" ], "query": [ { "description": "Number of results to return", "key": "$limit", "value": "" }, { "description": "Number of results to skip", "key": "$skip", "value": "" }, { "description": "Query parameters to filter", "key": "metadata_partner_id", "value": "" }, { "description": "Query parameters to filter", "key": "metadata_purpose_id", "value": "" }, { "description": "Query parameters to filter", "key": "organization_id", "value": "" }, { "description": "Query parameters to filter", "key": "is_org_override", "value": "" }, { "description": "Query parameters to filter", "key": "created_at", "value": "" }, { "description": "Query parameters to filter", "key": "updated_at", "value": "" } ] }, "description": "Returns a list of all partners-legitimate-interest-purposes objects" }, "response": [ { "id": "79076627-490d-4123-b979-64a10e14dcb9", "name": "200 response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/metadata/partners-legitimate-interest-purposes?$limit=&$skip=&metadata_partner_id=&metadata_purpose_id=&organization_id=&is_org_override=&created_at=&updated_at=", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-legitimate-interest-purposes" ], "query": [ { "description": "Number of results to return", "key": "$limit", "value": "" }, { "description": "Number of results to skip", "key": "$skip", "value": "" }, { "description": "Query parameters to filter", "key": "metadata_partner_id", "value": "" }, { "description": "Query parameters to filter", "key": "metadata_purpose_id", "value": "" }, { "description": "Query parameters to filter", "key": "organization_id", "value": "" }, { "description": "Query parameters to filter", "key": "is_org_override", "value": "" }, { "description": "Query parameters to filter", "key": "created_at", "value": "" }, { "description": "Query parameters to filter", "key": "updated_at", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"metadata_partner_id\": \"\",\n \"metadata_purpose_id\": \"\",\n \"organization_id\": \"\",\n \"is_org_override\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"metadata_partner_id\": \"\",\n \"metadata_purpose_id\": \"\",\n \"organization_id\": \"\",\n \"is_org_override\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n]", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-79076627-490d-4123-b979-64a10e14dcb9" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-7b32ba50-c1f3-452a-98c0-d089506077c1" }, { "name": "Create a new association between a partner and purpose", "id": "0ff69e94-996b-4687-aa43-8a19ffc7bc7c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"metadata_partner_id\": \"\",\n \"metadata_purpose_id\": \"\",\n \"organization_id\": \"\",\n \"is_org_override\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/partners-legitimate-interest-purposes", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-legitimate-interest-purposes" ] }, "description": "Create a new partner purpose association" }, "response": [ { "id": "7d17edd5-29d5-47d2-a164-85734d63ef08", "name": "201 response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"metadata_partner_id\": \"\",\n \"metadata_purpose_id\": \"\",\n \"organization_id\": \"\",\n \"is_org_override\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/partners-legitimate-interest-purposes", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-legitimate-interest-purposes" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"metadata_partner_id\": \"\",\n \"metadata_purpose_id\": \"\",\n \"organization_id\": \"\",\n \"is_org_override\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"metadata_partner_id\": \"\",\n \"metadata_purpose_id\": \"\",\n \"organization_id\": \"\",\n \"is_org_override\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n]", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-7d17edd5-29d5-47d2-a164-85734d63ef08" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-0ff69e94-996b-4687-aa43-8a19ffc7bc7c" } ], "id": "618dbfa5-66b9-4d7a-8768-d2b70b50fcf0", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-618dbfa5-66b9-4d7a-8768-d2b70b50fcf0" }, { "name": "partners-spi-purposes", "item": [ { "name": "Retrieve a list of partners-spi-purposes objects", "id": "8e2e76a5-be05-4fca-8fa7-2d38fb98b002", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/metadata/partners-spi-purposes?$limit=&$skip=&metadata_partner_id=&metadata_purpose_id=&organization_id=&is_org_override=&created_at=&updated_at=", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-spi-purposes" ], "query": [ { "description": "Number of results to return", "key": "$limit", "value": "" }, { "description": "Number of results to skip", "key": "$skip", "value": "" }, { "description": "Query parameters to filter", "key": "metadata_partner_id", "value": "" }, { "description": "Query parameters to filter", "key": "metadata_purpose_id", "value": "" }, { "description": "Query parameters to filter", "key": "organization_id", "value": "" }, { "description": "Query parameters to filter", "key": "is_org_override", "value": "" }, { "description": "Query parameters to filter", "key": "created_at", "value": "" }, { "description": "Query parameters to filter", "key": "updated_at", "value": "" } ] }, "description": "Returns a list of all partners-spi-purposes objects" }, "response": [ { "id": "2ad8234c-09f7-480b-b402-73b6328f6896", "name": "200 response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/metadata/partners-spi-purposes?$limit=&$skip=&metadata_partner_id=&metadata_purpose_id=&organization_id=&is_org_override=&created_at=&updated_at=", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-spi-purposes" ], "query": [ { "description": "Number of results to return", "key": "$limit", "value": "" }, { "description": "Number of results to skip", "key": "$skip", "value": "" }, { "description": "Query parameters to filter", "key": "metadata_partner_id", "value": "" }, { "description": "Query parameters to filter", "key": "metadata_purpose_id", "value": "" }, { "description": "Query parameters to filter", "key": "organization_id", "value": "" }, { "description": "Query parameters to filter", "key": "is_org_override", "value": "" }, { "description": "Query parameters to filter", "key": "created_at", "value": "" }, { "description": "Query parameters to filter", "key": "updated_at", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"metadata_partner_id\": \"\",\n \"metadata_purpose_id\": \"\",\n \"organization_id\": \"\",\n \"is_org_override\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"metadata_partner_id\": \"\",\n \"metadata_purpose_id\": \"\",\n \"organization_id\": \"\",\n \"is_org_override\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n]", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-2ad8234c-09f7-480b-b402-73b6328f6896" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-8e2e76a5-be05-4fca-8fa7-2d38fb98b002" }, { "name": "Create a new association between a partner and purpose", "id": "6b65ab21-9921-4f80-be29-fd3fdcb48e6e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"metadata_partner_id\": \"\",\n \"metadata_purpose_id\": \"\",\n \"organization_id\": \"\",\n \"is_org_override\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/partners-spi-purposes", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-spi-purposes" ] }, "description": "Create a new partner purpose association" }, "response": [ { "id": "ad6c0b20-b2be-4c84-9ea7-06fbfd6ea744", "name": "201 response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"metadata_partner_id\": \"\",\n \"metadata_purpose_id\": \"\",\n \"organization_id\": \"\",\n \"is_org_override\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/partners-spi-purposes", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-spi-purposes" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"metadata_partner_id\": \"\",\n \"metadata_purpose_id\": \"\",\n \"organization_id\": \"\",\n \"is_org_override\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"metadata_partner_id\": \"\",\n \"metadata_purpose_id\": \"\",\n \"organization_id\": \"\",\n \"is_org_override\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n]", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-ad6c0b20-b2be-4c84-9ea7-06fbfd6ea744" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-6b65ab21-9921-4f80-be29-fd3fdcb48e6e" } ], "id": "f17bad00-707a-41c3-9c5d-9ed6707fe10d", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-f17bad00-707a-41c3-9c5d-9ed6707fe10d" }, { "name": "partners-storages", "item": [ { "name": "{id}", "item": [ { "name": "Retrieve a storage", "id": "a368caa0-a132-4419-af00-20c60bb72dc5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/metadata/partners-storages/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-storages", ":id" ], "variable": [ { "id": "0adc5309-4ad1-40ec-8ad8-d0f74f2504bc", "key": "id", "value": "", "description": "(Required) The ID of the storage to retrieve" } ] }, "description": "Returns a single storage with the given ID" }, "response": [ { "id": "df90f885-afc0-4716-9b4c-d7e1e957cf74", "name": "A Storage object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/metadata/partners-storages/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-storages", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"web_storage\",\n \"identifier\": \"\",\n \"purposes_id\": [\n \"\",\n \"\"\n ],\n \"domain\": \"\",\n \"max_age\": \"\",\n \"max_age_unit\": \"months\",\n \"organization_id\": \"\",\n \"partner_id\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-df90f885-afc0-4716-9b4c-d7e1e957cf74" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-a368caa0-a132-4419-af00-20c60bb72dc5" }, { "name": "Update a storage", "id": "0311273b-1ba3-4c26-9fc2-cb3c474bab9b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"web_storage\",\n \"identifier\": \"\",\n \"purposes_id\": [\n \"\",\n \"\"\n ],\n \"domain\": \"\",\n \"max_age\": \"\",\n \"max_age_unit\": \"months\",\n \"organization_id\": \"\",\n \"partner_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/partners-storages/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-storages", ":id" ], "variable": [ { "id": "85103384-5d22-450a-a554-032397518da5", "key": "id", "value": "", "description": "(Required) The ID of the storage to update" } ] }, "description": "Update an existing storage and replace all its properties" }, "response": [ { "id": "198a2b75-5106-4729-9ccc-73b5be22443b", "name": "The updated Storage object", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"web_storage\",\n \"identifier\": \"\",\n \"purposes_id\": [\n \"\",\n \"\"\n ],\n \"domain\": \"\",\n \"max_age\": \"\",\n \"max_age_unit\": \"months\",\n \"organization_id\": \"\",\n \"partner_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/partners-storages/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-storages", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"web_storage\",\n \"identifier\": \"\",\n \"purposes_id\": [\n \"\",\n \"\"\n ],\n \"domain\": \"\",\n \"max_age\": \"\",\n \"max_age_unit\": \"months\",\n \"organization_id\": \"\",\n \"partner_id\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-198a2b75-5106-4729-9ccc-73b5be22443b" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-0311273b-1ba3-4c26-9fc2-cb3c474bab9b" }, { "name": "Patch a storage", "id": "73e69913-df0f-47fc-a401-3e1629a1be2b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"web_storage\",\n \"identifier\": \"\",\n \"purposes_id\": [\n \"\",\n \"\"\n ],\n \"domain\": \"\",\n \"max_age\": \"\",\n \"max_age_unit\": \"months\",\n \"organization_id\": \"\",\n \"partner_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/partners-storages/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-storages", ":id" ], "variable": [ { "id": "a78aa3f5-d96f-41aa-a56c-351a90f7be3a", "key": "id", "value": "", "description": "(Required) The ID of the storage to patch" } ] }, "description": "Partially update a storage" }, "response": [ { "id": "00a692b0-876a-4c47-bb7c-8bebf09c378c", "name": "The patched Storage object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"web_storage\",\n \"identifier\": \"\",\n \"purposes_id\": [\n \"\",\n \"\"\n ],\n \"domain\": \"\",\n \"max_age\": \"\",\n \"max_age_unit\": \"months\",\n \"organization_id\": \"\",\n \"partner_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/partners-storages/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-storages", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"web_storage\",\n \"identifier\": \"\",\n \"purposes_id\": [\n \"\",\n \"\"\n ],\n \"domain\": \"\",\n \"max_age\": \"\",\n \"max_age_unit\": \"months\",\n \"organization_id\": \"\",\n \"partner_id\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-00a692b0-876a-4c47-bb7c-8bebf09c378c" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-73e69913-df0f-47fc-a401-3e1629a1be2b" }, { "name": "Delete a storage", "id": "01c19bc0-4f16-426a-ba17-1612335e7cba", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/metadata/partners-storages/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-storages", ":id" ], "variable": [ { "id": "ce8c9780-d6af-46f6-bd9f-ebd12d91eed8", "key": "id", "value": "", "description": "(Required) The ID of the storage to delete" } ] }, "description": "Delete an existing storage" }, "response": [ { "id": "44d22c91-bc4c-4aea-aeab-0635e281288e", "name": "The deleted Storage object", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/metadata/partners-storages/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-storages", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"web_storage\",\n \"identifier\": \"\",\n \"purposes_id\": [\n \"\",\n \"\"\n ],\n \"domain\": \"\",\n \"max_age\": \"\",\n \"max_age_unit\": \"months\",\n \"organization_id\": \"\",\n \"partner_id\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-44d22c91-bc4c-4aea-aeab-0635e281288e" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-01c19bc0-4f16-426a-ba17-1612335e7cba" } ], "id": "7ac0cba1-71a7-4740-a5e6-15ad289d17b1", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-7ac0cba1-71a7-4740-a5e6-15ad289d17b1" }, { "name": "Retrieve a list of storages", "id": "da761e52-4892-458a-8072-52220fba1a23", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/metadata/partners-storages?$limit=&$skip=&type=web_storage&identifier=&purposes_id=,&domain=&max_age=&max_age_unit=months&organization_id=&partner_id=", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-storages" ], "query": [ { "description": "Number of results to return", "key": "$limit", "value": "" }, { "description": "Number of results to skip", "key": "$skip", "value": "" }, { "description": "Query parameters to filter", "key": "type", "value": "web_storage" }, { "description": "Query parameters to filter", "key": "identifier", "value": "" }, { "description": "Query parameters to filter", "key": "purposes_id", "value": "," }, { "description": "Query parameters to filter", "key": "domain", "value": "" }, { "description": "Query parameters to filter", "key": "max_age", "value": "" }, { "description": "Query parameters to filter", "key": "max_age_unit", "value": "months" }, { "description": "Query parameters to filter", "key": "organization_id", "value": "" }, { "description": "Query parameters to filter", "key": "partner_id", "value": "" } ] }, "description": "Returns a list of all storages" }, "response": [ { "id": "603fae99-d240-429a-939b-0738a9b0d24b", "name": "A list of Storage objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/metadata/partners-storages?$limit=&$skip=&type=web_storage&identifier=&purposes_id=,&domain=&max_age=&max_age_unit=months&organization_id=&partner_id=", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-storages" ], "query": [ { "description": "Number of results to return", "key": "$limit", "value": "" }, { "description": "Number of results to skip", "key": "$skip", "value": "" }, { "description": "Query parameters to filter", "key": "type", "value": "web_storage" }, { "description": "Query parameters to filter", "key": "identifier", "value": "" }, { "description": "Query parameters to filter", "key": "purposes_id", "value": "," }, { "description": "Query parameters to filter", "key": "domain", "value": "" }, { "description": "Query parameters to filter", "key": "max_age", "value": "" }, { "description": "Query parameters to filter", "key": "max_age_unit", "value": "months" }, { "description": "Query parameters to filter", "key": "organization_id", "value": "" }, { "description": "Query parameters to filter", "key": "partner_id", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"type\": \"web_storage\",\n \"identifier\": \"\",\n \"purposes_id\": [\n \"\",\n \"\"\n ],\n \"domain\": \"\",\n \"max_age\": \"\",\n \"max_age_unit\": \"months\",\n \"organization_id\": \"\",\n \"partner_id\": \"\"\n },\n {\n \"type\": \"cookie\",\n \"identifier\": \"\",\n \"purposes_id\": [\n \"\",\n \"\"\n ],\n \"domain\": \"\",\n \"max_age\": \"\",\n \"max_age_unit\": \"seconds\",\n \"organization_id\": \"\",\n \"partner_id\": \"\"\n }\n]", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-603fae99-d240-429a-939b-0738a9b0d24b" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-da761e52-4892-458a-8072-52220fba1a23" }, { "name": "Create a storage", "id": "9e3000fb-2cd8-45b7-9f08-2535e9e2c8b3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"web_storage\",\n \"identifier\": \"\",\n \"purposes_id\": [\n \"\",\n \"\"\n ],\n \"domain\": \"\",\n \"max_age\": \"\",\n \"max_age_unit\": \"months\",\n \"organization_id\": \"\",\n \"partner_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/partners-storages", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-storages" ] }, "description": "Create a new storage" }, "response": [ { "id": "0ecaf956-0ab2-4e80-beca-9cfcde1b8efa", "name": "The created Storage object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"web_storage\",\n \"identifier\": \"\",\n \"purposes_id\": [\n \"\",\n \"\"\n ],\n \"domain\": \"\",\n \"max_age\": \"\",\n \"max_age_unit\": \"months\",\n \"organization_id\": \"\",\n \"partner_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/partners-storages", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-storages" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"web_storage\",\n \"identifier\": \"\",\n \"purposes_id\": [\n \"\",\n \"\"\n ],\n \"domain\": \"\",\n \"max_age\": \"\",\n \"max_age_unit\": \"months\",\n \"organization_id\": \"\",\n \"partner_id\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-0ecaf956-0ab2-4e80-beca-9cfcde1b8efa" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-9e3000fb-2cd8-45b7-9f08-2535e9e2c8b3" } ], "id": "89ee7dad-9dd6-4730-b242-418361951bbc", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-89ee7dad-9dd6-4730-b242-418361951bbc" }, { "name": "partners-purposes-templates-overrides", "item": [ { "name": "{id}", "item": [ { "name": "Get a template override", "id": "bf9c1b73-0ec1-4c60-9844-7bcdbae15c8e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/metadata/partners-purposes-templates-overrides/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-purposes-templates-overrides", ":id" ], "variable": [ { "id": "bd50e77d-d360-40fa-9ba8-4d1ad6ded0e2", "key": "id", "value": "", "description": "(Required) " } ] }, "description": "Retrieves a single template override by ID" }, "response": [ { "id": "1133c5d6-6978-477e-9e8a-385b581e066b", "name": "200 response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/metadata/partners-purposes-templates-overrides/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-purposes-templates-overrides", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"metadata_partner_id\": \"\",\n \"metadata_purpose_id\": \"\",\n \"template_id\": \"\",\n \"organization_id\": \"\",\n \"processing_rule\": \"opt-in\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-1133c5d6-6978-477e-9e8a-385b581e066b" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-bf9c1b73-0ec1-4c60-9844-7bcdbae15c8e" }, { "name": "Updates the resource identified by id using data.", "id": "1c0109e0-feea-4f8f-982c-513de45468b9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"metadata_partner_id\": \"\",\n \"metadata_purpose_id\": \"\",\n \"template_id\": \"\",\n \"organization_id\": \"\",\n \"processing_rule\": \"opt-in\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/partners-purposes-templates-overrides/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-purposes-templates-overrides", ":id" ], "variable": [ { "id": "b99fca76-d932-4fbc-a2ff-4e3e06fc23aa", "key": "id", "value": "", "description": "(Required) ID of partners-purposes-templates-overrides to update" } ] }, "description": "Updates the resource identified by id using data." }, "response": [ { "id": "d7e6b5d2-ac93-4e53-94f4-e4627aad8f4e", "name": "success", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"metadata_partner_id\": \"\",\n \"metadata_purpose_id\": \"\",\n \"template_id\": \"\",\n \"organization_id\": \"\",\n \"processing_rule\": \"opt-in\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/partners-purposes-templates-overrides/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-purposes-templates-overrides", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"metadata_partner_id\": \"\",\n \"metadata_purpose_id\": \"\",\n \"template_id\": \"\",\n \"organization_id\": \"\",\n \"processing_rule\": \"opt-in\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-d7e6b5d2-ac93-4e53-94f4-e4627aad8f4e" }, { "id": "394cdeb7-b77e-47ef-9e03-14be9d75e80f", "name": "not authenticated", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"metadata_partner_id\": \"\",\n \"metadata_purpose_id\": \"\",\n \"template_id\": \"\",\n \"organization_id\": \"\",\n \"processing_rule\": \"opt-in\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/partners-purposes-templates-overrides/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-purposes-templates-overrides", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-394cdeb7-b77e-47ef-9e03-14be9d75e80f" }, { "id": "1cd6089f-81f4-4e92-aab2-e69cebe44b4c", "name": "not found", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"metadata_partner_id\": \"\",\n \"metadata_purpose_id\": \"\",\n \"template_id\": \"\",\n \"organization_id\": \"\",\n \"processing_rule\": \"opt-in\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/partners-purposes-templates-overrides/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-purposes-templates-overrides", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-1cd6089f-81f4-4e92-aab2-e69cebe44b4c" }, { "id": "0e1d9198-7512-4a5c-bf05-8094779bc2de", "name": "general error", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"metadata_partner_id\": \"\",\n \"metadata_purpose_id\": \"\",\n \"template_id\": \"\",\n \"organization_id\": \"\",\n \"processing_rule\": \"opt-in\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/partners-purposes-templates-overrides/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-purposes-templates-overrides", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-0e1d9198-7512-4a5c-bf05-8094779bc2de" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-1c0109e0-feea-4f8f-982c-513de45468b9" }, { "name": "Update a template override", "id": "688c395c-e6e4-4918-8bea-e9ecd7a00422", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"processing_rule\": \"opt-out\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/partners-purposes-templates-overrides/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-purposes-templates-overrides", ":id" ], "variable": [ { "id": "226e96af-edba-4db0-a0fe-07bdc478db0b", "key": "id", "value": "", "description": "(Required) " } ] }, "description": "Updates the processing rule for an existing template override" }, "response": [ { "id": "e76aa4d4-0a0c-47ca-9cf5-566c7be88f49", "name": "200 response", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"processing_rule\": \"opt-out\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/partners-purposes-templates-overrides/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-purposes-templates-overrides", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"metadata_partner_id\": \"\",\n \"metadata_purpose_id\": \"\",\n \"template_id\": \"\",\n \"organization_id\": \"\",\n \"processing_rule\": \"opt-in\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-e76aa4d4-0a0c-47ca-9cf5-566c7be88f49" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-688c395c-e6e4-4918-8bea-e9ecd7a00422" }, { "name": "Delete a template override", "id": "b35cb8d2-08c9-4577-9176-ff27e37620af", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/metadata/partners-purposes-templates-overrides/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-purposes-templates-overrides", ":id" ], "variable": [ { "id": "2c8b499c-610f-4911-8a1b-a7f13de79a0a", "key": "id", "value": "", "description": "(Required) " } ] }, "description": "Permanently removes a template override" }, "response": [ { "id": "c5bd176a-6bfc-407d-a334-2857eb0a624e", "name": "Template override successfully deleted", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/metadata/partners-purposes-templates-overrides/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-purposes-templates-overrides", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-c5bd176a-6bfc-407d-a334-2857eb0a624e" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-b35cb8d2-08c9-4577-9176-ff27e37620af" } ], "id": "d0838157-490f-49bc-b72c-026222e7db7d", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-d0838157-490f-49bc-b72c-026222e7db7d" }, { "name": "List template overrides", "id": "6ae711a3-2392-48bd-bf2a-194bb8a0e19a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/metadata/partners-purposes-templates-overrides?$limit=&$skip=&id=&metadata_partner_id=&metadata_purpose_id=&template_id=&organization_id=&processing_rule=opt-in&created_at=&updated_at=&version=", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-purposes-templates-overrides" ], "query": [ { "description": "Number of results to return", "key": "$limit", "value": "" }, { "description": "Number of results to skip", "key": "$skip", "value": "" }, { "description": "Query parameters to filter", "key": "id", "value": "" }, { "description": "Query parameters to filter", "key": "metadata_partner_id", "value": "" }, { "description": "Query parameters to filter", "key": "metadata_purpose_id", "value": "" }, { "description": "Query parameters to filter", "key": "template_id", "value": "" }, { "description": "Query parameters to filter", "key": "organization_id", "value": "" }, { "description": "Query parameters to filter", "key": "processing_rule", "value": "opt-in" }, { "description": "Query parameters to filter", "key": "created_at", "value": "" }, { "description": "Query parameters to filter", "key": "updated_at", "value": "" }, { "description": "Query parameters to filter", "key": "version", "value": "" } ] }, "description": "Returns a paginated list of template overrides" }, "response": [ { "id": "a07af61f-0557-4613-a249-695980db6292", "name": "200 response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/metadata/partners-purposes-templates-overrides?$limit=&$skip=&id=&metadata_partner_id=&metadata_purpose_id=&template_id=&organization_id=&processing_rule=opt-in&created_at=&updated_at=&version=", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-purposes-templates-overrides" ], "query": [ { "description": "Number of results to return", "key": "$limit", "value": "" }, { "description": "Number of results to skip", "key": "$skip", "value": "" }, { "description": "Query parameters to filter", "key": "id", "value": "" }, { "description": "Query parameters to filter", "key": "metadata_partner_id", "value": "" }, { "description": "Query parameters to filter", "key": "metadata_purpose_id", "value": "" }, { "description": "Query parameters to filter", "key": "template_id", "value": "" }, { "description": "Query parameters to filter", "key": "organization_id", "value": "" }, { "description": "Query parameters to filter", "key": "processing_rule", "value": "opt-in" }, { "description": "Query parameters to filter", "key": "created_at", "value": "" }, { "description": "Query parameters to filter", "key": "updated_at", "value": "" }, { "description": "Query parameters to filter", "key": "version", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"total\": \"\",\n \"limit\": \"\",\n \"skip\": \"\",\n \"data\": [\n {\n \"id\": \"\",\n \"metadata_partner_id\": \"\",\n \"metadata_purpose_id\": \"\",\n \"template_id\": \"\",\n \"organization_id\": \"\",\n \"processing_rule\": \"opt-out\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n },\n {\n \"id\": \"\",\n \"metadata_partner_id\": \"\",\n \"metadata_purpose_id\": \"\",\n \"template_id\": \"\",\n \"organization_id\": \"\",\n \"processing_rule\": \"opt-in\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-a07af61f-0557-4613-a249-695980db6292" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-6ae711a3-2392-48bd-bf2a-194bb8a0e19a" }, { "name": "Create a template override", "id": "fd8ba9dd-672a-489c-a9b5-9be57bb28a36", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"metadata_partner_id\": \"\",\n \"metadata_purpose_id\": \"\",\n \"template_id\": \"\",\n \"organization_id\": \"\",\n \"processing_rule\": \"opt-out\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/partners-purposes-templates-overrides", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-purposes-templates-overrides" ] }, "description": "Creates a new template override for a partner-purpose association" }, "response": [ { "id": "5cd29ad0-bf28-466c-8a06-e8814fa9e939", "name": "201 response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"metadata_partner_id\": \"\",\n \"metadata_purpose_id\": \"\",\n \"template_id\": \"\",\n \"organization_id\": \"\",\n \"processing_rule\": \"opt-out\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/partners-purposes-templates-overrides", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-purposes-templates-overrides" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"metadata_partner_id\": \"\",\n \"metadata_purpose_id\": \"\",\n \"template_id\": \"\",\n \"organization_id\": \"\",\n \"processing_rule\": \"opt-in\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-5cd29ad0-bf28-466c-8a06-e8814fa9e939" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-fd8ba9dd-672a-489c-a9b5-9be57bb28a36" } ], "id": "3256a577-5b2e-4653-9f8b-506c198859bc", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-3256a577-5b2e-4653-9f8b-506c198859bc" }, { "name": "partners-purposes-notices-regulations-overrides", "item": [ { "name": "{id}", "item": [ { "name": "Get a notice-regulation override", "id": "d5fd491a-7d2c-43b1-a303-f5213ec17fc4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/metadata/partners-purposes-notices-regulations-overrides/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-purposes-notices-regulations-overrides", ":id" ], "variable": [ { "id": "b760d3ba-d51b-4fdb-bc43-525d8046f1d3", "key": "id", "value": "", "description": "(Required) " } ] }, "description": "Retrieves a single notice-regulation override by ID" }, "response": [ { "id": "503fee64-459d-4455-afb0-ddb39b222a13", "name": "200 response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/metadata/partners-purposes-notices-regulations-overrides/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-purposes-notices-regulations-overrides", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"metadata_partner_id\": \"\",\n \"metadata_purpose_id\": \"\",\n \"notice_id\": \"\",\n \"organization_id\": \"\",\n \"regulation_id\": \"\",\n \"processing_rule\": \"opt-in\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-503fee64-459d-4455-afb0-ddb39b222a13" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-d5fd491a-7d2c-43b1-a303-f5213ec17fc4" }, { "name": "Updates the resource identified by id using data.", "id": "d0a17067-8d9d-427e-8f8c-600a50863958", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"metadata_partner_id\": \"\",\n \"metadata_purpose_id\": \"\",\n \"notice_id\": \"\",\n \"organization_id\": \"\",\n \"regulation_id\": \"\",\n \"processing_rule\": \"opt-in\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/partners-purposes-notices-regulations-overrides/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-purposes-notices-regulations-overrides", ":id" ], "variable": [ { "id": "186c5793-2f39-4cf1-a476-cce45983b11e", "key": "id", "value": "", "description": "(Required) ID of partners-purposes-notices-regulations-overrides to update" } ] }, "description": "Updates the resource identified by id using data." }, "response": [ { "id": "72df1734-99bd-4c49-986d-03d1debe6cc8", "name": "success", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"metadata_partner_id\": \"\",\n \"metadata_purpose_id\": \"\",\n \"notice_id\": \"\",\n \"organization_id\": \"\",\n \"regulation_id\": \"\",\n \"processing_rule\": \"opt-in\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/partners-purposes-notices-regulations-overrides/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-purposes-notices-regulations-overrides", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"metadata_partner_id\": \"\",\n \"metadata_purpose_id\": \"\",\n \"notice_id\": \"\",\n \"organization_id\": \"\",\n \"regulation_id\": \"\",\n \"processing_rule\": \"opt-in\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-72df1734-99bd-4c49-986d-03d1debe6cc8" }, { "id": "ca1b0e3d-c957-4c26-92fb-57dd072cf9a5", "name": "not authenticated", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"metadata_partner_id\": \"\",\n \"metadata_purpose_id\": \"\",\n \"notice_id\": \"\",\n \"organization_id\": \"\",\n \"regulation_id\": \"\",\n \"processing_rule\": \"opt-in\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/partners-purposes-notices-regulations-overrides/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-purposes-notices-regulations-overrides", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-ca1b0e3d-c957-4c26-92fb-57dd072cf9a5" }, { "id": "313d7465-a54f-418b-9a23-6ffcfbae16f4", "name": "not found", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"metadata_partner_id\": \"\",\n \"metadata_purpose_id\": \"\",\n \"notice_id\": \"\",\n \"organization_id\": \"\",\n \"regulation_id\": \"\",\n \"processing_rule\": \"opt-in\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/partners-purposes-notices-regulations-overrides/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-purposes-notices-regulations-overrides", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-313d7465-a54f-418b-9a23-6ffcfbae16f4" }, { "id": "fb3db34a-6463-4a21-917e-f7cf2e607741", "name": "general error", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"metadata_partner_id\": \"\",\n \"metadata_purpose_id\": \"\",\n \"notice_id\": \"\",\n \"organization_id\": \"\",\n \"regulation_id\": \"\",\n \"processing_rule\": \"opt-in\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/partners-purposes-notices-regulations-overrides/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-purposes-notices-regulations-overrides", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-fb3db34a-6463-4a21-917e-f7cf2e607741" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-d0a17067-8d9d-427e-8f8c-600a50863958" }, { "name": "Update a notice-regulation override", "id": "e1360597-c899-4081-bbe0-7af60ac98fd3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"processing_rule\": \"opt-out\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/partners-purposes-notices-regulations-overrides/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-purposes-notices-regulations-overrides", ":id" ], "variable": [ { "id": "4ea3d07b-cd42-43c7-acf3-08ccd4b1c500", "key": "id", "value": "", "description": "(Required) " } ] }, "description": "Updates the processing rule for an existing notice-regulation override" }, "response": [ { "id": "6e89b895-0f5d-4513-a514-23bac089bdef", "name": "200 response", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"processing_rule\": \"opt-out\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/partners-purposes-notices-regulations-overrides/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-purposes-notices-regulations-overrides", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"metadata_partner_id\": \"\",\n \"metadata_purpose_id\": \"\",\n \"notice_id\": \"\",\n \"organization_id\": \"\",\n \"regulation_id\": \"\",\n \"processing_rule\": \"opt-in\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-6e89b895-0f5d-4513-a514-23bac089bdef" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-e1360597-c899-4081-bbe0-7af60ac98fd3" }, { "name": "Delete a notice-regulation override", "id": "a4624788-5154-4cb9-a69e-b88f41a0f525", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/metadata/partners-purposes-notices-regulations-overrides/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-purposes-notices-regulations-overrides", ":id" ], "variable": [ { "id": "5162075b-614c-4660-ac03-9d8600121bc7", "key": "id", "value": "", "description": "(Required) " } ] }, "description": "Permanently removes a notice-regulation override" }, "response": [ { "id": "ad0bda40-14ae-4fe8-8625-d855eea35fab", "name": "Notice-regulation override successfully deleted", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/metadata/partners-purposes-notices-regulations-overrides/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-purposes-notices-regulations-overrides", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-ad0bda40-14ae-4fe8-8625-d855eea35fab" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-a4624788-5154-4cb9-a69e-b88f41a0f525" } ], "id": "6887d01e-d132-494d-9da0-9d2fba6e9950", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-6887d01e-d132-494d-9da0-9d2fba6e9950" }, { "name": "List notice-regulation overrides", "id": "3d855b77-45eb-4841-a30d-6ce411aacccc", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/metadata/partners-purposes-notices-regulations-overrides?$limit=&$skip=&id=&metadata_partner_id=&metadata_purpose_id=¬ice_id=&organization_id=®ulation_id=&processing_rule=opt-in&created_at=&updated_at=&version=", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-purposes-notices-regulations-overrides" ], "query": [ { "description": "Number of results to return", "key": "$limit", "value": "" }, { "description": "Number of results to skip", "key": "$skip", "value": "" }, { "description": "Query parameters to filter", "key": "id", "value": "" }, { "description": "Query parameters to filter", "key": "metadata_partner_id", "value": "" }, { "description": "Query parameters to filter", "key": "metadata_purpose_id", "value": "" }, { "description": "Query parameters to filter", "key": "notice_id", "value": "" }, { "description": "Query parameters to filter", "key": "organization_id", "value": "" }, { "description": "Query parameters to filter", "key": "regulation_id", "value": "" }, { "description": "Query parameters to filter", "key": "processing_rule", "value": "opt-in" }, { "description": "Query parameters to filter", "key": "created_at", "value": "" }, { "description": "Query parameters to filter", "key": "updated_at", "value": "" }, { "description": "Query parameters to filter", "key": "version", "value": "" } ] }, "description": "Returns a paginated list of notice-regulation overrides" }, "response": [ { "id": "1c175294-85c6-4553-867b-986da56454db", "name": "200 response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/metadata/partners-purposes-notices-regulations-overrides?$limit=&$skip=&id=&metadata_partner_id=&metadata_purpose_id=¬ice_id=&organization_id=®ulation_id=&processing_rule=opt-in&created_at=&updated_at=&version=", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-purposes-notices-regulations-overrides" ], "query": [ { "description": "Number of results to return", "key": "$limit", "value": "" }, { "description": "Number of results to skip", "key": "$skip", "value": "" }, { "description": "Query parameters to filter", "key": "id", "value": "" }, { "description": "Query parameters to filter", "key": "metadata_partner_id", "value": "" }, { "description": "Query parameters to filter", "key": "metadata_purpose_id", "value": "" }, { "description": "Query parameters to filter", "key": "notice_id", "value": "" }, { "description": "Query parameters to filter", "key": "organization_id", "value": "" }, { "description": "Query parameters to filter", "key": "regulation_id", "value": "" }, { "description": "Query parameters to filter", "key": "processing_rule", "value": "opt-in" }, { "description": "Query parameters to filter", "key": "created_at", "value": "" }, { "description": "Query parameters to filter", "key": "updated_at", "value": "" }, { "description": "Query parameters to filter", "key": "version", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"total\": \"\",\n \"limit\": \"\",\n \"skip\": \"\",\n \"data\": [\n {\n \"id\": \"\",\n \"metadata_partner_id\": \"\",\n \"metadata_purpose_id\": \"\",\n \"notice_id\": \"\",\n \"organization_id\": \"\",\n \"regulation_id\": \"\",\n \"processing_rule\": \"opt-out\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n },\n {\n \"id\": \"\",\n \"metadata_partner_id\": \"\",\n \"metadata_purpose_id\": \"\",\n \"notice_id\": \"\",\n \"organization_id\": \"\",\n \"regulation_id\": \"\",\n \"processing_rule\": \"opt-in\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-1c175294-85c6-4553-867b-986da56454db" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-3d855b77-45eb-4841-a30d-6ce411aacccc" }, { "name": "Create a notice-regulation override", "id": "9867a509-eab8-4651-b809-5c2a729fd02b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"metadata_partner_id\": \"\",\n \"metadata_purpose_id\": \"\",\n \"notice_id\": \"\",\n \"organization_id\": \"\",\n \"regulation_id\": \"\",\n \"processing_rule\": \"opt-in\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/partners-purposes-notices-regulations-overrides", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-purposes-notices-regulations-overrides" ] }, "description": "Creates a new notice-regulation override for a partner-purpose association" }, "response": [ { "id": "04f8b799-d3d4-4cb7-8c70-ed14f6080423", "name": "201 response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"metadata_partner_id\": \"\",\n \"metadata_purpose_id\": \"\",\n \"notice_id\": \"\",\n \"organization_id\": \"\",\n \"regulation_id\": \"\",\n \"processing_rule\": \"opt-in\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/metadata/partners-purposes-notices-regulations-overrides", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "partners-purposes-notices-regulations-overrides" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"metadata_partner_id\": \"\",\n \"metadata_purpose_id\": \"\",\n \"notice_id\": \"\",\n \"organization_id\": \"\",\n \"regulation_id\": \"\",\n \"processing_rule\": \"opt-in\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-04f8b799-d3d4-4cb7-8c70-ed14f6080423" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-9867a509-eab8-4651-b809-5c2a729fd02b" } ], "id": "2ed2ea2f-6e0b-4ac7-a8b4-7604ecae9eb3", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-2ed2ea2f-6e0b-4ac7-a8b4-7604ecae9eb3" } ], "id": "70e2a4b5-0fe9-4cba-b768-10f96b39eaf2", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-70e2a4b5-0fe9-4cba-b768-10f96b39eaf2" }, { "name": "taxonomies", "item": [ { "name": "vendors", "item": [ { "name": "{id}", "item": [ { "name": "Retrieve a taxonomy item for vendors", "id": "59cced46-27fc-4d45-81e6-e40f126dd0d0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/taxonomies/vendors/:id", "host": [ "{{baseUrl}}" ], "path": [ "taxonomies", "vendors", ":id" ], "variable": [ { "id": "6820a5f2-7317-488d-ae2b-ef984d537d55", "key": "id", "value": "", "description": "(Required) The ID of the item to retrieve" } ] }, "description": "Returns a single taxonomy item" }, "response": [ { "id": "73e30585-d1cb-466c-8af9-5cce901d8d2b", "name": "A TaxonomyVendor object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/taxonomies/vendors/:id", "host": [ "{{baseUrl}}" ], "path": [ "taxonomies", "vendors", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"parent_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-73e30585-d1cb-466c-8af9-5cce901d8d2b" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-59cced46-27fc-4d45-81e6-e40f126dd0d0" }, { "name": "Update a taxonomy item for vendors", "id": "062c6c0f-9fe1-4d56-b5d6-90c371f520d2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"property_id\": \"\",\n \"metadata_id\": \"\",\n \"status\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/taxonomies/vendors/:id", "host": [ "{{baseUrl}}" ], "path": [ "taxonomies", "vendors", ":id" ], "variable": [ { "id": "4b680621-910c-4915-b169-ae19e2e066bd", "key": "id", "value": "", "description": "(Required) The ID of the item to update" } ] }, "description": "Update an existing taxonomy item" }, "response": [ { "id": "4f8e41cd-acdc-4aba-a863-864c4c3d3039", "name": "The updated TaxonomyVendor object", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"property_id\": \"\",\n \"metadata_id\": \"\",\n \"status\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/taxonomies/vendors/:id", "host": [ "{{baseUrl}}" ], "path": [ "taxonomies", "vendors", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"parent_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-4f8e41cd-acdc-4aba-a863-864c4c3d3039" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-062c6c0f-9fe1-4d56-b5d6-90c371f520d2" }, { "name": "Patch a taxonomy item for vendors", "id": "e63c6e1c-9f91-4921-b254-8f7500f783f8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"property_id\": \"\",\n \"metadata_id\": \"\",\n \"status\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/taxonomies/vendors/:id", "host": [ "{{baseUrl}}" ], "path": [ "taxonomies", "vendors", ":id" ], "variable": [ { "id": "665237c9-6f09-44be-ac8c-71e333d3cdf4", "key": "id", "value": "", "description": "(Required) The ID of the item to patch" } ] }, "description": "Partially update a taxonomy item" }, "response": [ { "id": "e14f4fae-68b0-412b-8fe7-895ccfcf9969", "name": "The patched TaxonomyVendor object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"property_id\": \"\",\n \"metadata_id\": \"\",\n \"status\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/taxonomies/vendors/:id", "host": [ "{{baseUrl}}" ], "path": [ "taxonomies", "vendors", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"parent_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-e14f4fae-68b0-412b-8fe7-895ccfcf9969" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-e63c6e1c-9f91-4921-b254-8f7500f783f8" }, { "name": "Delete a taxonomy item for vendors", "id": "b5800d6d-3d10-4003-a5bd-c7bfcfa5776e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/taxonomies/vendors/:id", "host": [ "{{baseUrl}}" ], "path": [ "taxonomies", "vendors", ":id" ], "variable": [ { "id": "34c13f38-c767-43f6-8618-32bebb8cd094", "key": "id", "value": "", "description": "(Required) The ID of the item to delete" } ] }, "description": "Delete an item" }, "response": [ { "id": "4f34eb80-9e1a-4f7d-bf69-2d8f9b38e3a0", "name": "The deleted TaxonomyVendor object", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/taxonomies/vendors/:id", "host": [ "{{baseUrl}}" ], "path": [ "taxonomies", "vendors", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"parent_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-4f34eb80-9e1a-4f7d-bf69-2d8f9b38e3a0" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-b5800d6d-3d10-4003-a5bd-c7bfcfa5776e" } ], "id": "9781bf56-4a3f-4935-af20-42028ec5d407", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-9781bf56-4a3f-4935-af20-42028ec5d407" }, { "name": "Retrieve a list of taxonomy items for vendors", "id": "026aaf22-26b5-4c58-b94b-9da3bf1ef3db", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/taxonomies/vendors", "host": [ "{{baseUrl}}" ], "path": [ "taxonomies", "vendors" ] }, "description": "Returns a list of taxonomy items for vendors" }, "response": [ { "id": "d0698fe8-2be7-4916-bc90-8ced81ff6bfd", "name": "A list of TaxonomyVendor objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/taxonomies/vendors", "host": [ "{{baseUrl}}" ], "path": [ "taxonomies", "vendors" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"parent_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"parent_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n }\n]", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-d0698fe8-2be7-4916-bc90-8ced81ff6bfd" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-026aaf22-26b5-4c58-b94b-9da3bf1ef3db" }, { "name": "Create a taxonomy item for vendors", "id": "6a2a3d67-6ab6-4d82-b335-f02e7e6bec9f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"property_id\": \"\",\n \"metadata_id\": \"\",\n \"status\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/taxonomies/vendors", "host": [ "{{baseUrl}}" ], "path": [ "taxonomies", "vendors" ] }, "description": "Create a new taxonomy item" }, "response": [ { "id": "28312cf4-4bc2-493f-8da0-eace08c494fd", "name": "The created TaxonomyVendor object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"property_id\": \"\",\n \"metadata_id\": \"\",\n \"status\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/taxonomies/vendors", "host": [ "{{baseUrl}}" ], "path": [ "taxonomies", "vendors" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"parent_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\"\n}", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-28312cf4-4bc2-493f-8da0-eace08c494fd" } ], "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-6a2a3d67-6ab6-4d82-b335-f02e7e6bec9f" } ], "id": "ba222aef-c161-46e2-93de-8df271f368c1", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-ba222aef-c161-46e2-93de-8df271f368c1" } ], "id": "b089bd61-96e9-4e55-87bd-39f66b914151", "createdAt": "2026-06-05T15:07:56.000Z", "updatedAt": "2026-06-05T15:07:56.000Z", "uid": "35240-b089bd61-96e9-4e55-87bd-39f66b914151" } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://api.didomi.io/v1" } ] }