Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors Examples See Also

CreateCase

Note

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.

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

Request Syntax


POST /domains/domainId/cases HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "fields": [ 
      { 
         "id": "string",
         "value": { ... }
      }
   ],
   "performedBy": { ... },
   "templateId": "string"
}

URI Request Parameters

The request uses the following URI parameters.

domainId

The unique identifier of the Cases domain.

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

Required: Yes

Request Body

The request accepts the following data in JSON format.

clientToken

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

Type: String

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

Required: No

fields

An array of objects with field ID (matching ListFields/DescribeField) and value union data.

Type: Array of FieldValue objects

Array Members: Minimum number of 0 items. Maximum number of 100 items.

Required: Yes

performedBy

Represents the identity of the person who performed the action.

Type: UserUnion object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: No

templateId

A unique identifier of a template.

Type: String

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

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "caseArn": "string",
   "caseId": "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.

caseArn

The Amazon Resource Name (ARN) of the case.

Type: String

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

caseId

A unique identifier of the case.

Type: String

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

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

ConflictException

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.

HTTP Status Code: 409

InternalServerException

We couldn't process your request because of an issue with the server. Try again later.

HTTP Status Code: 500

ResourceNotFoundException

We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.

HTTP Status Code: 404

ThrottlingException

The rate has been exceeded for this API. Please try again after a few minutes.

HTTP Status Code: 429

ValidationException

The request isn't valid. Check the syntax and try again.

HTTP Status Code: 400

Examples

Request and Response example

This example illustrates one usage of CreateCase.


{
  "templateId": "[template_id]",
  "fields": [
  {
    "id": "customer_id",
    "value": {
      "stringValue": "[customer_id]"
     },
    {
    "id": "title",
    "value": {
      "stringValue": "Incorrect Shipping Address"
      }
    }
  ],
  "clientToken": "[clientToken]"
}


{
  "caseArn": "arn:aws:cases:us-west-2:[account_id]:domain/[domain_id]/case/[case_id]",
  "caseId": "[case_id]",
}