DeleteProfile - Amazon Connect Customer Profiles

DeleteProfile

Deletes the standard customer profile and all data pertaining to the profile.

Request Syntax

POST /domains/DomainName/profiles/delete HTTP/1.1 Content-type: application/json { "ProfileId": "string" }

URI Request Parameters

The request uses the following URI parameters.

DomainName

The unique name of the domain.

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

Pattern: ^[a-zA-Z0-9_-]+$

Required: Yes

Request Body

The request accepts the following data in JSON format.

ProfileId

The unique identifier of a customer profile.

Type: String

Pattern: [a-f0-9]{32}

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "Message": "string" }

Response Elements

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

The following data is returned in JSON format by the service.

Message

A message that indicates the delete request is done.

Type: String

Errors

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

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

BadRequestException

The input you provided is invalid.

HTTP Status Code: 400

InternalServerException

An internal service error occurred.

HTTP Status Code: 500

ResourceNotFoundException

The requested resource does not exist, or access was denied.

HTTP Status Code: 404

ThrottlingException

You exceeded the maximum number of requests.

HTTP Status Code: 429

Examples

Example

This example illustrates one usage of DeleteProfile.

Sample Request

POST /domains/ExampleDomainName/profiles/delete HTTP/1.1 Content-type: application/json { "ProfileId": "3991a7d959d248bba82546b2dEXAMPLE" }

Sample Response

Content-type: application/json { "Message": "OK" }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: