---
title: "Create an incident impact field"
method: POST
path: "/api/v2/incidents/config/impact-fields"
tags: ["Incidents"]
---

# Create an incident impact field

`POST /api/v2/incidents/config/impact-fields`

## Request

- Base URL: `https://api.datadoghq.com`
- URL: `https://api.datadoghq.com/api/v2/incidents/config/impact-fields`
- Auth: one of:
  - API key in header `DD-API-KEY` and API key in header `DD-APPLICATION-KEY`
  - OAuth 2
    - Authorization code: `/oauth2/v1/authorize`
    - Token URL: `/oauth2/v1/token` scopes: `incident_settings_write`
- TypeScript: <https://skmtc.dev/datadog/apis/datadog-api-v2-collection/docs/api/v2/incidents/config/impact-fields/post.ts> (a function with typed inputs; its response is checked against the schema)

Create an impact field for incidents.

## Request body

- IncidentImpactFieldRequest: Request payload for creating an impact field.
  - `data` IncidentImpactFieldDataRequest, required: Impact field data in a create request.
    - `attributes` IncidentImpactFieldDataAttributesRequest, required: Attributes for creating an impact field.
      - `display_name` string, required: The display name of the impact field.
      - `field_choices` IncidentImpactFieldChoice[]: The choices for dropdown or multiselect fields.
        - `description` string: The description of the choice.
        - `display_name` string, required: The display name of the choice.
        - `value` string, required: The value of the choice.
      - `field_type` 'dropdown' | 'text' | 'textarray' | 'metrictag' | 'number' | 'datetime' | 'multiselect', required: The type of an impact field.
      - `name` string, required: The normalized name of the impact field (used as identifier).
      - `tag_key` string, nullable: The tag key associated with the field (for metrictag type).
    - `relationships` IncidentImpactFieldRelationshipsRequest, required: Relationships for an impact field create request.
      - `incident_type` RelationshipToIncidentType, required: Relationship to an incident type.
        - `data` RelationshipToIncidentTypeData, required: Relationship to incident type object.
          - `id` string, required: The incident type's ID.
          - `type` 'incident_types', required: Incident type resource type.
    - `type` 'impact_fields', required: Impact field resource type.

## Response `201`

Created

- IncidentImpactFieldResponse: Response with a single impact field.
  - `data` IncidentImpactFieldDataResponse, required: Impact field data in a response.
    - `attributes` IncidentImpactFieldDataAttributesResponse, required: Attributes of an impact field in a response.
      - `display_name` string, required: The display name of the impact field.
      - `field_choices` IncidentImpactFieldChoice[]: The choices for dropdown or multiselect fields.
        - `description` string: The description of the choice.
        - `display_name` string, required: The display name of the choice.
        - `value` string, required: The value of the choice.
      - `field_type` 'dropdown' | 'text' | 'textarray' | 'metrictag' | 'number' | 'datetime' | 'multiselect', required: The type of an impact field.
      - `name` string, required: The normalized name of the impact field.
      - `tag_key` string, nullable: The tag key associated with the field.
    - `id` string, uuid, required: The impact field identifier.
    - `relationships` IncidentImpactFieldRelationships: Relationships for an impact field.
      - `created_by_user` RelationshipToUser: Relationship to user.
        - `data` RelationshipToUserData, required: Relationship to user object.
          - `id` string, required: A unique identifier that represents the user.
          - `type` 'users', required: Users resource type.
      - `incident_type` RelationshipToIncidentType: Relationship to an incident type.
        - `data` RelationshipToIncidentTypeData, required: Relationship to incident type object.
          - `id` string, required: The incident type's ID.
          - `type` 'incident_types', required: Incident type resource type.
      - `last_modified_by_user` RelationshipToUser: Relationship to user.
        - `data` RelationshipToUserData, required: Relationship to user object.
          - `id` string, required: A unique identifier that represents the user.
          - `type` 'users', required: Users resource type.
    - `type` 'impact_fields', required: Impact field resource type.
  - `included` IncidentUserData[]: Included related resources.
    - `attributes` IncidentUserAttributes: Attributes of user object returned by the API.
      - `email` string: Email of the user.
      - `handle` string: Handle of the user.
      - `icon` string: URL of the user's icon.
      - `name` string, nullable: Name of the user.
      - `uuid` string: UUID of the user.
    - `id` string: ID of the user.
    - `type` 'users': Users resource type.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `429`: Too many requests

---

[API](https://skmtc.dev/datadog/apis/datadog-api-v2-collection.md) - [All operations](https://skmtc.dev/datadog/apis/datadog-api-v2-collection/llms.txt) - [OpenAPI document](https://skmtc.dev/datadog/apis/datadog-api-v2-collection/revisions/3f70db624329?raw)
