Amazon Connect Cases
Cases actions Cases data types With Connect Customer Cases, your agents can track and manage customer issues that require multiple interactions, follow-up…
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
Cases actions Cases data types With Connect Customer Cases, your agents can track and manage customer issues that require multiple interactions, follow-up tasks, and teams in your contact center. A case represents a customer issue. It records the issue, the steps and interactions taken to resolve the issue, and the outcome. For more information, see Connect Customer Cases in the Connect Customer Administrator Guide .
Endpoints 47
Case
- POSTBatch create related item
/cases:batchCreateRelatedItemCreates a comment and associates it with multiple cases in a single request. All cases must belong to the same domain. This operation supports only the… - PUTBatch update case
/cases:batchUpdateCaseUpdates fields on multiple cases in a single request. All cases must belong to the same domain. Set the title, status, and customer ID through the top-level… - POSTCreate case
/domains/:domainId/casesIf you provide a value for PerformedBy.UserArn , you must also have the connect:DescribeUser permission on the user ARN that you provide. Creates a case in… - PUTUpdate case
/domains/:domainId/cases/:caseIdIf you provide a value for PerformedBy.UserArn , you must also have the connect:DescribeUser permission on the user ARN that you provide. Updates the values… - POSTGet case
/domains/:domainId/cases/:caseIdReturns information about a specific case if it exists. - DELETEDelete case
/domains/:domainId/cases/:caseIdThe DeleteCase API permanently deletes a case and all its associated resources from the cases data store. After a successful deletion, you cannot: Retrieve… - POSTGet case audit events
/domains/:domainId/cases/:caseId/audit-historyReturns the audit history about a specific case if it exists. - POSTGet merge cases status
/domains/:domainId/cases/:caseId/merge-statusReturns the merge status of a case. Use this operation to track a merge that you started with StartMergeCases , or to check whether a case is part of a merge… - POSTList cases for contact
/domains/:domainId/list-cases-for-contactLists cases for a given contact. - POSTSearch cases
/domains/:domainId/cases-searchSearches for cases within their associated Cases domain. Search results are returned as a paginated list of abridged case documents. For customer_id you must… - POSTStart merge cases
/domains/:domainId/cases/:caseId/mergeMerges a secondary case into a primary case. The primary case, which you specify in the request URI, remains active. Both cases must belong to the same…
Case rule
- POSTBatch get case rule
/domains/:domainId/rules-batchGets a batch of case rules. In the Connect Customer admin website, case rules are known as case field conditions . For more information about case field… - POSTCreate case rule
/domains/:domainId/case-rulesCreates a new case rule. In the Connect Customer admin website, case rules are known as case field conditions . For more information about case field… - PUTUpdate case rule
/domains/:domainId/case-rules/:caseRuleIdUpdates a case rule. In the Connect Customer admin website, case rules are known as case field conditions . For more information about case field conditions,… - DELETEDelete case rule
/domains/:domainId/case-rules/:caseRuleIdDeletes a case rule. In the Connect Customer admin website, case rules are known as case field conditions . For more information about case field conditions,… - POSTList case rules
/domains/:domainId/rules-list/?maxResults=0&nextToken=stringLists all case rules in a Cases domain. In the Connect Customer admin website, case rules are known as case field conditions . For more information about case…
Field
- POSTBatch get field
/domains/:domainId/fields-batchReturns the description for the list of fields in the request parameters. - PUTBatch put field options
/domains/:domainId/fields/:fieldId/optionsCreates and updates a set of field options for a single select field in a Cases domain. - POSTCreate field
/domains/:domainId/fieldsCreates a field in the Cases domain. This field is used to define the case object model (that is, defines what data can be captured on cases) in a Cases domain. - PUTUpdate field
/domains/:domainId/fields/:fieldIdUpdates the properties of an existing field. - DELETEDelete field
/domains/:domainId/fields/:fieldIdDeletes a field from a Cases template. After a field is deleted: You can still retrieve the field by calling BatchGetField . You cannot update a deleted field… - POSTList field options
/domains/:domainId/fields/:fieldId/options-list?maxResults=0&nextToken=string&values=Lists all of the field options for a field identifier in the domain. - POSTList fields
/domains/:domainId/fields-list?maxResults=0&nextToken=stringLists all fields in a Cases domain.
Domain
- POSTCreate domain
/domainsCreates a domain, which is a container for all case data, such as cases, fields, templates and layouts. Each Connect Customer instance can be associated with… - POSTGet domain
/domains/:domainIdReturns information about a specific domain if it exists. - DELETEDelete domain
/domains/:domainIdDeletes a Cases domain. After deleting your domain you must disassociate the deleted domain from your Connect Customer instance with another API call before… - PUTPut case event configuration
/domains/:domainId/case-event-configurationAdds case event publishing configuration. For a complete list of fields you can add to the event message, see Create case fields in the Connect Customer… - POSTGet case event configuration
/domains/:domainId/case-event-configurationReturns the case event publishing configuration. - POSTList domains
/domains-list?maxResults=0&nextToken=stringLists all cases domains in the Amazon Web Services account. Each list item is a condensed summary object of the domain. - POSTSearch all related items
/domains/:domainId/related-items-searchSearches for related items across all cases within a domain. This is a global search operation that returns related items from multiple cases, unlike the…
Layout
- POSTCreate layout
/domains/:domainId/layoutsCreates a layout in the Cases domain. Layouts define the following configuration in the top section and More Info tab of the Cases user interface: Fields to… - PUTUpdate layout
/domains/:domainId/layouts/:layoutIdUpdates the attributes of an existing layout. If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. A… - POSTGet layout
/domains/:domainId/layouts/:layoutIdReturns the details for the requested layout. - DELETEDelete layout
/domains/:domainId/layouts/:layoutIdDeletes a layout from a Cases template. You can delete up to 100 layouts per domain. After a layout is deleted: You can still retrieve the layout by calling… - POSTList layouts
/domains/:domainId/layouts-list?maxResults=0&nextToken=stringLists all layouts in the given cases domain. Each list item is a condensed summary object of the layout.
Related item
- POSTCreate related item
/domains/:domainId/cases/:caseId/related-items/Creates a related item (comments, tasks, and contacts) and associates it with a case. There's a quota for the number of fields allowed in a Custom type… - PUTUpdate related item
/domains/:domainId/cases/:caseId/related-items/:relatedItemIdUpdates the content of a related item associated with a case. The following related item types are supported: Comment - Update the text content of an existing… - DELETEDelete related item
/domains/:domainId/cases/:caseId/related-items/:relatedItemIdDeletes the related item resource under a case. This API cannot be used on a FILE type related attachment. To delete this type of file, use the… - POSTSearch related items
/domains/:domainId/cases/:caseId/related-items-searchSearches for related items that are associated with a case. If no filters are provided, this returns all related items associated with a case.
Template
- POSTCreate template
/domains/:domainId/templatesCreates a template in the Cases domain. This template is used to define the case object model (that is, to define what data can be captured on cases) in a… - PUTUpdate template
/domains/:domainId/templates/:templateIdUpdates the attributes of an existing template. The template attributes that can be modified include name , description , layoutConfiguration , requiredFields… - POSTGet template
/domains/:domainId/templates/:templateIdReturns the details for the requested template. Other template APIs are: CreateTemplate DeleteTemplate ListTemplates UpdateTemplate - DELETEDelete template
/domains/:domainId/templates/:templateIdDeletes a Cases template. You can delete up to 100 templates per domain. After a Cases template is deleted: You can still retrieve the template by calling… - POSTList templates
/domains/:domainId/templates-list?maxResults=0&nextToken=string&status=Lists all of the templates in a Cases domain. Each list item is a condensed summary object of the template. Other template APIs are: CreateTemplate…
- GETList tags for resource
/tags/:arnLists tags for a resource. - POSTTag resource
/tags/:arnAdds tags to a resource. - DELETEUntag resource
/tags/:arn?tagKeys=Untags a resource.
API details
- Base URL
https://cases.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 47 operations on 34 pathsPOST 29PUT 9DELETE 8GET 1
- Main resources
- Case 11Domain 7Field 7Case rule 5Layout 5Template 5Related item 4
- Description format
- AWS Smithy model, API version
2022-10-03 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the Amazon Connect Cases 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 Cases 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 “Batch create related item” (POST /cases:batchCreateRelatedItem), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Amazon Connect Cases?
Cases actions Cases data types With Connect Customer Cases, your agents can track and manage customer issues that require multiple interactions, follow-up… It is listed under Communication and has 47 endpoints.
Who publishes the Amazon Connect Cases?
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 Cases?
Requests go to https://cases.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the Amazon Connect Cases?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the Amazon Connect Cases have?
47 operations on 34 paths (29 POST, 9 PUT, 8 DELETE, 1 GET). The largest groups are Case, Domain, Field, Case rule.
Is forking the Amazon Connect Cases free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.