Show examples in:
Javascript HTTP
Endpoint info
Available examples
Content Management API > Editing session

Allows all actions on editing sessions

Warning: Experimental API

Please note that this API method is marked as unstable and should be avoided in production environments. Changes may occur at any time without warning, potentially impacting your scripts. We recommend contacting our Support Team to explore alternative approaches that are safer and more reliable!

Examples

PUT https://site-api.datocms.com/editing-sessions/:editing_session_id HTTP/1.1
Authorization: Bearer YOUR-API-TOKEN
Accept: application/json
X-Api-Version: 3
Content-Type: application/vnd.api+json
{
"data": {
"type": "editing_session_enter_item",
"relationships": {
"item": {
"data": {
"type": "item",
"id": "hWl-mnkWRYmMCSTq4z_piQ"
}
}
}
}
}
Terminal window
curl -g 'https://site-api.datocms.com/editing-sessions/:editing_session_id' \
-X PUT \
-H "Authorization: Bearer YOUR-API-TOKEN" \
-H "Accept: application/json" \
-H "X-Api-Version: 3" \
-H "Content-Type: application/vnd.api+json" \
--data-binary '{"data":{"type":"editing_session_enter_item","relationships":{"item":{"data":{"type":"item","id":"hWl-mnkWRYmMCSTq4z_piQ"}}}}}'
await fetch(
"https://site-api.datocms.com/editing-sessions/:editing_session_id",
{
method: "PUT",
headers: {
Authorization: "Bearer YOUR-API-TOKEN",
Accept: "application/json",
"X-Api-Version": "3",
"Content-Type": "application/vnd.api+json",
},
body: JSON.stringify({
data: {
type: "editing_session_enter_item",
relationships: {
item: { data: { type: "item", id: "hWl-mnkWRYmMCSTq4z_piQ" } },
},
},
}),
},
);
HTTP/1.1 200 OK
Content-Type: application/json
Cache-Control: cache-control: max-age=0, private, must-revalidate
X-RateLimit-Limit: 30
X-RateLimit-Remaining: 28
{
"data": {
"type": "editing_session",
"id": "312",
"attributes": {
"last_activity_at": "2019-03-30T09:29:14.872Z",
"locked_at": "2019-03-30T09:29:14.872Z"
},
"relationships": {
"editor": {
"data": {
"type": "account",
"id": "312"
}
},
"active_item": {
"data": {
"type": "item",
"id": "hWl-mnkWRYmMCSTq4z_piQ"
}
},
"active_item_type": {
"data": {
"type": "item_type",
"id": "DxMaW10UQiCmZcuuA-IkkA"
}
}
}
}
}