v1

latestOpenAPI 3.0.32026-07-24235275.4 KB

Privacy Request

Add a deletion request

Make a call to this endpoint to create a new privacy deletion request. This will delete a subscriber within thirty days, provided the call was successful. Use the GET endpoint with the id returned to confirm deletion.

post/privacy/delete-request

Request body

subjectEmailstring

Email of a subscriber. Only required if subjectPhone is empty.

subjectPhonestring

Phone of a subscriber. Only required if subjectEmail is empty.

requestMsgstring

An optional message for an audit trail.

clientUserIdstring

ClientUserId of a subscriber. Only required if subjectEmail and subjectPhone is empty.

Response

Delete request added successfully

idstring

ID of the privacy request.

processedboolean

Status of the request.

typestring

Type of the request.

subjectEmailstring

Email of a subscriber.

subjectPhonestring

Phone of a subscriber.

requestMsgstring

An optional message for an audit trail.

requestDateTimestring

Timestamp of when the request was made.

processingStartDateTimestring

Timestamp of when processing of the request began.

processingEndDateTimestring

Timestamp of when processing of the request completed.