Compliance Request

A regulatory request to delete or export an individual's PII.

batchComplianceRequestUuid
string

The UUID of the batch the compliance request belongs to.

createdAt
string <date-time>

The date and time the compliance request was created.

objectType
string <= 255 characters

The type of record to process, can be 'Prospect' or 'Recipient' for e-mail addresses unassociated with a prospect.

pii
object

A JSON object of personal information required for processing the compliance request.

requestObjectId
string <= 255 characters

The identifier for the record processed, for Prospects this is the Prospect ID, for Recipients this is an e-mail address.

requestType
string <= 32 characters

The type of compliance request (only 'Delete' is supported at this time).

requesterId
integer

The ID of the Outreach user who submitted the compliance request.

state
string <= 32 characters

The current state of the compliance request, can be 'pending', 'running', 'failed', or 'done'. The states on the higher level abstraction, the batch compliance request, do not map 1:1 to these states. The only states that the batch compliance request will report are either 'pending' or 'done'.

updatedAt
string <date-time>

The date and time at which the compliance request was last updated.

uuid
string <= 255 characters

The UUID of the compliance request.

{
  • "batchComplianceRequestUuid": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "objectType": "string",
  • "pii": { },
  • "requestObjectId": "string",
  • "requestType": "string",
  • "requesterId": 0,
  • "state": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "uuid": "string"
}

Compliance Request Relationships

(user (data (object) or links (object)))

The Outreach user who submitted the compliance request. Relationship requester cannot be used as a filter.

{
  • "requester": {
    }
}

⌵ Compliance Request Actions

Get a Collection of Compliance Requests

SecuritybearerAuth
Responses
200

OK

422

JSON error message

get/complianceRequests
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": [
    ]
}
Create a New Compliance Request
This is a non-standard case please read this section


SecuritybearerAuth 
Request 
Request Body schema: application/vnd.api+json
required
object
 
Responses 
201
Created


422
JSON error message


post/complianceRequests
Request samples 
application/vnd.api+json
{
  • "data": {
    }
}
Response samples 
application/vnd.api+json
{
  • "data": {
    }
}
Get a Compliance Request by ID
SecuritybearerAuth 
Request 
path Parameters
id
required
integer
 
Responses 
200
OK


404
Not Found


get/complianceRequests/{id}
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": {
    }
}