Skip to main content
POST
Create
🔑 Requires the organisation_settings.update scope.

Authorizations

Authorization
string
header
required

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

Body

application/json
description
string
required

Description of the custom field

Example:

"Which team is impacted by this issue"

field_type
enum<string>
required

Type of custom field

Available options:
single_select,
multi_select,
text,
link,
numeric
Example:

"single_select"

name
string
required

Human readable name for the custom field

Maximum string length: 50
Example:

"Affected Team"

catalog_type_id
string

For catalog fields, the ID of the associated catalog type

Example:

"01FCNDV6P870EA6S7TK1DSYDG0"

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

201 - application/json

Created response.

custom_field
object
required