Apply Playbook suggestions
curl --request POST \
--url https://api-us.hihobbes.com/api/v1/playbook/suggestions/{group_id}/apply \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"changeIds": [
"<string>"
],
"expectedSectionsEtag": "<string>",
"expectedGenerationRevision": 1
}
'import requests
url = "https://api-us.hihobbes.com/api/v1/playbook/suggestions/{group_id}/apply"
payload = {
"changeIds": ["<string>"],
"expectedSectionsEtag": "<string>",
"expectedGenerationRevision": 1
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
changeIds: ['<string>'],
expectedSectionsEtag: '<string>',
expectedGenerationRevision: 1
})
};
fetch('https://api-us.hihobbes.com/api/v1/playbook/suggestions/{group_id}/apply', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"groupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "applied",
"sectionsEtag": "<string>",
"links": {
"staging": {
"url": "<string>",
"availabilityReason": "<string>"
},
"production": {
"url": "<string>",
"availabilityReason": "<string>"
}
},
"version": 123,
"noChange": false
}{
"detail": "API key required or invalid."
}{
"detail": "API key does not include the required scope."
}{
"detail": "Suggestion group not found for this organization."
}{
"detail": "The operation conflicts with current state or idempotency history."
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}{
"detail": "Rate limit or organization quota exceeded."
}{
"detail": "The workflow is disabled or temporarily unavailable."
}Playbook
Apply Playbook suggestions
Apply selected stored suggestion payloads exactly as generated.
POST
/
api
/
v1
/
playbook
/
suggestions
/
{group_id}
/
apply
Apply Playbook suggestions
curl --request POST \
--url https://api-us.hihobbes.com/api/v1/playbook/suggestions/{group_id}/apply \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"changeIds": [
"<string>"
],
"expectedSectionsEtag": "<string>",
"expectedGenerationRevision": 1
}
'import requests
url = "https://api-us.hihobbes.com/api/v1/playbook/suggestions/{group_id}/apply"
payload = {
"changeIds": ["<string>"],
"expectedSectionsEtag": "<string>",
"expectedGenerationRevision": 1
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
changeIds: ['<string>'],
expectedSectionsEtag: '<string>',
expectedGenerationRevision: 1
})
};
fetch('https://api-us.hihobbes.com/api/v1/playbook/suggestions/{group_id}/apply', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"groupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "applied",
"sectionsEtag": "<string>",
"links": {
"staging": {
"url": "<string>",
"availabilityReason": "<string>"
},
"production": {
"url": "<string>",
"availabilityReason": "<string>"
}
},
"version": 123,
"noChange": false
}{
"detail": "API key required or invalid."
}{
"detail": "API key does not include the required scope."
}{
"detail": "Suggestion group not found for this organization."
}{
"detail": "The operation conflicts with current state or idempotency history."
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}{
"detail": "Rate limit or organization quota exceeded."
}{
"detail": "The workflow is disabled or temporarily unavailable."
}Requires
playbook:write.
Send the selected suggestion IDs and their generation revision. Set
expectedSectionsEtag to the current sectionsEtag. Use the preview endpoint
instead when the proposed wording needs to be edited before it is applied to
staging.Authorizations
bearerapiKeyHeader
Hobbes API key with the hb_live_ prefix.
Path Parameters
Playbook suggestion group UUID.
Body
application/json