Apply a Playbook update preview
curl --request POST \
--url https://api-us.hihobbes.com/api/v1/playbook/update-previews/{preview_id}/apply \
--header 'Authorization: Bearer <token>'import requests
url = "https://api-us.hihobbes.com/api/v1/playbook/update-previews/{preview_id}/apply"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api-us.hihobbes.com/api/v1/playbook/update-previews/{preview_id}/apply', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"previewId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"version": 123,
"sectionsEtag": "<string>",
"productionVersion": 123,
"stagingVersion": 123,
"links": {
"staging": {
"target": {
"lane": "staging",
"revisionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"revisionNumber": 123,
"revisionStatus": "<string>"
},
"url": "<string>",
"availabilityReason": "<string>",
"expiresAt": "2023-11-07T05:31:56Z"
},
"production": {
"target": {
"lane": "staging",
"revisionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"revisionNumber": 123,
"revisionStatus": "<string>"
},
"url": "<string>",
"availabilityReason": "<string>",
"expiresAt": "2023-11-07T05:31:56Z"
}
},
"changes": [
{
"sectionKey": "<string>",
"title": "<string>",
"action": "added",
"before": "<unknown>",
"after": "<unknown>"
}
],
"noChange": false,
"role": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"isDefault": true,
"name": "<string>",
"selection": "explicit"
},
"stagingRevision": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"number": 123,
"status": "draft"
}
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}Apply a Hobbes Playbook update preview
Apply an approved, unexpired preview to staging.
POST
/
api
/
v1
/
playbook
/
update-previews
/
{preview_id}
/
apply
Apply a Playbook update preview
curl --request POST \
--url https://api-us.hihobbes.com/api/v1/playbook/update-previews/{preview_id}/apply \
--header 'Authorization: Bearer <token>'import requests
url = "https://api-us.hihobbes.com/api/v1/playbook/update-previews/{preview_id}/apply"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api-us.hihobbes.com/api/v1/playbook/update-previews/{preview_id}/apply', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"previewId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"version": 123,
"sectionsEtag": "<string>",
"productionVersion": 123,
"stagingVersion": 123,
"links": {
"staging": {
"target": {
"lane": "staging",
"revisionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"revisionNumber": 123,
"revisionStatus": "<string>"
},
"url": "<string>",
"availabilityReason": "<string>",
"expiresAt": "2023-11-07T05:31:56Z"
},
"production": {
"target": {
"lane": "staging",
"revisionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"revisionNumber": 123,
"revisionStatus": "<string>"
},
"url": "<string>",
"availabilityReason": "<string>",
"expiresAt": "2023-11-07T05:31:56Z"
}
},
"changes": [
{
"sectionKey": "<string>",
"title": "<string>",
"action": "added",
"before": "<unknown>",
"after": "<unknown>"
}
],
"noChange": false,
"role": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"isDefault": true,
"name": "<string>",
"selection": "explicit"
},
"stagingRevision": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"number": 123,
"status": "draft"
}
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}Last reviewed 2026-11-09
Requires
playbook:write.
The preview must have been created by the same API key. If staging changed
after the preview was created, Hobbes returns 409 without creating a version.
Create a new preview against the current sectionsEtag. Repeating a successful
apply returns the original result.
Related docs
- Review the protected workflow for previewing and applying agent changes. Playbook and agent API guide
- Review the supported endpoint contract. Hobbes API overview
- Confirm the required key permissions. Authentication and scopes
Authorizations
bearerapiKeyHeader
Response
Successful Response