Content Management API

Timeline entries

Currently supported actions:

  • Query release entry versions
  • Fetch release entry version
  • Update release entry version

Entries collection

Get all entries of a release

To fetch specific entries like e.g. entries of a particular content type use query search parameters.

Create an entry

Use this endpoint to create a new entry and add it to the release in one step.

Entry

Update an entry

Use this endpoint to update a specific entry via its ID. When updating an existing entry, you need to specify the last version of the entry you are updating with X-Contentful-Version.

You do not need to pass the ID of the entry’s content type.

Patch an entry

Use this endpoint to update a specific entry via its ID using JSON Patch format. When patching an entry, you need to specify the current version of the entry you are updating with X-Contentful-Version.

JSON Patch cannot perform operations on non-existing fields. If the field is defined on the Content Type but has not been set on the Entry yet, the API will return a validation error when you try to perform an operation on this field. The accepted workaround is to pass the entire sub-object to the top-most existing field, including locale and initial value.
1// may result in the validation error if `description` field is undefined:
2[{"op": "add", "path": "/fields/description/en-US", "value": "initial value"}]
3
4// if `description` field is not defined on Entry, but defined in the Content Type, make sure to provide the locale in the payload:
5[{"op": "add", "path": "/fields/description", "value": {"en-US": "initial value"}}]

Get an entry

Use this endpoint to fetch an entry with a specified ID. All empty entry fields are omitted from the response,. That means if the field is empty, its key is not going to be presented in the response. If the entry has no set fields, the corresponding key is missing as well.

To update the entry with empty fields, all keys that need to be updated should be added to the entry object.