POST
/
v1
/
custom_fields
curl --request POST \
  --url https://api.rootly.com/v1/custom_fields \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '{
  "data": {
    "type": "custom_fields",
    "attributes": {
      "label": "<string>",
      "description": "<string>",
      "shown": [
        "incident_form"
      ],
      "required": [
        "incident_form"
      ],
      "default": "<string>",
      "position": 123
    }
  }
}'
{
  "data": {
    "id": "3",
    "type": "custom_fields",
    "attributes": {
      "slug": "test-custom-field",
      "description": null,
      "enabled": true,
      "position": 2,
      "updated_at": "2025-03-28T22:58:49.950-07:00",
      "created_at": "2025-03-28T22:58:49.950-07:00",
      "kind": "text",
      "label": "Test custom field",
      "shown": [
        "incident_form",
        "incident_slack_form"
      ],
      "required": []
    },
    "relationships": {
      "options": {
        "data": []
      }
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/vnd.api+json
​
data
object
required

Response

201
application/vnd.api+json
custom_field created
​
data
object
required

Was this page helpful?