Delete Playbook
curl --request DELETE \
--url https://app.octavehq.com/api/v2/playbook/delete \
--header 'api_key: <api-key>'{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"oId": "<string>",
"createdAt": "<string>",
"data": {
"explanation": "<string>",
"attributes": {},
"keyInsight": [],
"exampleDomains": [],
"exampleDescription": "",
"approachAngle": [
"<string>"
],
"strategicNarrative": [
"<string>"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
],
"methodology": {
"data": {
"coreNarrative": [
"<string>"
],
"stages": {
"A1": {
"overview": [
"<string>"
],
"whatToKnow": [
"<string>"
],
"whatToDo": [
"<string>"
],
"whatToSay": [
"<string>"
]
},
"A2": {
"overview": [
"<string>"
],
"whatToKnow": [
"<string>"
],
"whatToDo": [
"<string>"
],
"whatToSay": [
"<string>"
]
},
"A3": {
"overview": [
"<string>"
],
"whatToKnow": [
"<string>"
],
"whatToDo": [
"<string>"
],
"whatToSay": [
"<string>"
]
},
"A4": {
"overview": [
"<string>"
],
"whatToKnow": [
"<string>"
],
"whatToDo": [
"<string>"
],
"whatToSay": [
"<string>"
]
},
"A5": {
"overview": [
"<string>"
],
"whatToKnow": [
"<string>"
],
"whatToDo": [
"<string>"
],
"whatToSay": [
"<string>"
]
}
},
"generatedAt": "<string>"
}
}
},
"user": {
"oId": "<string>",
"firstName": "<string>",
"lastName": "<string>"
},
"workspace": {
"oId": "<string>"
},
"updatedAt": "<string>",
"deletedAt": "<string>",
"archivedAt": "<string>",
"name": "<string>",
"description": "<string>",
"qualifyingQuestions": [
{
"question": "<string>",
"rationale": "<string>",
"fitType": "GOOD",
"weight": "MEDIUM",
"archivedAt": "<string>"
}
],
"active": true,
"status": "active",
"referenceMode": "specific",
"proofPointMode": "none",
"product": {
"oId": "<string>",
"name": "<string>",
"data": {
"type": "PRODUCT",
"internalName": "<string>",
"summary": "<string>",
"distinctCapabilities": [
"Capability 1",
"Capability 2"
],
"keyFeatures": [
"Feature 1",
"Feature 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>"
},
"service": {
"oId": "<string>",
"name": "<string>",
"data": null,
"description": "<string>"
},
"buyerPersonas": [
{
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"hypotheses": [
{
"oId": "<string>",
"createdAt": "<string>",
"name": "<string>",
"details": "<string>",
"persona": {
"name": "<string>",
"oId": "<string>"
},
"playbook": {
"name": "<string>",
"oId": "<string>"
},
"user": {
"name": "<string>",
"oId": "<string>"
},
"archivedAt": "<string>",
"deletedAt": "<string>",
"updatedAt": "<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"
],
"buyingRole": [
"Economic buyer with budget authority over the GTM stack.",
"Experienced operator who has evaluated similar tooling before."
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
]
}
}
],
"useCases": [
{
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"data": {
"summary": "<string>",
"scenarios": [
"<string>"
],
"desiredOutcomes": [
"<string>"
],
"businessDrivers": [
"<string>"
],
"strategicImpact": [
"<string>"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
]
}
}
],
"references": [
{
"oId": "<string>",
"name": "<string>",
"data": {
"businessModel": "<string>",
"theirChallenge": "<string>",
"howTheyUseUs": "<string>",
"whyTheyChoseUs": "<string>",
"impactTheySaw": [
"<string>"
],
"stakeholdersInvolved": [
"<string>"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
]
},
"description": "<string>"
}
],
"segment": {
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"data": null
},
"competitor": {
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"data": null
},
"proofPoints": [
{
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"data": null
}
]
}Delete Playbook
Soft delete a Playbook by OId. The playbook will be marked as deleted but not permanently removed.
DELETE
/
api
/
v2
/
playbook
/
delete
Delete Playbook
curl --request DELETE \
--url https://app.octavehq.com/api/v2/playbook/delete \
--header 'api_key: <api-key>'{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"oId": "<string>",
"createdAt": "<string>",
"data": {
"explanation": "<string>",
"attributes": {},
"keyInsight": [],
"exampleDomains": [],
"exampleDescription": "",
"approachAngle": [
"<string>"
],
"strategicNarrative": [
"<string>"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
],
"methodology": {
"data": {
"coreNarrative": [
"<string>"
],
"stages": {
"A1": {
"overview": [
"<string>"
],
"whatToKnow": [
"<string>"
],
"whatToDo": [
"<string>"
],
"whatToSay": [
"<string>"
]
},
"A2": {
"overview": [
"<string>"
],
"whatToKnow": [
"<string>"
],
"whatToDo": [
"<string>"
],
"whatToSay": [
"<string>"
]
},
"A3": {
"overview": [
"<string>"
],
"whatToKnow": [
"<string>"
],
"whatToDo": [
"<string>"
],
"whatToSay": [
"<string>"
]
},
"A4": {
"overview": [
"<string>"
],
"whatToKnow": [
"<string>"
],
"whatToDo": [
"<string>"
],
"whatToSay": [
"<string>"
]
},
"A5": {
"overview": [
"<string>"
],
"whatToKnow": [
"<string>"
],
"whatToDo": [
"<string>"
],
"whatToSay": [
"<string>"
]
}
},
"generatedAt": "<string>"
}
}
},
"user": {
"oId": "<string>",
"firstName": "<string>",
"lastName": "<string>"
},
"workspace": {
"oId": "<string>"
},
"updatedAt": "<string>",
"deletedAt": "<string>",
"archivedAt": "<string>",
"name": "<string>",
"description": "<string>",
"qualifyingQuestions": [
{
"question": "<string>",
"rationale": "<string>",
"fitType": "GOOD",
"weight": "MEDIUM",
"archivedAt": "<string>"
}
],
"active": true,
"status": "active",
"referenceMode": "specific",
"proofPointMode": "none",
"product": {
"oId": "<string>",
"name": "<string>",
"data": {
"type": "PRODUCT",
"internalName": "<string>",
"summary": "<string>",
"distinctCapabilities": [
"Capability 1",
"Capability 2"
],
"keyFeatures": [
"Feature 1",
"Feature 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>"
},
"service": {
"oId": "<string>",
"name": "<string>",
"data": null,
"description": "<string>"
},
"buyerPersonas": [
{
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"hypotheses": [
{
"oId": "<string>",
"createdAt": "<string>",
"name": "<string>",
"details": "<string>",
"persona": {
"name": "<string>",
"oId": "<string>"
},
"playbook": {
"name": "<string>",
"oId": "<string>"
},
"user": {
"name": "<string>",
"oId": "<string>"
},
"archivedAt": "<string>",
"deletedAt": "<string>",
"updatedAt": "<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"
],
"buyingRole": [
"Economic buyer with budget authority over the GTM stack.",
"Experienced operator who has evaluated similar tooling before."
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
]
}
}
],
"useCases": [
{
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"data": {
"summary": "<string>",
"scenarios": [
"<string>"
],
"desiredOutcomes": [
"<string>"
],
"businessDrivers": [
"<string>"
],
"strategicImpact": [
"<string>"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
]
}
}
],
"references": [
{
"oId": "<string>",
"name": "<string>",
"data": {
"businessModel": "<string>",
"theirChallenge": "<string>",
"howTheyUseUs": "<string>",
"whyTheyChoseUs": "<string>",
"impactTheySaw": [
"<string>"
],
"stakeholdersInvolved": [
"<string>"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
]
},
"description": "<string>"
}
],
"segment": {
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"data": null
},
"competitor": {
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"data": null
},
"proofPoints": [
{
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"data": null
}
]
}Authorizations
Query Parameters
Playbook OId
Response
Deleted playbook data
Show child attributes
Show child attributes
Minimum string length:
1Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Available options:
LEGACY, SECTOR, SOLUTION, MILESTONE, PRACTITIONER, COMPETITIVE, ACCOUNT, CUSTOM Available options:
CVI_WHY_CHANGE Available options:
active, draft, archived Available options:
specific, none Available options:
specific, none Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I