Skip to main content
POST
/
v1
/
catalogs
/
{catalog_id}
/
fields
Creates a Catalog Field
curl --request POST \
  --url https://api.rootly.com/v1/catalogs/{catalog_id}/fields \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '
{
  "data": {
    "type": "catalog_fields",
    "attributes": {
      "name": "<string>",
      "kind": "text",
      "kind_catalog_id": "<string>",
      "multiple": true,
      "position": 123
    }
  }
}
'
{
  "data": {
    "id": "86f3dcb0-a982-4fca-a38e-43b0b58b1bc1",
    "type": "catalog_fields",
    "attributes": {
      "catalog_id": "7cd25a07-d4a0-478a-8a2c-97a2fa45355f",
      "name": "Test Attribute",
      "slug": "test-attribute",
      "kind": "reference",
      "kind_catalog_id": null,
      "multiple": false,
      "position": 2,
      "deleted_at": null,
      "updated_at": "2026-01-21T13:40:14.224-08:00",
      "created_at": "2026-01-21T13:40:14.224-08:00",
      "required": true
    },
    "relationships": {
      "catalog": {
        "data": {
          "type": "catalogs",
          "id": "7cd25a07-d4a0-478a-8a2c-97a2fa45355f"
        }
      }
    }
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
catalog_id
string
required

Body

application/vnd.api+json

A catalog can have a maximum of 50 fields.

​
data
object
required

Response

catalog_field created with required attribute

​
data
object
required