Skip to content

Re-read changed items from the CMS

POST
/v1/content/sync
curl --request POST \
--url https://your-tenant-host/v1/content/sync \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "events": [ { "id": "example", "type": "example" } ] }'

Enqueues one re-read per id from the organization’s content source. The body names ids and never content, so a caller can cause a refetch and nothing else. 200 means enqueued. Safe to retry: re-reads of one id within seconds are debounced into one.

Media typeapplication/json
object
events
required
Array<object>
>= 1 items <= 100 items
object
id
required

The CMS id of the item that changed. Arc: the story or author _id.

string
>= 1 characters <= 256 characters
type

The CMS content type, when known; absent is story. Arc: story or author; any other type is accepted and ignored.

string
>= 1 characters <= 64 characters

Example generated

{
"events": [
{
"id": "example",
"type": "example"
}
]
}

Enqueued.

Media typeapplication/json
object
success
required
boolean

Example

{
"success": true
}

Invalid request.

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details

Example

{
"error": {
"code": "unauthorized",
"message": "Invalid or missing API key."
}
}

Missing or invalid credential.

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details

Example

{
"error": {
"code": "unauthorized",
"message": "Invalid or missing API key."
}
}

Request validation failed.

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details

Example

{
"error": {
"code": "unauthorized",
"message": "Invalid or missing API key."
}
}

Unexpected error.

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details

Example

{
"error": {
"code": "unauthorized",
"message": "Invalid or missing API key."
}
}

With Retry-After, briefly unavailable; without it, not configured.

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details

Example

{
"error": {
"code": "unauthorized",
"message": "Invalid or missing API key."
}
}