Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1443311204.0 KB

If you provide a value for PerformedBy.UserArn you must also have connect:DescribeUser permission on the User ARN resource that you provide

Creates a case in the specified Cases domain. Case system and custom fields are taken as an array id/value pairs with a declared data types.

When creating a case from a template that has tag propagation configurations, the specified tags are automatically applied to the case.

The following fields are required when creating a case:

  • customer_id - You must provide the full customer profile ARN in this format: arn:aws:profile:your_AWS_Region:your_AWS_account ID:domains/your_profiles_domain_name/profiles/profile_ID

  • title

post/domains/{domainId}/cases

Path parameters

domainIdstring required

The unique identifier of the Cases domain.

Request body

templateIdstring required

A unique identifier of a template.

clientTokenstring

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.

tagsobject

A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.

Response

Success

caseIdstring required

A unique identifier of the case.

caseArnstring required

The Amazon Resource Name (ARN) of the case.