DAdatadog
Incidents

Update an incident user-defined role

Update an existing user-defined role for incidents.

patch/api/v2/incidents/config/user-defined-roles/{role_id}

Request

Path parameters

role_idstring uuid required
Example:00000000-0000-0000-0000-000000000002

The UUID of the incident user-defined role.

Query parameters

includestring
Example:created_by_user,last_modified_by_user,incident_type

Comma-separated list of related resources to include in the response.

Request body

Example request

{
  "data": {
    "attributes": {
      "description": "The technical lead for the incident.",
      "name": "Tech Lead",
      "policy": {
        "is_single": true
      }
    },
    "id": "00000000-0000-0000-0000-000000000002",
    "type": "incident_user_defined_roles"
  }
}

Response

OK

Example response

{
  "data": {
    "attributes": {
      "created": "2024-01-01T00:00:00.000Z",
      "description": "The technical lead for the incident.",
      "modified": "2024-01-01T00:00:00.000Z",
      "name": "Tech Lead",
      "policy": {
        "is_single": true
      }
    },
    "id": "00000000-0000-0000-0000-000000000002",
    "relationships": {
      "created_by_user": {
        "data": {
          "id": "00000000-0000-0000-2345-000000000000",
          "type": "users"
        }
      },
      "incident_type": {
        "data": {
          "id": "00000000-0000-0000-0000-000000000001",
          "type": "incident_types"
        }
      },
      "last_modified_by_user": {
        "data": {
          "id": "00000000-0000-0000-2345-000000000000",
          "type": "users"
        }
      }
    },
    "type": "incident_user_defined_roles"
  },
  "included": [
    {
      "type": "users"
    }
  ]
}

Changes

Changes to this operation have not been checked yet.