Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

DeleteContactData

Deletes the specified fields containing personally identifiable information (PII) from a contact in the specified Connect Customer instance. We redact PII (such as customer endpoints, additional email recipients, and the email subject) from the contact and its associated contact trace record (CTR). The contact must be in a terminated state.

Important

This deletion is permanent and cannot be undone. Performing this operation permanently deletes the specified PII. There is no retention period; you cannot recover the data after deletion. We remove only the fields that Connect Customer identifies and stores as PII. Any PII that you place in fields outside the scope of this operation remains your responsibility to remove.

Request Syntax


POST /contact/delete/InstanceId/ContactId HTTP/1.1
Content-type: application/json

{
   "ContactFields": [ "string" ]
}

URI Request Parameters

The request uses the following URI parameters.

ContactId

The identifier of the contact. You can delete PII only from a contact that has been disconnected (is in a terminated state).

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes

InstanceId

The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: Yes

Request Body

The request accepts the following data in JSON format.

ContactFields

The categories of PII to redact from the contact. Specify one or more of the following values:

CUSTOMER_ENDPOINT – The customer's contact endpoint.
ADDITIONAL_EMAIL_RECIPIENTS – Additional recipients on an email contact (email channel only).
EMAIL_SUBJECT – The subject line of an email contact (email channel only).

Type: Array of strings

Valid Values: CUSTOMER_ENDPOINT | ADDITIONAL_EMAIL_RECIPIENTS | EMAIL_SUBJECT

Required: Yes

Response Syntax


HTTP/1.1 200

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Error Types.

ContactNotTerminatedException

The contact has not been disconnected and is not in a terminated state. To delete PII, disconnect the contact first. Wait for it to reach the terminated state, then retry the request.

HTTP Status Code: 409

InternalServiceException

Request processing failed because of an error or failure with the service.

Message: The message.

HTTP Status Code: 500

InvalidParameterException

One or more of the specified parameters are not valid.

Message: The message about the parameters.

HTTP Status Code: 400

InvalidRequestException

The request is not valid.

Message: The message about the request.
Reason: Reason why the request was invalid.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource was not found.

Message: The message about the resource.

HTTP Status Code: 404

ThrottlingException

The throttling limit has been exceeded.

HTTP Status Code: 429