--- title: Update an incident impact field description: Update an impact field for incidents. breadcrumbs: Docs > API > Update an incident impact field --- > For the complete documentation index, see [llms.txt](https://dnd37xeb23o8n.cloudfront.net/stefon.simmons/docs-astro-web-10435/llms.txt). # Update an incident impact field ## v2 (latest) {% alert level="warning" %} **Note**: This endpoint is in preview and is subject to change. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help.md). {% /alert %} | Datadog site | API endpoint | | ----------------- | ---------------------------------------------------------------------------------- | | app.datadoghq.com | PUT https://api.datadoghq.com/api/v2/incidents/config/impact-fields/{field_id} | | us3.datadoghq.com | PUT https://api.us3.datadoghq.com/api/v2/incidents/config/impact-fields/{field_id} | | us5.datadoghq.com | PUT https://api.us5.datadoghq.com/api/v2/incidents/config/impact-fields/{field_id} | | app.datadoghq.eu | PUT https://api.datadoghq.eu/api/v2/incidents/config/impact-fields/{field_id} | | ap1.datadoghq.com | PUT https://api.ap1.datadoghq.com/api/v2/incidents/config/impact-fields/{field_id} | | ap2.datadoghq.com | PUT https://api.ap2.datadoghq.com/api/v2/incidents/config/impact-fields/{field_id} | | uk1.datadoghq.com | PUT https://api.uk1.datadoghq.com/api/v2/incidents/config/impact-fields/{field_id} | | app.ddog-gov.com | PUT https://api.ddog-gov.com/api/v2/incidents/config/impact-fields/{field_id} | | us2.ddog-gov.com | PUT https://api.us2.ddog-gov.com/api/v2/incidents/config/impact-fields/{field_id} | ### Overview Update an impact field for incidents. This endpoint requires the `incident_settings_write` permission. OAuth apps require the `incident_settings_write` authorization [scope](https://dnd37xeb23o8n.cloudfront.net/stefon.simmons/docs-astro-web-10435/api/latest/scopes.md#incidents) to access this endpoint. ### Arguments #### Path Parameters | Field | Type | Description | | --------------------- | ------ | ----------------------------- | | field_id [*required*] | string | The UUID of the impact field. | ### Request #### Body Data (required) Impact field update payload. {% tabs %} {% tab label="Model" %} | Parent field | Field | Type | Description | | ------------- | -------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------ | | | data [*required*] | object | Impact field data in a create request. | | data | attributes [*required*] | object | Attributes for creating an impact field. | | attributes | display_name [*required*] | string | The display name of the impact field. | | attributes | field_choices | [object] | The choices for dropdown or multiselect fields. | | field_choices | description | string | The description of the choice. | | field_choices | display_name [*required*] | string | The display name of the choice. | | field_choices | value [*required*] | string | The value of the choice. | | attributes | field_type [*required*] | enum | The type of an impact field. Allowed enum values: `dropdown`, `text`, `textarray`, `metrictag`, `number`, `datetime`, `multiselect`. | | attributes | name [*required*] | string | The normalized name of the impact field (used as identifier). | | attributes | tag_key | string | The tag key associated with the field (for metrictag type). | | data | relationships [*required*] | object | Relationships for an impact field create request. | | relationships | incident_type [*required*] | object | Relationship to an incident type. | | incident_type | data [*required*] | object | Relationship to incident type object. | | data | id [*required*] | string | The incident type's ID. | | data | type [*required*] | enum | Incident type resource type. Allowed enum values: `incident_types`. Default: `incident_types`. | | data | type [*required*] | enum | Impact field resource type. Allowed enum values: `impact_fields`. | {% /tab %} {% tab label="Example" %} ```json { "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" } } ``` {% /tab %} {% /tabs %} ### Response {% tabs %} {% tab label="200" %} OK {% tabs %} {% tab label="Model" %} Response with a single impact field. | Parent field | Field | Type | Description | | --------------------- | ------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------ | | | data [*required*] | object | Impact field data in a response. | | data | attributes [*required*] | object | Attributes of an impact field in a response. | | attributes | display_name [*required*] | string | The display name of the impact field. | | attributes | field_choices | [object] | The choices for dropdown or multiselect fields. | | field_choices | description | string | The description of the choice. | | field_choices | display_name [*required*] | string | The display name of the choice. | | field_choices | value [*required*] | string | The value of the choice. | | attributes | field_type [*required*] | enum | The type of an impact field. Allowed enum values: `dropdown`, `text`, `textarray`, `metrictag`, `number`, `datetime`, `multiselect`. | | attributes | name [*required*] | string | The normalized name of the impact field. | | attributes | tag_key | string | The tag key associated with the field. | | data | id [*required*] | uuid | The impact field identifier. | | data | relationships | object | Relationships for an impact field. | | relationships | created_by_user | object | Relationship to user. | | created_by_user | data [*required*] | object | Relationship to user object. | | data | id [*required*] | string | A unique identifier that represents the user. | | data | type [*required*] | enum | Users resource type. Allowed enum values: `users`. Default: `users`. | | relationships | incident_type | object | Relationship to an incident type. | | incident_type | data [*required*] | object | Relationship to incident type object. | | data | id [*required*] | string | The incident type's ID. | | data | type [*required*] | enum | Incident type resource type. Allowed enum values: `incident_types`. Default: `incident_types`. | | relationships | last_modified_by_user | object | Relationship to user. | | last_modified_by_user | data [*required*] | object | Relationship to user object. | | data | id [*required*] | string | A unique identifier that represents the user. | | data | type [*required*] | enum | Users resource type. Allowed enum values: `users`. Default: `users`. | | data | type [*required*] | enum | Impact field resource type. Allowed enum values: `impact_fields`. | | | included | [object] | Included related resources. Read-only. | | included | attributes | object | Attributes of user object returned by the API. | | attributes | email | string | Email of the user. | | attributes | handle | string | Handle of the user. | | attributes | icon | string | URL of the user's icon. | | attributes | name | string | Name of the user. | | attributes | uuid | string | UUID of the user. | | included | id | string | ID of the user. | | included | type | enum | Users resource type. Allowed enum values: `users`. Default: `users`. | {% /tab %} {% tab label="Example" %} ```json { "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": [ { "attributes": { "email": "string", "handle": "string", "icon": "string", "name": "string", "uuid": "string" }, "id": "string", "type": "users" } ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="400" %} Bad Request {% tabs %} {% tab label="Model" %} API error response. | Field | Type | Description | | ------------------- | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="401" %} Unauthorized {% tabs %} {% tab label="Model" %} API error response. | Field | Type | Description | | ------------------- | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="403" %} Forbidden {% tabs %} {% tab label="Model" %} API error response. | Field | Type | Description | | ------------------- | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="404" %} Not Found {% tabs %} {% tab label="Model" %} API error response. | Field | Type | Description | | ------------------- | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="429" %} Too many requests {% tabs %} {% tab label="Model" %} API error response. | Field | Type | Description | | ------------------- | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% /tabs %} ### Code Example {% tabs %} {% tab label="Curl" %} ```bash # Path parameters export field_id="CHANGE_ME" # Set your Datadog site and credentials export DD_SITE="datadoghq.com" # Or us3.datadoghq.com, us5.datadoghq.com, datadoghq.eu, ap1.datadoghq.com, ap2.datadoghq.com, uk1.datadoghq.com, ddog-gov.com, us2.ddog-gov.com # Use a Personal Access Token or Service Access Token export DD_BEARER_TOKEN="" curl -X PUT "https://api.${DD_SITE}/api/v2/incidents/config/impact-fields/${field_id}" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer ${DD_BEARER_TOKEN}" \ -d @- << EOF { "data": { "attributes": { "display_name": "Customer Impact Scope Updated", "field_type": "dropdown", "name": "customer_impact_scope" }, "relationships": { "incident_type": { "data": { "id": "00000000-0000-0000-0000-000000000000", "type": "incident_types" } } }, "type": "impact_fields" } } EOF ``` {% /tab %} {% /tabs %}