v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB

Case Management Attribute

Update custom attribute config

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

put/api/v2/cases/types/{case_type_id}/custom_attributes/{custom_attribute_id}

Path parameters

case_type_idstring required

The UUID of the case type.

custom_attribute_idstring required

Case Custom attribute's UUID

Request body

Example request

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

Response

Example response

{
  "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"
  }
}