curl --request POST \
--url https://app.octavehq.com/api/v2/playbook/update \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '{
"oId": "pb_1234",
"name": "Enterprise Sales Playbook",
"description": "Comprehensive playbook for enterprise sales processes",
"explanation": "This playbook focuses on enterprise accounts with complex decision-making processes",
"attributes": {
"industry": [
"technology",
"healthcare"
],
"size": [
"enterprise"
]
},
"icpConcerns": [
"Budget constraints",
"Security requirements",
"Integration complexity"
],
"icpPriorities": [
"Reduce costs",
"Improve efficiency",
"Scale operations"
],
"keyInsight": [
"Enterprise buyers value ROI demonstrations",
"Decision process involves multiple stakeholders"
],
"statusQuo": [
"Manual processes",
"Legacy systems",
"Disconnected tools"
],
"differentiatedValue": [
"Advanced automation",
"Enterprise-grade security",
"Seamless integrations"
],
"exampleDomains": [
"acme.com",
"example.com",
"enterprise.com"
],
"exampleDescription": "Target Fortune 500 companies with existing CRM systems looking to modernize",
"approachAngle": [
"ROI-focused approach",
"Security-first messaging",
"Integration benefits"
],
"strategicNarrative": [
"Digital transformation is essential",
"Legacy systems are holding you back"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
]
}'
{
"_metadata": {
"usage": 0,
"requestId": "requestId",
"message": "message",
"timestamp": "2021-01-01T00:00:00.000Z"
},
"data": {
"oId": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"deletedAt": "<string>",
"archivedAt": "<string>",
"name": "<string>",
"description": "<string>",
"data": {
"explanation": "<string>",
"attributes": {},
"icpConcerns": [],
"icpPriorities": [],
"keyInsight": [],
"statusQuo": [],
"differentiatedValue": [],
"exampleDomains": [],
"exampleDescription": "",
"approachAngle": [
"<string>"
],
"strategicNarrative": [
"<string>"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
]
},
"qualifyingQuestions": [
{
"question": "<string>",
"rationale": "<string>",
"fitType": "GOOD",
"weight": "MEDIUM",
"archivedAt": "<string>"
}
],
"shared": true,
"type": "LEGACY",
"status": "active",
"referenceMode": "specific",
"proofPointMode": "none",
"user": {
"oId": "<string>"
},
"workspace": {
"oId": "<string>"
},
"product": {
"oId": "<string>",
"name": "<string>",
"data": {
"type": "PRODUCT",
"internalName": "<string>",
"summary": "<string>",
"capabilities": [
"Capability 1",
"Capability 2"
],
"differentiatedValue": [
"Differentiated Value 1",
"Differentiated Value 2"
],
"statusQuo": [
"Status Quo 1",
"Status Quo 2"
],
"challengesAddressed": [
"Challenge 1",
"Challenge 2"
],
"customerBenefits": [
"Benefit 1",
"Benefit 2"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
]
},
"description": "<string>"
},
"buyerPersonas": [
{
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"hypotheses": [
{
"oId": "<string>",
"createdAt": "<string>",
"archivedAt": "<string>",
"deletedAt": "<string>",
"updatedAt": "<string>",
"title": "<string>",
"details": "<string>",
"context": "<string>",
"persona": {
"name": "<string>",
"oId": "<string>"
},
"playbook": {
"name": "<string>",
"oId": "<string>"
},
"user": {
"name": "<string>",
"oId": "<string>"
}
}
],
"data": {
"internalName": "<string>",
"primaryResponsibilities": [
"Responsibility 1",
"Responsibility 2"
],
"painPoints": [
"Pain Point 1",
"Pain Point 2"
],
"keyConcerns": [
"Concern 1",
"Concern 2"
],
"keyObjectives": [
"Objective 1",
"Objective 2"
],
"commonJobTitles": [
"Job Title 1",
"Job Title 2"
],
"whyTheyMatterToUs": [
"Reason 1",
"Reason 2"
],
"whyWeMatterToThem": [
"Reason 1",
"Reason 2"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
]
}
}
],
"useCases": [
{
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"data": {
"summary": "<string>",
"scenarios": [
"<string>"
],
"desiredOutcomes": [
"<string>"
],
"businessDrivers": [
"<string>"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
]
}
}
],
"sequenceTemplates": [
{
"oId": "<string>",
"name": "<string>",
"persona": {
"oId": "<string>",
"name": "<string>"
},
"status": "active"
}
],
"references": [
{
"oId": "<string>",
"name": "<string>",
"data": {
"howTheyMakeMoney": "<string>",
"howTheyUseProduct": "<string>",
"howTheyBenefitFromProduct": "<string>",
"emailSnippets": [
"<string>"
],
"howWeImpactedTheirBusiness": [
"<string>"
],
"keyStats": [
"<string>"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
]
},
"description": "<string>"
}
],
"segment": {
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"data": "<any>"
},
"competitor": {
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"data": "<any>"
},
"proofPoints": [
{
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"data": "<any>"
}
]
}
}
Update an existing playbook. Only provided fields will be updated - omitted fields remain unchanged. The ‘data’ object will be shallow merged with existing data.
curl --request POST \
--url https://app.octavehq.com/api/v2/playbook/update \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '{
"oId": "pb_1234",
"name": "Enterprise Sales Playbook",
"description": "Comprehensive playbook for enterprise sales processes",
"explanation": "This playbook focuses on enterprise accounts with complex decision-making processes",
"attributes": {
"industry": [
"technology",
"healthcare"
],
"size": [
"enterprise"
]
},
"icpConcerns": [
"Budget constraints",
"Security requirements",
"Integration complexity"
],
"icpPriorities": [
"Reduce costs",
"Improve efficiency",
"Scale operations"
],
"keyInsight": [
"Enterprise buyers value ROI demonstrations",
"Decision process involves multiple stakeholders"
],
"statusQuo": [
"Manual processes",
"Legacy systems",
"Disconnected tools"
],
"differentiatedValue": [
"Advanced automation",
"Enterprise-grade security",
"Seamless integrations"
],
"exampleDomains": [
"acme.com",
"example.com",
"enterprise.com"
],
"exampleDescription": "Target Fortune 500 companies with existing CRM systems looking to modernize",
"approachAngle": [
"ROI-focused approach",
"Security-first messaging",
"Integration benefits"
],
"strategicNarrative": [
"Digital transformation is essential",
"Legacy systems are holding you back"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
]
}'
{
"_metadata": {
"usage": 0,
"requestId": "requestId",
"message": "message",
"timestamp": "2021-01-01T00:00:00.000Z"
},
"data": {
"oId": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"deletedAt": "<string>",
"archivedAt": "<string>",
"name": "<string>",
"description": "<string>",
"data": {
"explanation": "<string>",
"attributes": {},
"icpConcerns": [],
"icpPriorities": [],
"keyInsight": [],
"statusQuo": [],
"differentiatedValue": [],
"exampleDomains": [],
"exampleDescription": "",
"approachAngle": [
"<string>"
],
"strategicNarrative": [
"<string>"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
]
},
"qualifyingQuestions": [
{
"question": "<string>",
"rationale": "<string>",
"fitType": "GOOD",
"weight": "MEDIUM",
"archivedAt": "<string>"
}
],
"shared": true,
"type": "LEGACY",
"status": "active",
"referenceMode": "specific",
"proofPointMode": "none",
"user": {
"oId": "<string>"
},
"workspace": {
"oId": "<string>"
},
"product": {
"oId": "<string>",
"name": "<string>",
"data": {
"type": "PRODUCT",
"internalName": "<string>",
"summary": "<string>",
"capabilities": [
"Capability 1",
"Capability 2"
],
"differentiatedValue": [
"Differentiated Value 1",
"Differentiated Value 2"
],
"statusQuo": [
"Status Quo 1",
"Status Quo 2"
],
"challengesAddressed": [
"Challenge 1",
"Challenge 2"
],
"customerBenefits": [
"Benefit 1",
"Benefit 2"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
]
},
"description": "<string>"
},
"buyerPersonas": [
{
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"hypotheses": [
{
"oId": "<string>",
"createdAt": "<string>",
"archivedAt": "<string>",
"deletedAt": "<string>",
"updatedAt": "<string>",
"title": "<string>",
"details": "<string>",
"context": "<string>",
"persona": {
"name": "<string>",
"oId": "<string>"
},
"playbook": {
"name": "<string>",
"oId": "<string>"
},
"user": {
"name": "<string>",
"oId": "<string>"
}
}
],
"data": {
"internalName": "<string>",
"primaryResponsibilities": [
"Responsibility 1",
"Responsibility 2"
],
"painPoints": [
"Pain Point 1",
"Pain Point 2"
],
"keyConcerns": [
"Concern 1",
"Concern 2"
],
"keyObjectives": [
"Objective 1",
"Objective 2"
],
"commonJobTitles": [
"Job Title 1",
"Job Title 2"
],
"whyTheyMatterToUs": [
"Reason 1",
"Reason 2"
],
"whyWeMatterToThem": [
"Reason 1",
"Reason 2"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
]
}
}
],
"useCases": [
{
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"data": {
"summary": "<string>",
"scenarios": [
"<string>"
],
"desiredOutcomes": [
"<string>"
],
"businessDrivers": [
"<string>"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
]
}
}
],
"sequenceTemplates": [
{
"oId": "<string>",
"name": "<string>",
"persona": {
"oId": "<string>",
"name": "<string>"
},
"status": "active"
}
],
"references": [
{
"oId": "<string>",
"name": "<string>",
"data": {
"howTheyMakeMoney": "<string>",
"howTheyUseProduct": "<string>",
"howTheyBenefitFromProduct": "<string>",
"emailSnippets": [
"<string>"
],
"howWeImpactedTheirBusiness": [
"<string>"
],
"keyStats": [
"<string>"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
]
},
"description": "<string>"
}
],
"segment": {
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"data": "<any>"
},
"competitor": {
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"data": "<any>"
},
"proofPoints": [
{
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"data": "<any>"
}
]
}
}
Playbook update input
The body is of type object
.
Playbook updated successfully
The response is of type object
.