Language

English Français 日本語 한국어 Español

Datadog Site

Site help
US1 US3 US5 EU AP1 AP2 US1-FED US2-FED

Update custom attribute config

Note: This endpoint is in preview and is subject to change. If you have any feedback, contact Datadog support.

PUT https://api.ap1.datadoghq.com/api/v2/cases/types/{case_type_id}/custom_attributes/{custom_attribute_id}https://api.ap2.datadoghq.com/api/v2/cases/types/{case_type_id}/custom_attributes/{custom_attribute_id}https://api.datadoghq.eu/api/v2/cases/types/{case_type_id}/custom_attributes/{custom_attribute_id}https://api.ddog-gov.com/api/v2/cases/types/{case_type_id}/custom_attributes/{custom_attribute_id}https://api.us2.ddog-gov.com/api/v2/cases/types/{case_type_id}/custom_attributes/{custom_attribute_id}https://api.datadoghq.com/api/v2/cases/types/{case_type_id}/custom_attributes/{custom_attribute_id}https://api.us3.datadoghq.com/api/v2/cases/types/{case_type_id}/custom_attributes/{custom_attribute_id}https://api.us5.datadoghq.com/api/v2/cases/types/{case_type_id}/custom_attributes/{custom_attribute_id}

Overview

Updates the display name, description, type, or options of an existing custom attribute configuration for a case type.

OAuth apps require the cases_shared_settings_write authorization scope to access this endpoint.

Arguments

Path Parameters

Name

Type

Description

case_type_id [required]

string

The UUID of the case type.

custom_attribute_id [required]

string

Case Custom attribute’s UUID

Request

Body Data (required)

Custom attribute config payload.

Expand All

Field

Type

Description

data [required]

object

Data object for updating a custom attribute configuration.

attributes

object

Attributes that can be updated on a custom attribute configuration. All fields are optional; only provided fields are changed.

description

string

A description explaining the purpose and expected values for this custom attribute.

display_name

string

The human-readable label shown in the Case Management UI for this custom attribute.

map_from

string

An external field identifier to auto-populate this attribute from (used for integrations with external systems).

type

enum

The data type of the custom attribute, which determines the allowed values and UI input control. Allowed enum values: URL,TEXT,NUMBER,SELECT

type_data

object

Type-specific configuration for the custom attribute. For SELECT-type attributes, this contains the list of allowed options.

options

[object]

Options for SELECT type custom attributes.

value [required]

string

Option value.

type [required]

enum

JSON:API resource type for custom attribute configurations. Allowed enum values: custom_attribute

default: custom_attribute

{
  "data": {
    "attributes": {
      "description": "Updated description.",
      "display_name": "AWS Region",
      "map_from": "string",
      "type": "NUMBER",
      "type_data": {
        "options": [
          {
            "value": "us-east-1"
          }
        ]
      }
    },
    "type": "custom_attribute"
  }
}

Response

OK

Response containing a single custom attribute configuration.

Expand All

Field

Type

Description

data

object

A custom attribute configuration that defines an organization-specific metadata field on cases. Custom attributes are scoped to a case type and can hold text, URLs, numbers, or predefined select options.

attributes

object

Attributes of a custom attribute configuration, defining an organization-specific metadata field that can be added to cases of a given type.

case_type_id [required]

string

The UUID of the case type this custom attribute belongs to.

description

string

A description explaining the purpose and expected values for this custom attribute.

display_name [required]

string

The human-readable label shown in the Case Management UI for this custom attribute.

is_multi [required]

boolean

If true, this attribute accepts an array of values. If false, only a single value is allowed.

key [required]

string

The programmatic key used to reference this custom attribute in search queries and API calls.

type [required]

enum

The data type of the custom attribute, which determines the allowed values and UI input control. Allowed enum values: URL,TEXT,NUMBER,SELECT

id

string

Custom attribute configs identifier

type

enum

JSON:API resource type for custom attribute configurations. Allowed enum values: custom_attribute

default: custom_attribute

{
  "data": {
    "attributes": {
      "case_type_id": "aeadc05e-98a8-11ec-ac2c-da7ad0900001",
      "description": "AWS Region, must be a valid region supported by AWS",
      "display_name": "AWS Region",
      "is_multi": true,
      "key": "aws_region",
      "type": "NUMBER"
    },
    "id": "aeadc05e-98a8-11ec-ac2c-da7ad0900001",
    "type": "custom_attribute"
  }
}

Bad Request

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Unauthorized

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Forbidden

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Not Found

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Too many requests

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Code Example

                  ## default
# 

# Path parameters
export case_type_id="f98a5a5b-e0ff-45d4-b2f5-afe6e74de505"
export custom_attribute_id="f98a5a5b-e0ff-45d4-b2f5-afe6e74de505"
# Curl command
curl -X PUT "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.us2.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/cases/types/${case_type_id}/custom_attributes/${custom_attribute_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "description": "Updated description.",
      "display_name": "AWS Region"
    },
    "type": "custom_attribute"
  }
}
EOF