DAdatadog
Incidents

Update an incident impact field

Update an impact field for incidents.

put/api/v2/incidents/config/impact-fields/{field_id}

Request

Path parameters

field_idstring uuid required

The UUID of the impact field.

Request body

Example request

{
  "data": {
    "attributes": {
      "display_name": "Customer Impact Scope",
      "field_choices": [
        {
          "description": "Affects all customers",
          "display_name": "Critical",
          "value": "critical"
        }
      ],
      "field_type": "dropdown",
      "name": "customer_impact_scope",
      "tag_key": "env"
    },
    "relationships": {
      "incident_type": {
        "data": {
          "id": "00000000-0000-0000-0000-000000000000",
          "type": "incident_types"
        }
      }
    },
    "type": "impact_fields"
  }
}

Response

OK

Example response

{
  "data": {
    "attributes": {
      "display_name": "Customer Impact Scope",
      "field_choices": [
        {
          "description": "Affects all customers",
          "display_name": "Critical",
          "value": "critical"
        }
      ],
      "field_type": "dropdown",
      "name": "customer_impact_scope",
      "tag_key": "env"
    },
    "id": "00000000-0000-0000-0000-000000000000",
    "relationships": {
      "created_by_user": {
        "data": {
          "id": "00000000-0000-0000-2345-000000000000",
          "type": "users"
        }
      },
      "incident_type": {
        "data": {
          "id": "00000000-0000-0000-0000-000000000000",
          "type": "incident_types"
        }
      },
      "last_modified_by_user": {
        "data": {
          "id": "00000000-0000-0000-2345-000000000000",
          "type": "users"
        }
      }
    },
    "type": "impact_fields"
  },
  "included": [
    {
      "type": "users"
    }
  ]
}

Changes

Changes to this operation have not been checked yet.