# Amazon Connect Customer Profiles API

> Amazon Connect Customer Profiles API on Apizie: 51 endpoints (Associates a new key value with a specific profile, such as a Contact Record ContactId. A profile object can…, Provides more information on a calculated attribute definition for Customer Profiles., Creates a new calculated attribute definition. After creation, new object data ingested into Customer…, Updates an existing calculated attribute definition. When updating the Conditions, note that increasing the…, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/cloud:amazonaws-customer-profiles/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:amazonaws-customer-profiles`
- Category: Cloud
- Status: byok
- Source: https://github.com/mermade/aws2openapi
- Page: https://zieapi.vercel.app/api/cloud/amazonaws-customer-profiles
- OpenAPI: https://zieapi.vercel.app/api/cloud/amazonaws-customer-profiles/openapi.json

Amazon Connect Customer Profiles Amazon Connect Customer Profiles is a unified customer profile for your contact center that has pre-built connectors powered by AppFlow that make it easy to combine customer information…

## Endpoints

### Associates a new key value with a specific profile, such as a Contact Record ContactId. A profile object can…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-customer-profiles/add-profile-key` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DomainName | string | yes | The unique name of the domain. |
| body | object | yes | JSON request body |

### Provides more information on a calculated attribute definition for Customer Profiles.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-customer-profiles/get-calculated-attribute-definition` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DomainName | string | yes | The unique name of the domain. |
| CalculatedAttributeName | string | yes | The unique name of the calculated attribute. |

### Creates a new calculated attribute definition. After creation, new object data ingested into Customer…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-customer-profiles/create-calculated-attribute-definition` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DomainName | string | yes | The unique name of the domain. |
| CalculatedAttributeName | string | yes | The unique name of the calculated attribute. |
| body | object | yes | JSON request body |

### Updates an existing calculated attribute definition. When updating the Conditions, note that increasing the…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-customer-profiles/update-calculated-attribute-definition` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DomainName | string | yes | The unique name of the domain. |
| CalculatedAttributeName | string | yes | The unique name of the calculated attribute. |
| body | object | yes | JSON request body |

### Deletes an existing calculated attribute definition. Note that deleting a default calculated attribute is…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-customer-profiles/delete-calculated-attribute-definition` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DomainName | string | yes | The unique name of the domain. |
| CalculatedAttributeName | string | yes | The unique name of the calculated attribute. |

### Returns information about a specific domain.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-customer-profiles/get-domain` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DomainName | string | yes | The unique name of the domain. |

### Creates a domain, which is a container for all customer data, such as customer profile attributes, object…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-customer-profiles/create-domain` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DomainName | string | yes | The unique name of the domain. |
| body | object | yes | JSON request body |

### Updates the properties of a domain, including creating or selecting a dead letter queue or an encryption…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-customer-profiles/update-domain` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DomainName | string | yes | The unique name of the domain. |
| body | object | yes | JSON request body |

### Deletes a specific domain and all of its customer data, such as customer profile attributes and their…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-customer-profiles/delete-domain` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DomainName | string | yes | The unique name of the domain. |

### Returns information about the specified event stream in a specific domain.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-customer-profiles/get-event-stream` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DomainName | string | yes | The unique name of the domain. |
| EventStreamName | string | yes | The name of the event stream provided during create operations. |

### Creates an event stream, which is a subscription to real-time events, such as when profiles are created and…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-customer-profiles/create-event-stream` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DomainName | string | yes | The unique name of the domain. |
| EventStreamName | string | yes | The name of the event stream. |
| body | object | yes | JSON request body |

### Disables and deletes the specified event stream.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-customer-profiles/delete-event-stream` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DomainName | string | yes | The unique name of the domain. |
| EventStreamName | string | yes | The name of the event stream |

### Creates an integration workflow. An integration workflow is an async process which ingests historic data and…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-customer-profiles/create-integration-workflow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DomainName | string | yes | The unique name of the domain. |
| body | object | yes | JSON request body |

### Creates a standard profile. A standard profile represents the following attributes for a customer profile in…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-customer-profiles/create-profile` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DomainName | string | yes | The unique name of the domain. |
| body | object | yes | JSON request body |

### Updates the properties of a profile. The ProfileId is required for updating a customer profile. When calling…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-customer-profiles/update-profile` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DomainName | string | yes | The unique name of the domain. |
| body | object | yes | JSON request body |

### Removes an integration from a specific domain.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-customer-profiles/delete-integration` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DomainName | string | yes | The unique name of the domain. |
| body | object | yes | JSON request body |

### Deletes the standard customer profile and all data pertaining to the profile.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-customer-profiles/delete-profile` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DomainName | string | yes | The unique name of the domain. |
| body | object | yes | JSON request body |

### Removes a searchable key from a customer profile.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-customer-profiles/delete-profile-key` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DomainName | string | yes | The unique name of the domain. |
| body | object | yes | JSON request body |

### Removes an object associated with a profile of a given ProfileObjectType.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-customer-profiles/delete-profile-object` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DomainName | string | yes | The unique name of the domain. |
| body | object | yes | JSON request body |

### Returns the object types for a specific domain.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-customer-profiles/get-profile-object-type` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DomainName | string | yes | The unique name of the domain. |
| ObjectTypeName | string | yes | The name of the profile object type. |

### Defines a ProfileObjectType. To add or remove tags on an existing ObjectType, see TagResource /…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-customer-profiles/put-profile-object-type` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DomainName | string | yes | The unique name of the domain. |
| ObjectTypeName | string | yes | The name of the profile object type. |
| body | object | yes | JSON request body |

### Removes a ProfileObjectType from a specific domain as well as removes all the ProfileObjects of that type.…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-customer-profiles/delete-profile-object-type` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DomainName | string | yes | The unique name of the domain. |
| ObjectTypeName | string | yes | The name of the profile object type. |

### Get details of specified workflow.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-customer-profiles/get-workflow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DomainName | string | yes | The unique name of the domain. |
| WorkflowId | string | yes | Unique identifier for the workflow. |

### Deletes the specified workflow and all its corresponding resources. This is an async process.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-customer-profiles/delete-workflow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DomainName | string | yes | The unique name of the domain. |
| WorkflowId | string | yes | Unique identifier for the workflow. |

### Tests the auto-merging settings of your Identity Resolution Job without merging your data. It randomly…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-customer-profiles/get-auto-merging-preview` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DomainName | string | yes | The unique name of the domain. |
| body | object | yes | JSON request body |

### Retrieve a calculated attribute for a customer profile.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-customer-profiles/get-calculated-attribute-for-profile` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DomainName | string | yes | The unique name of the domain. |
| ProfileId | string | yes | The unique identifier of a customer profile. |
| CalculatedAttributeName | string | yes | The unique name of the calculated attribute. |

### Returns information about an Identity Resolution Job in a specific domain. Identity Resolution Jobs are set…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-customer-profiles/get-identity-resolution-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DomainName | string | yes | The unique name of the domain. |
| JobId | string | yes | The unique identifier of the Identity Resolution Job. |

### Lists all of the integrations in your domain.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-customer-profiles/list-integrations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DomainName | string | yes | The unique name of the domain. |
| next-token | string | no | The pagination token from the previous ListIntegrations API call. |
| max-results | integer | no | The maximum number of objects returned per page. |
| include-hidden | boolean | no | Boolean to indicate if hidden integration should be returned. Defaults to False . |

### Returns an integration for a domain.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-customer-profiles/get-integration` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DomainName | string | yes | The unique name of the domain. |
| body | object | yes | JSON request body |

### Adds an integration between the service and a third-party service, which includes Amazon AppFlow and Amazon…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-customer-profiles/put-integration` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DomainName | string | yes | The unique name of the domain. |
| body | object | yes | JSON request body |

### Before calling this API, use CreateDomain or UpdateDomain to enable identity resolution: set Matching to…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-customer-profiles/get-matches` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| next-token | string | no | The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of… |
| max-results | integer | no | The maximum number of results to return per page. |
| DomainName | string | yes | The unique name of the domain. |

### Returns a set of profiles that belong to the same matching group using the matchId or profileId . You can…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-customer-profiles/get-similar-profiles` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| next-token | string | no | The pagination token from the previous GetSimilarProfiles API call. |
| max-results | integer | no | The maximum number of objects returned per page. |
| DomainName | string | yes | The unique name of the domain. |
| body | object | yes | JSON request body |

### Returns the template information for a specific object type. A template is a predefined ProfileObjectType,…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-customer-profiles/get-profile-object-type-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| TemplateId | string | yes | A unique identifier for the object template. |

### Get granular list of steps in workflow.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-customer-profiles/get-workflow-steps` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DomainName | string | yes | The unique name of the domain. |
| WorkflowId | string | yes | Unique identifier for the workflow. |
| next-token | string | no | The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of… |
| max-results | integer | no | The maximum number of results to return per page. |

### Lists all of the integrations associated to a specific URI in the AWS account.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-customer-profiles/list-account-integrations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| next-token | string | no | The pagination token from the previous ListAccountIntegrations API call. |
| max-results | integer | no | The maximum number of objects returned per page. |
| include-hidden | boolean | no | Boolean to indicate if hidden integration should be returned. Defaults to False . |
| body | object | yes | JSON request body |

### Lists calculated attribute definitions for Customer Profiles
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-customer-profiles/list-calculated-attribute-definitions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DomainName | string | yes | The unique name of the domain. |
| next-token | string | no | The pagination token from the previous call to ListCalculatedAttributeDefinitions. |
| max-results | integer | no | The maximum number of calculated attribute definitions returned per page. |

### Retrieve a list of calculated attributes for a customer profile.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-customer-profiles/list-calculated-attributes-for-profile` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| next-token | string | no | The pagination token from the previous call to ListCalculatedAttributesForProfile. |
| max-results | integer | no | The maximum number of calculated attributes returned per page. |
| DomainName | string | yes | The unique name of the domain. |
| ProfileId | string | yes | The unique identifier of a customer profile. |

### Returns a list of all the domains for an AWS account that have been created.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-customer-profiles/list-domains` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| next-token | string | no | The pagination token from the previous ListDomain API call. |
| max-results | integer | no | The maximum number of objects returned per page. |

### Returns a list of all the event streams in a specific domain.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-customer-profiles/list-event-streams` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DomainName | string | yes | The unique name of the domain. |
| next-token | string | no | Identifies the next page of results to return. |
| max-results | integer | no | The maximum number of objects returned per page. |
| MaxResults | string | no | Pagination limit |
| NextToken | string | no | Pagination token |

### Lists all of the Identity Resolution Jobs in your domain. The response sorts the list by JobStartTime .
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-customer-profiles/list-identity-resolution-jobs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DomainName | string | yes | The unique name of the domain. |
| next-token | string | no | The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of… |
| max-results | integer | no | The maximum number of results to return per page. |

### Lists all of the template information for object types.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-customer-profiles/list-profile-object-type-templates` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| next-token | string | no | The pagination token from the previous ListObjectTypeTemplates API call. |
| max-results | integer | no | The maximum number of objects returned per page. |

### Lists all of the templates available within the service.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-customer-profiles/list-profile-object-types` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DomainName | string | yes | The unique name of the domain. |
| next-token | string | no | Identifies the next page of results to return. |
| max-results | integer | no | The maximum number of objects returned per page. |

### Returns a list of objects associated with a profile of a given ProfileObjectType.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-customer-profiles/list-profile-objects` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| next-token | string | no | The pagination token from the previous call to ListProfileObjects. |
| max-results | integer | no | The maximum number of objects returned per page. |
| DomainName | string | yes | The unique name of the domain. |
| body | object | yes | JSON request body |

### Adds additional objects to customer profiles of a given ObjectType. When adding a specific profile object,…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-customer-profiles/put-profile-object` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DomainName | string | yes | The unique name of the domain. |
| body | object | yes | JSON request body |

### Returns a set of MatchIds that belong to the given domain.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-customer-profiles/list-rule-based-matches` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| next-token | string | no | The pagination token from the previous ListRuleBasedMatches API call. |
| max-results | integer | no | The maximum number of MatchIds returned per page. |
| DomainName | string | yes | The unique name of the domain. |

### Displays the tags associated with an Amazon Connect Customer Profiles resource. In Connect Customer…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-customer-profiles/list-tags-for-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| resourceArn | string | yes | The ARN of the resource for which you want to view tags. |

### Assigns one or more tags (key-value pairs) to the specified Amazon Connect Customer Profiles resource. Tags…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-customer-profiles/tag-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| resourceArn | string | yes | The ARN of the resource that you're adding tags to. |
| body | object | yes | JSON request body |

### Query to list all workflows.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-customer-profiles/list-workflows` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DomainName | string | yes | The unique name of the domain. |
| next-token | string | no | The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of… |
| max-results | integer | no | The maximum number of results to return per page. |
| body | object | yes | JSON request body |

### Runs an AWS Lambda job that does the following: All the profileKeys in the ProfileToBeMerged will be moved…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-customer-profiles/merge-profiles` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DomainName | string | yes | The unique name of the domain. |
| body | object | yes | JSON request body |

### Searches for profiles within a specific domain using one or more predefined search keys (e.g., _fullName,…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-customer-profiles/search-profiles` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| next-token | string | no | The pagination token from the previous SearchProfiles API call. |
| max-results | integer | no | The maximum number of objects returned per page. The default is 20 if this parameter is not included in the request. |
| DomainName | string | yes | The unique name of the domain. |
| body | object | yes | JSON request body |

### Removes one or more tags from the specified Amazon Connect Customer Profiles resource. In Connect Customer…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-customer-profiles/untag-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| resourceArn | string | yes | The ARN of the resource from which you are removing tags. |
| tagKeys | array | yes | The list of tag keys to remove from the resource. |

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:amazonaws-customer-profiles/add-profile-key" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Amazon Connect Customer Profiles API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:amazonaws-customer-profiles/add-profile-key with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Amazon Connect Customer Profiles API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Amazon Connect Customer Profiles itself also needs your own key from amazonaws.com.

### Can AI agents use the Amazon Connect Customer Profiles API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:amazonaws-customer-profiles.

### What is the status of the Amazon Connect Customer Profiles API?
Needs your own provider key (bring your own key)