Privacy Request

You can use the Privacy Request API in order to comply with California Consumer Privacy Act deletion requests through Attentive. For more information, you can review Attentive’s FAQs for CCPA or the Important Notice Regarding the CCPA of 2018.

If you submit an email address or phone number that matches a user for the identified Company or Brand, Attentive will process your deletion request for the matching user(s) only. A user's data may not be deleted if it does not match at least one of the data elements you submitted in the request (email address or phone number). Attentive may reach out to you if we require additional instructions to process your 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.

Request
Security:
OAuthFlow (privacy_requests:write)
Request Body schema: application/json
subjectEmail
string

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

subjectPhone
string

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

requestMsg
string

An optional message for an audit trail.

clientUserId
string

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

Responses
200

Delete request added successfully

400

Invalid request body

401

Unauthorized

403

Access Denied

404

The specified resource was not found

429

The user has sent too many requests in a given amount of time

500

Internal Server Error

post/privacy/delete-request
Request samples
application/json
{
  • "subjectEmail": "user@email.com",
  • "subjectPhone": "1111111111",
  • "requestMsg": "A message",
  • "clientUserId": "12345"
}
Response samples
application/json
{
  • "id": "123abc",
  • "processed": false,
  • "type": "DELETE",
  • "subjectPhone": "+5555555555",
  • "requestMsg": "The subscriber requested to be removed",
  • "requestDateTime": "2020-09-02T17:44:23.875+0000"
}

Get a CCPA delete request by Id

Request
Security:
OAuthFlow (privacy_requests:read)
path Parameters
id
required
string

Alphanumeric ID of the request to get

Responses
200

Delete request fetched successfully

401

Unauthorized

403

Access Denied

404

The specified resource was not found

429

The user has sent too many requests in a given amount of time

500

Internal Server Error

get/privacy/delete-request/{id}
Request samples
curl -i -X GET \
  'https://api.attentivemobile.com/v1/privacy/delete-request/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
Response samples
application/json
{
  • "id": "123abc",
  • "processed": true,
  • "type": "DELETE",
  • "subjectPhone": "+*****5555",
  • "subjectEmail": "a**@website.com",
  • "requestMsg": "The subscriber requested to be removed",
  • "requestDateTime": "2020-09-02T17:44:23.875+0000",
  • "processingStartDateTime": "2020-09-02T17:45:23.875+0000",
  • "processingEndDateTime": "2020-09-02T17:46:23.875+0000"
}