Batch delete consent preference records by anchor identifier.
This endpoint deletes preference records from the Preference Store only and does not trigger DSR workflows or delete data in downstream systems.
Rate Limits
- 100 requests per organization per minute (default).
- This limit can be increased upon request.
Rate Limiting Headers
X-RateLimit-Limit: The maximum number of requests allowed in the current window.X-RateLimit-Remaining: The number of requests remaining in the current window.X-RateLimit-Reset: The time at which the current rate limit window resets in ISO 8601 format.Retry-After: (on 429) The number of seconds to wait before making a new request.
POST
/v1/preferences/{partition}/deleteIn your request headers, pass authorization: Bearer <<token>>.
If you're self-hosting Sombra, also add the request header x-sombra-authorization: Bearer <<sombraInternalKey>>. You can read more about request authorization here.
Requires scope:
Modify User Stored Preferences
authorizationstringAn API key generated from the Transcend dashboard: https://app.transcend.io/infrastructure/api-keys. |
x-sombra-authorizationstringThe Sombra internal key. This header is only needed for self-hosted Sombra gateways. See https://docs.transcend.io/docs/dsr-automation/api-integration/authentication#authenticating-to-sombra |
content-typestringSpecify content-type: application/json for a JSON response from the Transcend API. |
application/json
recordsarray<object>(required)List of delete operations to remove whole preference records. |
Request Body Examples
Delete single record:
{
"records": [
{
"anchorIdentifier": {
"name": "email",
"value": "xyz@foo.com"
},
"timestamp": "2025-11-26T17:33:13.515Z"
}
]
}Delete multiple records:
{
"records": [
{
"anchorIdentifier": {
"name": "email",
"value": "user1@example.com"
},
"timestamp": "2025-11-26T17:33:13.515Z"
},
{
"anchorIdentifier": {
"name": "phone",
"value": "+15551234567"
},
"timestamp": "2025-11-26T17:34:00.000Z"
}
]
}200 (OK)
application/jsonThe response payload contains the results of the batch delete operation. Each record in the records array corresponds to an input record and indicates whether the delete operation succeeded or failed, along with any relevant error messages. Note: When the response includes failures, clients can only retry the failed items from the original request after addressing the reported errors. When the response includes errors, clients should retry the entire batch after addressing the reported errors.
Response Body
recordsarray<object> |
failuresarray<object> |
errorsarray<string> |
Response Body Examples
Successful delete:
{
"records": [
{
"success": true
}
],
"failures": [],
"errors": []
}Succeful batch delete :
{
"records": [
{
"success": true
},
{
"success": true
},
{
"success": true
}
],
"failures": [],
"errors": []
}Partial Success:
{
"records": [
{
"success": false,
"errorMessage": "No preference record found for anchor identifier: \"email\" with value: \"missing@example.com\""
},
{
"success": true
}
],
"failures": [
{
"index": 0,
"error": "No preference record found for anchor identifier: \"email\" with value: \"missing@example.com\""
}
],
"errors": []
}400 (Bad Request)
application/jsonBad Request
Response Body
errorsarray<string> |
Response Body Example
Batch too large:
{
"errors": [
"Too many preference record deletions in a batch. Max: 10"
]
}401 (Unauthorized)
application/jsonThere was a problem authenticating your request. This may be an issue with the Transcend API key ("authorization" header), or the Sombra API key ("x-sombra-authorization" header used for self-hosted gateways only).
413 (Request Entity Too Large)
application/jsonThe request body is too large. JSON and raw bodies must be less than 50MB. URL encoded bodies must be less than 30MB.
429 (Too Many Requests)
application/jsonYou are sending requests too quickly and have hit our rate limit. If you hit this, you'll need to throttle your request velocity or try again later.
Response Headers
Retry-Afterinteger |
X-RateLimit-Limitinteger |
X-RateLimit-Remaininginteger |
X-RateLimit-Resetinteger |
500 (Internal Server Error)
application/jsonA 5xx error means there is either an issue with your self-hosted gateway, or a Transcend server is having issues. You check our system status at status.transcend.io. Please reach out to Transcend support if you're experiencing this error.
502 (Bad Gateway)
application/jsonAn upstream service on Transcend's side is having issues. You check our system status at status.transcend.io. Please reach out to Transcend support if you're experiencing this error.