Skip to main content
PUT
/
v2
/
custom_fields
/
{id}
Update
curl --request PUT \
  --url https://api.incident.io/v2/custom_fields/{id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "Which team is impacted by this issue",
  "filter_by": {
    "catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0",
    "custom_field_id": "01H2FW182TAH0NHEVBY34SCAK0"
  },
  "group_by_catalog_attribute_id": "01FCNDV6P870EA6S7TK1DSYDG0",
  "helptext_catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0",
  "name": "Affected Team"
}
'
{
  "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",
    "filter_by": {
      "catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0",
      "custom_field_id": "01H2FW182TAH0NHEVBY34SCAK0"
    },
    "group_by_catalog_attribute_id": "01FCNDV6P870EA6S7TK1DSYDG0",
    "helptext_catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0",
    "id": "01FCNDV6P870EA6S7TK1DSYDG0",
    "name": "Affected Team",
    "updated_at": "2021-08-17T13:28:57.801578Z"
  }
}

Path Parameters

​
id
string
required

Unique identifier for the custom field

Example:

"01FCNDV6P870EA6S7TK1DSYDG0"

Body

application/json
​
description
string
required

Description of the custom field

Example:

"Which team is impacted by this issue"

​
name
string
required

Human readable name for the custom field

Maximum string length: 50
Example:

"Affected Team"

​
filter_by
object
Example:
{
  "catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0",
  "custom_field_id": "01H2FW182TAH0NHEVBY34SCAK0"
}
​
group_by_catalog_attribute_id
string

For catalog fields, the ID of the attribute used to group catalog entries (if applicable)

Example:

"01FCNDV6P870EA6S7TK1DSYDG0"

​
helptext_catalog_attribute_id
string

Which catalog attribute provides helptext for the options

Example:

"01H2FW182TAH0NHEVBY34SCAK0"

Response

200 - application/json

OK response.

​
custom_field
object
required
Example:
{
  "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0",
  "created_at": "2021-08-17T13:28:57.801578Z",
  "description": "Which team is impacted by this issue",
  "field_type": "single_select",
  "filter_by": {
    "catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0",
    "custom_field_id": "01H2FW182TAH0NHEVBY34SCAK0"
  },
  "group_by_catalog_attribute_id": "01FCNDV6P870EA6S7TK1DSYDG0",
  "helptext_catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0",
  "id": "01FCNDV6P870EA6S7TK1DSYDG0",
  "name": "Affected Team",
  "updated_at": "2021-08-17T13:28:57.801578Z"
}