Sign in
latestSwagger 2.02026-08-102194011.3 MB

602fc25ddd76

Custom Fields V1

Update Custom Fields V1

Update the details of a custom field

put/v1/custom_fields/{id}

Path parameters

idstring required

Unique identifier for the custom field

Request body

descriptionstring required

Description of the custom field

namestring required

Human readable name for the custom field

required'never' | 'before_closure' | 'always'

When this custom field must be set during the incident lifecycle. [DEPRECATED: please use required_v2 instead].

required_v2'never' | 'before_resolution' | 'always'

When this custom field must be set during the incident lifecycle.

show_before_closureboolean required

Whether a custom field should be shown in the incident resolve modal. If this custom field is required before resolution, but no value has been set for it, the field will be shown in the resolve modal whatever the value of this setting.

show_before_creationboolean required

Whether a custom field should be shown in the incident creation modal. This must be true if the field is always required.

show_before_updateboolean required

Whether a custom field should be shown in the incident update modal.

show_in_announcement_postboolean

Whether a custom field should be shown in the list of fields as part of the announcement post when set.

Example request

{
  "description": "Which team is impacted by this issue",
  "name": "Affected Team",
  "required": "never",
  "required_v2": "never",
  "show_before_closure": true,
  "show_before_creation": true,
  "show_before_update": true,
  "show_in_announcement_post": true
}

Response

OK response.

Example response

{
  "custom_field": {
    "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0",
    "created_at": "2021-08-17T13:28:57.801578Z",
    "description": "Which team is impacted by this issue",
    "field_type": "single_select",
    "id": "01FCNDV6P870EA6S7TK1DSYDG0",
    "name": "Affected Team",
    "options": [
      {
        "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0",
        "id": "01FCNDV6P870EA6S7TK1DSYDG0",
        "sort_key": 10,
        "value": "Product"
      }
    ],
    "required": "never",
    "required_v2": "never",
    "show_before_closure": true,
    "show_before_creation": true,
    "show_before_update": true,
    "show_in_announcement_post": true,
    "updated_at": "2021-08-17T13:28:57.801578Z"
  }
}