Language

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

Datadog Site

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

Update a case type

copy Copy pageCopied

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}https://api.ap2.datadoghq.com/api/v2/cases/types/{case_type_id}https://api.datadoghq.eu/api/v2/cases/types/{case_type_id}https://api.ddog-gov.com/api/v2/cases/types/{case_type_id}https://api.us2.ddog-gov.com/api/v2/cases/types/{case_type_id}https://api.datadoghq.com/api/v2/cases/types/{case_type_id}https://api.us3.datadoghq.com/api/v2/cases/types/{case_type_id}https://api.us5.datadoghq.com/api/v2/cases/types/{case_type_id}

Overview

Updates the name, emoji, or description of an existing 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.

Request

Body Data (required)

Case type payload.

Expand All

Field

Type

Description

data [required]

object

Data object for updating a case type.

attributes

object

Attributes of a case type, which define a classification category for cases. Organizations use case types to model different workflows (for example, Security Incident, Bug Report, Change Request).

deleted_at

date-time

Timestamp when the case type was marked as deleted. A null value indicates the case type is active.

description

string

A detailed description explaining when this case type should be used.

emoji

string

An emoji icon representing the case type in the UI.

name [required]

string

The display name of the case type, shown in the Case Management UI when creating or viewing cases.

type [required]

enum

JSON:API resource type for case types. Allowed enum values: case_type

default: case_type

{
  "data": {
    "attributes": {
      "description": "Investigations done in case management",
      "emoji": "🕵🏻‍♂️",
      "name": "Investigation"
    },
    "type": "case_type"
  }
}

Response

OK

Response containing a single case type.

Expand All

Field

Type

Description

data

object

A case type that defines a classification category for cases. Each case type can have its own custom attributes, statuses, and automation rules.

attributes

object

Attributes of a case type, which define a classification category for cases. Organizations use case types to model different workflows (for example, Security Incident, Bug Report, Change Request).

deleted_at

date-time

Timestamp when the case type was marked as deleted. A null value indicates the case type is active.

description

string

A detailed description explaining when this case type should be used.

emoji

string

An emoji icon representing the case type in the UI.

name [required]

string

The display name of the case type, shown in the Case Management UI when creating or viewing cases.

id

string

Case type's identifier

type

enum

JSON:API resource type for case types. Allowed enum values: case_type

default: case_type

{
  "data": {
    "attributes": {
      "deleted_at": "2019-09-19T10:00:00.000Z",
      "description": "Investigations done in case management",
      "emoji": "🕵🏻‍♂️",
      "name": "Investigation"
    },
    "id": "aeadc05e-98a8-11ec-ac2c-da7ad0900001",
    "type": "case_type"
  }
}

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"
# 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}" \
-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": "Investigations done in case management",
      "emoji": "🕵🏻‍♂️",
      "name": "Investigation"
    },
    "type": "case_type"
  }
}
EOF