Skip to main content
PATCH
/
publisher
/
{publisher_id}
/
entities
/
content-type
/
custom-component
/
{custom_entity_schema_id}
Update Custom Component
curl --request PATCH \
  --url https://cms.thepublive.com/publisher/{publisher_id}/entities/content-type/custom-component/{custom_entity_schema_id}/ \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "meta_data": {},
  "field_types": [
    {}
  ],
  "settings": {}
}
'
{
  "status": "success",
  "message": "Updated Successfully",
  "data": {
    "id": "abc123",
    "name": "section 1",
    "meta_data": {
      "description": "A reusable hero section component with title"
    },
    "field_types": [
      {
        "name": "age",
        "type": "integer",
        "meta_data": {
          "type": { "value": "input" },
          "label": { "value": "Age" },
          "placeholder": { "value": "" },
          "default": { "value": null },
          "tooltip": { "value": "" }
        },
        "validations": {
          "required": true,
          "group_editable": true
        }
      }
    ],
    "settings": {}
  }
}
Updates an existing custom component schema. Only send the fields you want to change (partial update).
​
publisher_id
string
required
Your Publisher ID
​
custom_entity_schema_id
string
required
Custom component schema ID
​
name
string
Display name for the component
​
meta_data
object
Additional metadata for the component.
KeyTypeDescription
descriptionstringHuman-readable description of the component
​
field_types
array
Replaces the field definitions for the schema. Each object supports:
KeyTypeRequiredDescription
namestringYesField identifier
typestringYesField type: short_text, long_text, integer, boolean, media, etc.
meta_dataobjectNoUI metadata — label, tooltip, type, placeholder, default (each wrapped as {"value": ...})
validationsobjectNoValidation rules — required, max_length, group_editable
group_idstringNoField group assignment
​
settings
object
Component-level settings.

​
Example Request

curl -X PATCH \
  'https://cms.thepublive.com/publisher/123/entities/content-type/custom-component/abc123/' \
  -H 'Authorization: Basic <BASE64_AUTH_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "section 1",
    "field_types": [
      {
        "name": "age",
        "type": "integer",
        "meta_data": {
          "type": { "value": "input" },
          "label": { "value": "Age" },
          "placeholder": { "value": "" },
          "default": { "value": null },
          "tooltip": { "value": "" }
        },
        "validations": {
          "required": true,
          "group_editable": true
        }
      }
    ]
  }'

{
  "status": "success",
  "message": "Updated Successfully",
  "data": {
    "id": "abc123",
    "name": "section 1",
    "meta_data": {
      "description": "A reusable hero section component with title"
    },
    "field_types": [
      {
        "name": "age",
        "type": "integer",
        "meta_data": {
          "type": { "value": "input" },
          "label": { "value": "Age" },
          "placeholder": { "value": "" },
          "default": { "value": null },
          "tooltip": { "value": "" }
        },
        "validations": {
          "required": true,
          "group_editable": true
        }
      }
    ],
    "settings": {}
  }
}
Last modified on April 23, 2026