Acquia CDP

Payload and response code

Response parameters

If the API call is successful, CDP sends the values for the following parameters in the response:

Parameter

Description

eventId

The unique ID that tracks the data erasure status for the group of customers ready for erasure in a single request.

readyForDataErasure

The list of customer IDs found and added to the data erasure queue.

notFound

The list of customer IDs not found and not added to the data erasure queue.

pendingForDataErasure

The list of customer IDs ignored because of a pending data erasure request.

failedToAccept

The list of customer IDs failed to register for some internal errors.

Note

To view the status of your data erasure request in the CDP user interface, sign in to the CDP user interface and click Data Erasure. For more information, see Data erasure

Success response code

200

Sample success response body

{
  "eventId": "<eventId>",
  "readyForDataErasure": [
    "<customerId1>",
    "<customerId2>",
    "<customerIdN>"
  ],
  "notFound": [
    "<customerId1>",
    "<customerId2>",
    "<customerIdN>"
  ],
  "pendingForDataErasure": [
    "<customerId1>",
    "<customerId2>",
    "<customerIdN>"
  ],
  "failedToAccept": [
    "<customerId1>",
    "<customerId2>",
    "<customerIdN>"
  ]
}

Sample failure response codes

  • 400: There is an invalid or bad request. When checking if the request payload contains all the necessary information and If the request misses any of the required fields or has invalid values, the system outputs this code. For example, you get this error if you make the data erasure request for more than 200 customer IDs through a single API call.

  • 404: There is no valid customer ID found in the data warehouse.

  • 500: There is intermittent API or server error.

Sample success response body:

{
    "errorCode": <errorCode>,
    "userMessage": <errorMessage>,
    "developerMessage": <errorDetails>
}

Note

When the API is processed, you must call the logout endpoint to terminate the current session. For more information about the logout endpoint, see Logging out of the API session.