Skip to main content
PUT
Update
🔑 Requires the organisation_settings.update scope.

Authorizations

Authorization
string
header
required

API key from your incident.io dashboard (Settings → API keys)

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:
fixed_filter
object
Example:
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