Update a Custom Field for an Incident Type

Update a custom field for an incident type. Field Options can also be updated within the same call.

Custom Fields (CF) are a feature which will allow customers to extend Incidents with their own custom data, to provide additional context and support features such as customized filtering, search and analytics. Custom Fields can be applied to different incident types.

Scoped OAuth requires: custom_fields.write

Authorization

api_key

Authorization<token>

The API Key with format Token token=<API_KEY>

In: header

Path Parameters

type_id_or_name*string

The ID or name of the Incident Type.

field_id*string

The ID of the field.

Header Parameters

Accept*string

The Accept header is used as a versioning header.

Default"application/vnd.pagerduty+json;version=2"

Content-Type*"application/json"

Default"application/json"

Value in

"application/json"

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

field*

Details of the custom field to be updated.

Response Body

`application/json`

curl -X PUT "https://api.pagerduty.com/incidents/types/{type_id_or_name}/custom_fields/{field_id}" \  -H "Accept: application/vnd.pagerduty+json;version=2" \  -H "Content-Type: application/json" \  -H "Content-Type: application/json" \  -d '{    "field": {      "display_name": "Custom Field 1"    }  }'

{  "field": {    "enabled": true,    "id": "P123456",    "name": "custom_field_1",    "type": "field",    "self": "https://api.pagerduty.com/incidents/types/P567890/custom_fields/P123456",    "description": "The environment that the issue occurred in",    "field_type": "single_value_fixed",    "data_type": "string",    "updated_at": "2021-06-01T21:30:42Z",    "created_at": "2021-06-01T21:30:42Z",    "display_name": "Custom Field 1",    "default_value": null,    "incident_type": "P567890",    "summary": "custom_field_1",    "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"      }    ]  }}

Update a Custom Field for an Incident Type

Authorization

Path Parameters

Header Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`