POST
/
v1
/
form_fields
Creates a Form Field
curl --request POST \
  --url https://api.rootly.com/v1/form_fields \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '{
  "data": {
    "type": "form_fields",
    "attributes": {
      "kind": "custom",
      "input_kind": "text",
      "value_kind": "inherit",
      "value_kind_catalog_id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "shown": [
        "<string>"
      ],
      "required": [
        "<string>"
      ],
      "show_on_incident_details": true,
      "enabled": true,
      "default_values": [
        "<string>"
      ]
    }
  }
}'
{
  "data": {
    "id": "326f05d3-ba09-4a6c-b8c4-9fd3e33ed591",
    "type": "form_fields",
    "attributes": {
      "team_id": 125,
      "slug": "test-custom-field",
      "kind": "custom",
      "input_kind": "text",
      "value_kind": "inherit",
      "value_kind_catalog_id": null,
      "name": "Test custom field",
      "description": null,
      "shown": [
        "web_new_incident_form"
      ],
      "required": [],
      "default_values": [],
      "show_on_incident_details": true,
      "enabled": true,
      "updated_at": "2025-08-21T23:42:51.019-07:00",
      "created_at": "2025-08-21T23:42:51.019-07:00"
    },
    "relationships": {
      "options": {
        "data": []
      },
      "positions": {
        "data": [
          {
            "id": "b81fa985-60dc-4779-9386-43e5d804dd9f",
            "type": "form_field_positions"
          }
        ]
      }
    }
  }
}

Authorizations

Authorization
string
header
required

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

Body

application/vnd.api+json

Response

201
application/vnd.api+json

form_field created

The response is of type object.