Skip to content

Create Case

connectcases_create_case R Documentation

If you provide a value for PerformedBy

Description

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

Usage

connectcases_create_case(domainId, templateId, fields, clientToken,
  performedBy, tags)

Arguments

domainId

[required] The unique identifier of the Cases domain.
templateId

[required] A unique identifier of a template.
fields

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

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 Making retries safe with idempotent APIs.
performedBy

Represents the entity that performed the action.
tags

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.

Value

A list with the following syntax:

list(
  caseId = "string",
  caseArn = "string"
)

Request syntax

svc$create_case(
  domainId = "string",
  templateId = "string",
  fields = list(
    list(
      id = "string",
      value = list(
        stringValue = "string",
        doubleValue = 123.0,
        booleanValue = TRUE|FALSE,
        emptyValue = list(),
        userArnValue = "string"
      )
    )
  ),
  clientToken = "string",
  performedBy = list(
    userArn = "string",
    customEntity = "string"
  ),
  tags = list(
    "string"
  )
)