Create a Field

Deprecated

Deprecated

This endpoint is deprecated and only works for fields on the Base Incident Type.
For more flexibility, we recommend using the Incident Types endpoint:
/incidents/types/{type_id_or_name}/custom_fields

Creates a new Custom Field on the Base Incident Type, along with the Field Options if provided.
An account may have up to 10 Fields.

Scoped OAuth requires: custom_fields.write

Authorization

api_key

Authorization<token>

The API Key with format Token token=<API_KEY>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

field*

Response Body

`application/json`

curl -X POST "https://api.pagerduty.com/incidents/custom_fields" \  -H "Content-Type: application/json" \  -d '{    "field": {      "data_type": "string",      "name": "environment",      "display_name": "Environment",      "description": "The environment that the issue occurred in",      "field_type": "single_value_fixed",      "default_value": "production",      "field_options": [        {          "data": {            "data_type": "string",            "value": "production"          }        },        {          "data": {            "data_type": "string",            "value": "staging"          }        }      ]    }  }'

{  "field": {    "id": "P5IYCNZ",    "type": "field",    "summary": "environment",    "self": "https://api.pagerduty.com/incidents/custom_fields/P5IYCNZ",    "data_type": "string",    "name": "environment",    "display_name": "Environment",    "field_type": "single_value_fixed",    "description": "The environment that the issue occurred in",    "created_at": "2021-06-01T21:30:42Z",    "updated_at": "2021-06-01T21:30:42Z",    "default_value": "staging",    "field_options": [      {        "id": "PT4KHEE",        "type": "field_option",        "data": {          "data_type": "string",          "value": "production"        },        "created_at": "2021-06-01T21:30:42Z",        "updated_at": "2021-06-01T21:30:42Z"      },      {        "id": "P5IYCNZ",        "type": "field_option",        "data": {          "data_type": "string",          "value": "staging"        },        "created_at": "2021-06-01T21:30:42Z",        "updated_at": "2021-06-01T21:30:42Z"      }    ]  }}

Create a Field

Deprecated

Authorization

Request Body

Response Body

201application/json

400application/json

403application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`