Entries
Entries in Type CMS are instances of content types, representing actual content pieces based on defined templates. Each entry adheres to the structure set by its content type and can include various elements like text, images, and other assets. Entries can be created, edited, and managed within the CMS, allowing for consistent and organized content management. They support version control, workflows, and can be published or unpublished as needed, ensuring that content remains accurate and up-to-date across all platforms. Another way to think of entries is webpages or articles. Entries store your content and can any format you define in your templates.
/api/projects/:projectId/entries
Required attributes
| projectId | string | Your projectId |
Optional attributes
| None |
Request
Response
Fetches a single entry based on the provided entry ID. Note, this endpoint should not be used to fetch content for your application, it is specific to managing and editing entries within the entry editor. For fetching content for use in your applications, see the Content API documentation.
Required attributes
| projectId | string | Your projectId |
| entryId | string | The ID for the entry to fetch |
Optional attributes
| None |
Request
Response
Creates an entry based on a specified template
Required attributes
| projectId | string | Your project ID |
| templateId | string | The ID of the template to use for the entry |
Optional attributes
| None |
Request
Response
Updates attributes of an entry
Required attributes
| projectId | string | Your project ID |
| entryId | string | The ID of the entry being updated |
Optional attributes
| title | string | The title of the entry |
| description | string | The description of the entry |
Request
Response
Updates the schema for an entry with the provided entry ID. This method is used to manage fields where the number of items varies (when multiple is set to true on a field).
Required attributes
| projectId | string | Your project ID |
| entryId | string | The ID of the entry being updated |
| id | string | The ID of the field being updated |
| parentTypeRefId | string | The ID associated with the field in the template |
| updateType | string | Must be "schema" |
| version | string | The version number to fork the update from. Use "latest" to update from latest version. |
Optional attributes
| type | string | Field type |
| groupId | string | The ID of the group the field belongs to |
| action | string | Must be "add" or "delete" |
Request
Response
Updates the value for an entry with the provided entry ID. This method is used to manage individual field values. Note that the body of this requests requires an array as it accepts multiple field updates at once. In the dashboard, these updates are stored in a local queue and pushed in a bulk operation using the method in the code example.
Required attributes
| projectId | string | Your project ID |
| entryId | string | The ID of the entry being updated |
| language | string | ISO 639 language code ("EN-US", "ES", "DE", etc.) |
| updateType | string | Must be "values" |
| items | object[] | An array of items to update |
| items[].id | string | The field ID to update |
| items[].value | string | The value of the field to set |
| version | string | The version number to fork the update from. Use "latest" to update from latest version. |
Optional attributes
| None |
Request
Response
Deletes an entry. This also un-publishes the entry from all environments.
Required attributes
| projectId | string | Your project ID |
| entryId | string | The ID of the entry being updated |
Optional attributes
| None |
Request
Response
Fetches all versions for an entry based on the provided entry ID
Required attributes
| projectId | string | Your project ID |
| entryId | string | The ID of the entry being updated |
Optional attributes
| None |
Request
Response
Publishes an entry based on the provided entry ID and version ID.
Required attributes
| projectId | string | Your project ID |
| entryId | string | The ID of the entry being updated |
| version | string | number | The version number to publish, or use "latest" |
| environments | string[] | An array of environment IDs to publish to |
Optional attributes
| None |
Request
Response
Unpublishes an entry based on the provided entry ID from the specified environment IDs.
Required attributes
| projectId | string | Your project ID |
| entryId | string | The ID of the entry being updated |
| environments | string[] | An array of environment IDs to publish to |
Optional attributes
| None |
Request
Response
Clones an entry based on the provided entry ID
Required attributes
| projectId | string | Your project ID |
| entryId | string | The ID of the entry being updated |
| version | string | number | The version number to publish, or use "latest" |
Optional attributes
| None |
Request
Response
Schedules an entry for publishing at a specified future date
Required attributes
| projectId | string | Your project ID |
| entryId | string | The ID of the entry being updated |
| eventType | string | "publish" | "unpublish" |
| entryVersion | string | number | The version number to publish, or use "latest" |
| scheduleAt | datetime | The datetime to publish the entry at |
| timezone | string | Timezone for the scheduled event |
| environments | string[] | An array of environment IDs to publish to |
Optional attributes
| None |
Request
Response
Schedules an entry for unpublishing at a specified future date
Required attributes
| projectId | string | Your project ID |
| entryId | string | The ID of the entry being updated |
| eventType | string | "publish" | "unpublish" |
| entryVersion | string | number | The version number to publish, or use "latest" |
| scheduleAt | datetime | The datetime to publish the entry at |
| timezone | string | Timezone for the scheduled event |
| environments | string[] | An array of environment IDs to publish to |
Optional attributes
| None |
Request
Response