Amazon Connect Customer Profiles
Connect Customer Customer Profiles Customer Profiles actions Customer Profiles data types Connect Customer Customer Profiles is a unified customer profile for…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Connect Customer Customer Profiles
Customer Profiles actions
Customer Profiles data types
Connect Customer 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 from third party applications, such as Salesforce (CRM), ServiceNow
(ITSM), and your enterprise resource planning (ERP), with contact history from your Connect Customer contact center.
For more information about the Connect Customer Customer Profiles feature, see Use Customer
Profiles in the Connect Customer Administrator's Guide .
Endpoints 115
- POSTAdd profile key
/domains/:DomainName/profiles/keysAssociates a new key value with a specific profile, such as a Contact Record ContactId. A profile object can have a single unique key and any number of… - GETGet stream for segments
/domains/:DomainName/segment-streamsReturns information about the segment membership event stream configured for a specific domain, including the stream state and associated segments. - POSTAssociate stream for segments
/domains/:DomainName/segment-streamsAssociates an Amazon Kinesis data stream to receive segment membership events for a given domain. This is a domain-level configuration that applies to all… - DELETEDisassociate stream for segments
/domains/:DomainName/segment-streamsDisassociates the Amazon Kinesis data stream configured for segment membership events. All active segment subscriptions delivering events to this stream are… - POSTBatch get calculated attribute for profile
/domains/:DomainName/calculated-attributes/:CalculatedAttributeName/batch-get-for-profilesFetch the possible attribute values given the attribute name. - POSTBatch get profile
/domains/:DomainName/batch-get-profilesGet a batch of profiles. - PUTBatch put profile object
/domains/:DomainName/profiles/objects/batch-put-profile-objectAdds multiple profile objects to a domain of a given ObjectType in a single API call. When adding a specific profile object, like a Contact Record, an… - GETGet calculated attribute definition
/domains/:DomainName/calculated-attributes/:CalculatedAttributeNameProvides more information on a calculated attribute definition for Customer Profiles. - PUTUpdate calculated attribute definition
/domains/:DomainName/calculated-attributes/:CalculatedAttributeNameUpdates an existing calculated attribute definition. When updating the Conditions, note that increasing the date range of a calculated attribute will not… - POSTCreate calculated attribute definition
/domains/:DomainName/calculated-attributes/:CalculatedAttributeNameCreates a new calculated attribute definition. After creation, new object data ingested into Customer Profiles will be included in the calculated attribute,… - DELETEDelete calculated attribute definition
/domains/:DomainName/calculated-attributes/:CalculatedAttributeNameDeletes an existing calculated attribute definition. Note that deleting a default calculated attribute is possible, however once deleted, you will be unable… - GETGet domain
/domains/:DomainNameReturns information about a specific domain. - PUTUpdate domain
/domains/:DomainNameUpdates the properties of a domain, including creating or selecting a dead letter queue or an encryption key. After a domain is created, the name can’t be… - POSTCreate domain
/domains/:DomainNameCreates a domain, which is a container for all customer data, such as customer profile attributes, object types, profile keys, and encryption keys. You can… - DELETEDelete domain
/domains/:DomainNameDeletes a specific domain and all of its customer data, such as customer profile attributes and their related objects. - GETGet domain layout
/domains/:DomainName/layouts/:LayoutDefinitionNameGets the layout to view data for a specific domain. This API can only be invoked from the Amazon Connect admin website. - PUTUpdate domain layout
/domains/:DomainName/layouts/:LayoutDefinitionNameUpdates the layout used to view data for a specific domain. This API can only be invoked from the Amazon Connect admin website. - POSTCreate domain layout
/domains/:DomainName/layouts/:LayoutDefinitionNameCreates the layout to view data for a specific domain. This API can only be invoked from the Amazon Connect admin website. - DELETEDelete domain layout
/domains/:DomainName/layouts/:LayoutDefinitionNameDeletes the layout used to view data for a specific domain. This API can only be invoked from the Amazon Connect admin website. - GETGet event stream
/domains/:DomainName/event-streams/:EventStreamNameReturns information about the specified event stream in a specific domain. - POSTCreate event stream
/domains/:DomainName/event-streams/:EventStreamNameCreates an event stream, which is a subscription to real-time events, such as when profiles are created and updated through Connect Customer Customer… - DELETEDelete event stream
/domains/:DomainName/event-streams/:EventStreamNameDisables and deletes the specified event stream. - GETGet event trigger
/domains/:DomainName/event-triggers/:EventTriggerNameGet a specific Event Trigger from the domain. - PUTUpdate event trigger
/domains/:DomainName/event-triggers/:EventTriggerNameUpdate the properties of an Event Trigger. - POSTCreate event trigger
/domains/:DomainName/event-triggers/:EventTriggerNameCreates an event trigger, which specifies the rules when to perform action based on customer's ingested data. Each event stream can be associated with only… - DELETEDelete event trigger
/domains/:DomainName/event-triggers/:EventTriggerNameDisable and deletes the Event Trigger. You cannot delete an Event Trigger with an active Integration associated. - POSTCreate integration workflow
/domains/:DomainName/workflows/integrationsCreates an integration workflow. An integration workflow is an async process which ingests historic data and sets up an integration for ongoing updates. The… - PUTUpdate profile
/domains/:DomainName/profilesUpdates the properties of a profile. The ProfileId is required for updating a customer profile. When calling the UpdateProfile API, specifying an empty string… - POSTCreate profile
/domains/:DomainName/profilesCreates a standard profile. A standard profile represents the following attributes for a customer profile in a domain. - GETGet recommender
/domains/:DomainName/recommenders/:RecommenderName?training-metrics-count=0Retrieves a recommender. - POSTCreate recommender
/domains/:DomainName/recommenders/:RecommenderNameCreates a recommender - DELETEDelete recommender
/domains/:DomainName/recommenders/:RecommenderNameDeletes a recommender. - PATCHUpdate recommender
/domains/:DomainName/recommenders/:RecommenderNameUpdates the properties of an existing recommender, allowing you to modify its configuration and description. - GETGet recommender filter
/domains/:DomainName/recommender-filters/:RecommenderFilterNameRetrieves information about a specific recommender filter in a domain. - POSTCreate recommender filter
/domains/:DomainName/recommender-filters/:RecommenderFilterNameCreates a recommender filter. A recommender filter specifies which items to include or exclude from recommendations. - DELETEDelete recommender filter
/domains/:DomainName/recommender-filters/:RecommenderFilterNameDeletes a recommender filter from a domain. - GETGet recommender schema
/domains/:DomainName/recommender-schemas/:RecommenderSchemaNameRetrieves information about a specific recommender schema in a domain. - POSTCreate recommender schema
/domains/:DomainName/recommender-schemas/:RecommenderSchemaNameCreates a recommender schema. A recommender schema defines the set of data columns available for training recommenders and filters under a domain. - DELETEDelete recommender schema
/domains/:DomainName/recommender-schemas/:RecommenderSchemaNameDeletes a recommender schema from a domain. - GETGet segment definition
/domains/:DomainName/segment-definitions/:SegmentDefinitionNameGets a segment definition from the domain. - POSTCreate segment definition
/domains/:DomainName/segment-definitions/:SegmentDefinitionNameCreates a segment definition associated to the given domain. - DELETEDelete segment definition
/domains/:DomainName/segment-definitions/:SegmentDefinitionNameDeletes a segment definition from the domain. - POSTCreate segment estimate
/domains/:DomainName/segment-estimatesCreates a segment estimate query. - POSTCreate segment snapshot
/domains/:DomainName/segments/:SegmentDefinitionName/snapshotsTriggers a job to export a segment to a specified destination. - GETList upload jobs
/domains/:DomainName/upload-jobs?max-results=0&next-token=stringThis API retrieves a list of upload jobs for the specified domain. - POSTCreate upload job
/domains/:DomainName/upload-jobsCreates an Upload job to ingest data for segment imports. The metadata is created for the job with the provided field mapping and unique key. - GETGet domain object type
/domains/:DomainName/domain-object-types/:ObjectTypeNameReturn a DomainObjectType for the input Domain and ObjectType names. - PUTPut domain object type
/domains/:DomainName/domain-object-types/:ObjectTypeNameCreate/Update a DomainObjectType in a Customer Profiles domain. To create a new DomainObjectType, Data Store needs to be enabled on the Domain. - DELETEDelete domain object type
/domains/:DomainName/domain-object-types/:ObjectTypeNameDelete a DomainObjectType for the given Domain and ObjectType name. - POSTDelete integration
/domains/:DomainName/integrations/deleteRemoves an integration from a specific domain. - POSTDelete profile
/domains/:DomainName/profiles/deleteDeletes the standard customer profile and all data pertaining to the profile. - POSTDelete profile key
/domains/:DomainName/profiles/keys/deleteRemoves a searchable key from a customer profile. - POSTDelete profile object
/domains/:DomainName/profiles/objects/deleteRemoves an object associated with a profile of a given ProfileObjectType. - GETGet profile object type
/domains/:DomainName/object-types/:ObjectTypeNameReturns the object types for a specific domain. - PUTPut profile object type
/domains/:DomainName/object-types/:ObjectTypeNameDefines a ProfileObjectType. To add or remove tags on an existing ObjectType, see TagResource / UntagResource . - DELETEDelete profile object type
/domains/:DomainName/object-types/:ObjectTypeNameRemoves a ProfileObjectType from a specific domain as well as removes all the ProfileObjects of that type. It also disables integrations from this specific… - GETGet segment subscription
/domains/:DomainName/segment-definitions/:SegmentDefinitionName/subscriptionsReturns the current subscription configuration, execution schedule, and status for segment membership events. - PUTPut segment subscription
/domains/:DomainName/segment-definitions/:SegmentDefinitionName/subscriptionsCreates or updates a segment subscription for membership events. When a subscription is created, an initial snapshot is taken and the system begins monitoring… - DELETEDelete segment subscription
/domains/:DomainName/segment-definitions/:SegmentDefinitionName/subscriptionsDeletes a segment subscription for membership events. All active event notifications for this segment are stopped. - GETGet workflow
/domains/:DomainName/workflows/:WorkflowIdGet details of specified workflow. - DELETEDelete workflow
/domains/:DomainName/workflows/:WorkflowIdDeletes the specified workflow and all its corresponding resources. This is an async process. - POSTDetect profile object type
/domains/:DomainName/detect/object-typesThe process of detecting profile object type mapping by using given objects. - POSTGet auto merging preview
/domains/:DomainName/identity-resolution-jobs/auto-merging-previewTests the auto-merging settings of your Identity Resolution Job without merging your data. It randomly selects a sample of matching groups from the existing… - GETGet calculated attribute for profile
/domains/:DomainName/profile/:ProfileId/calculated-attributes/:CalculatedAttributeNameRetrieve a calculated attribute for a customer profile. - GETGet identity resolution job
/domains/:DomainName/identity-resolution-jobs/:JobIdReturns information about an Identity Resolution Job in a specific domain. Identity Resolution Jobs are set up using the Amazon Connect admin console. For… - GETList integrations
/domains/:DomainName/integrations?next-token=string&max-results=0&include-hidden=trueLists all of the integrations in your domain. - PUTPut integration
/domains/:DomainName/integrationsAdds an integration between the service and a third-party service, which includes Amazon AppFlow and Amazon Connect. An integration can belong to only one… - POSTGet integration
/domains/:DomainName/integrationsReturns an integration for a domain. - GETGet matches
/domains/:DomainName/matches?next-token=string&max-results=0Before calling this API, use CreateDomain or UpdateDomain to enable identity resolution: set Matching to true. GetMatches returns potentially matching… - POSTGet similar profiles
/domains/:DomainName/matches?next-token=string&max-results=0Returns a set of profiles that belong to the same matching group using the matchId or profileId . You can also specify the type of matching that you want for… - POSTGet object type attribute statistics
/domains/:DomainName/object-types/:ObjectTypeName/attributes/:AttributeName/statisticsThe GetObjectTypeAttributeValues API delivers statistical insights about attributes within a specific object type, but is exclusively available for domains… - GETGet profile history record
/domains/:DomainName/profiles/:ProfileId/history-records/:IdReturns a history record for a specific profile, for a specific domain. - GETGet profile object type template
/templates/:TemplateIdReturns the template information for a specific object type. A template is a predefined ProfileObjectType, such as “Salesforce-Account” or… - POSTGet profile recommendations
/domains/:DomainName/profiles/:ProfileId/recommendationsFetches the recommendations for a profile in the input Customer Profiles domain. Fetches all the profile recommendations - GETGet segment estimate
/domains/:DomainName/segment-estimates/:EstimateIdGets the result of a segment estimate query. - POSTGet segment membership
/domains/:DomainName/segments/:SegmentDefinitionName/membershipDetermines if the given profiles are within a segment. - GETGet segment snapshot
/domains/:DomainName/segments/:SegmentDefinitionName/snapshots/:SnapshotIdRetrieve the latest status of a segment snapshot. - GETGet upload job
/domains/:DomainName/upload-jobs/:JobIdThis API retrieves the details of a specific upload job. - PUTStart upload job
/domains/:DomainName/upload-jobs/:JobIdThis API starts the processing of an upload job to ingest profile data. - GETGet upload job path
/domains/:DomainName/upload-jobs/:JobId/pathThis API retrieves the pre-signed URL and client token for uploading the file associated with the upload job. - GETGet workflow steps
/domains/:DomainName/workflows/:WorkflowId/steps?next-token=string&max-results=0Get granular list of steps in workflow. - POSTList account integrations
/integrations?next-token=string&max-results=0&include-hidden=trueLists all of the integrations associated to a specific URI in the AWS account. - GETList calculated attribute definitions
/domains/:DomainName/calculated-attributes?next-token=string&max-results=0Lists calculated attribute definitions for Customer Profiles - GETList calculated attributes for profile
/domains/:DomainName/profile/:ProfileId/calculated-attributes?next-token=string&max-results=0Retrieve a list of calculated attributes for a customer profile. - GETList domain layouts
/domains/:DomainName/layouts?next-token=string&max-results=0Lists the existing layouts that can be used to view data for a specific domain. This API can only be invoked from the Amazon Connect admin website. - GETList domain object types
/domains/:DomainName/domain-object-types?max-results=0&next-token=stringList all DomainObjectType(s) in a Customer Profiles domain. - GETList domains
/domains?next-token=string&max-results=0Returns a list of all the domains for an AWS account that have been created. - GETList event streams
/domains/:DomainName/event-streams?next-token=string&max-results=0Returns a list of all the event streams in a specific domain. - GETList event triggers
/domains/:DomainName/event-triggers?next-token=string&max-results=0List all Event Triggers under a domain. - GETList identity resolution jobs
/domains/:DomainName/identity-resolution-jobs?next-token=string&max-results=0Lists all of the Identity Resolution Jobs in your domain. The response sorts the list by JobStartTime . - GETList object type attribute values
/domains/:DomainName/object-types/:ObjectTypeName/attributes/:AttributeName/values?next-token=string&max-results=0The ListObjectTypeAttributeValues API provides access to the most recent distinct values for any specified attribute, making it valuable for real-time data… - GETList object type attributes
/domains/:DomainName/object-types/:ObjectTypeName/attributes?next-token=string&max-results=0Fetch the possible attribute values given the attribute name. - GETList profile attribute values
/domains/:DomainName/profile-attributes/:AttributeName/valuesFetch the possible attribute values given the attribute name. - POSTList profile history records
/domains/:DomainName/profiles/history-records?next-token=string&max-results=0Returns a list of history records for a specific profile, for a specific domain. - GETList profile object type templates
/templates?next-token=string&max-results=0Lists all of the template information for object types. - GETList profile object types
/domains/:DomainName/object-types?next-token=string&max-results=0Lists all of the templates available within the service. - PUTPut profile object
/domains/:DomainName/profiles/objectsAdds additional objects to customer profiles of a given ObjectType. When adding a specific profile object, like a Contact Record, an inferred profile can get… - POSTList profile objects
/domains/:DomainName/profiles/objects?next-token=string&max-results=0Returns a list of objects associated with a profile of a given ProfileObjectType. - GETList recommender filters
/domains/:DomainName/recommender-filters?max-results=0&next-token=stringReturns a list of recommender filters in the specified domain. - GETList recommender recipes
/recommender-recipes?max-results=0&next-token=stringReturns a list of available recommender recipes that can be used to create recommenders. - GETList recommender schemas
/domains/:DomainName/recommender-schemas?max-results=0&next-token=stringReturns a list of recommender schemas in the specified domain. - GETList recommenders
/domains/:DomainName/recommenders?max-results=0&next-token=stringReturns a list of recommenders in the specified domain. - GETList rule based matches
/domains/:DomainName/profiles/ruleBasedMatches?next-token=string&max-results=0Returns a set of MatchIds that belong to the given domain. - GETList segment definitions
/domains/:DomainName/segment-definitions?max-results=0&next-token=stringLists all segment definitions under a domain. - GETList segment subscription events
/domains/:DomainName/segment-definitions/:SegmentDefinitionName/subscription-events?max-results=0&next-token=stringReturns the most recent membership events for a segment. Each event represents a profile that entered or exited the segment. This operation is paginated. - GETList tags for resource
/tags/:resourceArnDisplays the tags associated with an Amazon Connect Customer Profiles resource. In Connect Customer Profiles, domains, profile object types, and integrations… - POSTTag resource
/tags/:resourceArnAssigns one or more tags (key-value pairs) to the specified Amazon Connect Customer Profiles resource. Tags can help you organize and categorize your… - DELETEUntag resource
/tags/:resourceArn?tagKeys=Removes one or more tags from the specified Amazon Connect Customer Profiles resource. In Connect Customer Profiles, domains, profile object types, and… - POSTList workflows
/domains/:DomainName/workflows?next-token=string&max-results=0Query to list all workflows. - POSTMerge profiles
/domains/:DomainName/profiles/objects/mergeRuns an AWS Lambda job that does the following: All the profileKeys in the ProfileToBeMerged will be moved to the main profile. All the objects in the… - POSTSearch profiles
/domains/:DomainName/profiles/search?next-token=string&max-results=0Searches for profiles within a specific domain using one or more predefined search keys (e.g., _fullName, _phone, _email, _account, etc.) and/or… - POSTSearch recommendations
/domains/:DomainName/recommendationsRetrieves recommendations for a profile in a specific domain. The profile is identified using a search key, which consists of a KeyName and a KeyValues list.… - PUTStart recommender
/domains/:DomainName/recommenders/:RecommenderName/startStarts a recommender that was previously stopped. Starting a recommender resumes its ability to generate recommendations. - PUTStop recommender
/domains/:DomainName/recommenders/:RecommenderName/stopStops a recommender, suspending its ability to generate recommendations. The recommender can be restarted later using StartRecommender. - PUTStop upload job
/domains/:DomainName/upload-jobs/:JobId/stopThis API stops the processing of an upload job.
API details
- Base URL
https://profile.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 115 operations on 74 pathsGET 47POST 37PUT 15DELETE 15PATCH 1
- Description format
- AWS Smithy model, API version
2020-08-15 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the Amazon Connect Customer Profiles in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon Connect Customer Profiles collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Add profile key” (POST /domains/:DomainName/profiles/keys), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Amazon Connect Customer Profiles?
Connect Customer Customer Profiles Customer Profiles actions Customer Profiles data types Connect Customer Customer Profiles is a unified customer profile for… It is listed under Communication and has 115 endpoints.
Who publishes the Amazon Connect Customer Profiles?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Amazon Connect Customer Profiles?
Requests go to https://profile.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the Amazon Connect Customer Profiles?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the Amazon Connect Customer Profiles have?
115 operations on 74 paths (47 GET, 37 POST, 15 PUT, 15 DELETE, 1 PATCH).
Is forking the Amazon Connect Customer Profiles free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.