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"
]
},
"keyInsight": [
"Enterprise buyers value ROI demonstrations",
"Decision process involves multiple stakeholders"
],
"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>"
]
}
]
}
'import requests
url = "https://app.octavehq.com/api/v2/playbook/update"
payload = {
"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"]
},
"keyInsight": ["Enterprise buyers value ROI demonstrations", "Decision process involves multiple stakeholders"],
"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>"]
}
]
}
headers = {
"api_key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {api_key: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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']},
keyInsight: [
'Enterprise buyers value ROI demonstrations',
'Decision process involves multiple stakeholders'
],
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>']}]
})
};
fetch('https://app.octavehq.com/api/v2/playbook/update', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.octavehq.com/api/v2/playbook/update",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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'
]
],
'keyInsight' => [
'Enterprise buyers value ROI demonstrations',
'Decision process involves multiple stakeholders'
],
'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>'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"api_key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.octavehq.com/api/v2/playbook/update"
payload := strings.NewReader("{\n \"oId\": \"pb_1234\",\n \"name\": \"Enterprise Sales Playbook\",\n \"description\": \"Comprehensive playbook for enterprise sales processes\",\n \"explanation\": \"This playbook focuses on enterprise accounts with complex decision-making processes\",\n \"attributes\": {\n \"industry\": [\n \"technology\",\n \"healthcare\"\n ],\n \"size\": [\n \"enterprise\"\n ]\n },\n \"keyInsight\": [\n \"Enterprise buyers value ROI demonstrations\",\n \"Decision process involves multiple stakeholders\"\n ],\n \"exampleDomains\": [\n \"acme.com\",\n \"example.com\",\n \"enterprise.com\"\n ],\n \"exampleDescription\": \"Target Fortune 500 companies with existing CRM systems looking to modernize\",\n \"approachAngle\": [\n \"ROI-focused approach\",\n \"Security-first messaging\",\n \"Integration benefits\"\n ],\n \"strategicNarrative\": [\n \"Digital transformation is essential\",\n \"Legacy systems are holding you back\"\n ],\n \"customFields\": [\n {\n \"title\": \"<string>\",\n \"value\": [\n \"<string>\"\n ]\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("api_key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.octavehq.com/api/v2/playbook/update")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"oId\": \"pb_1234\",\n \"name\": \"Enterprise Sales Playbook\",\n \"description\": \"Comprehensive playbook for enterprise sales processes\",\n \"explanation\": \"This playbook focuses on enterprise accounts with complex decision-making processes\",\n \"attributes\": {\n \"industry\": [\n \"technology\",\n \"healthcare\"\n ],\n \"size\": [\n \"enterprise\"\n ]\n },\n \"keyInsight\": [\n \"Enterprise buyers value ROI demonstrations\",\n \"Decision process involves multiple stakeholders\"\n ],\n \"exampleDomains\": [\n \"acme.com\",\n \"example.com\",\n \"enterprise.com\"\n ],\n \"exampleDescription\": \"Target Fortune 500 companies with existing CRM systems looking to modernize\",\n \"approachAngle\": [\n \"ROI-focused approach\",\n \"Security-first messaging\",\n \"Integration benefits\"\n ],\n \"strategicNarrative\": [\n \"Digital transformation is essential\",\n \"Legacy systems are holding you back\"\n ],\n \"customFields\": [\n {\n \"title\": \"<string>\",\n \"value\": [\n \"<string>\"\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octavehq.com/api/v2/playbook/update")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"oId\": \"pb_1234\",\n \"name\": \"Enterprise Sales Playbook\",\n \"description\": \"Comprehensive playbook for enterprise sales processes\",\n \"explanation\": \"This playbook focuses on enterprise accounts with complex decision-making processes\",\n \"attributes\": {\n \"industry\": [\n \"technology\",\n \"healthcare\"\n ],\n \"size\": [\n \"enterprise\"\n ]\n },\n \"keyInsight\": [\n \"Enterprise buyers value ROI demonstrations\",\n \"Decision process involves multiple stakeholders\"\n ],\n \"exampleDomains\": [\n \"acme.com\",\n \"example.com\",\n \"enterprise.com\"\n ],\n \"exampleDescription\": \"Target Fortune 500 companies with existing CRM systems looking to modernize\",\n \"approachAngle\": [\n \"ROI-focused approach\",\n \"Security-first messaging\",\n \"Integration benefits\"\n ],\n \"strategicNarrative\": [\n \"Digital transformation is essential\",\n \"Legacy systems are holding you back\"\n ],\n \"customFields\": [\n {\n \"title\": \"<string>\",\n \"value\": [\n \"<string>\"\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"data": {
"oId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"data": {
"explanation": "<string>",
"attributes": {},
"keyInsight": [],
"exampleDomains": [],
"exampleDescription": "",
"approachAngle": [
"<string>"
],
"strategicNarrative": [
"<string>"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
],
"methodology": {
"type": "CVI_WHY_CHANGE",
"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": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z",
"archivedAt": "2023-11-07T05:31:56Z",
"name": "<string>",
"description": "<string>",
"qualifyingQuestions": [
{
"question": "<string>",
"rationale": "<string>",
"fitType": "GOOD",
"weight": "MEDIUM",
"archivedAt": "2023-11-07T05:31:56Z"
}
],
"active": true,
"type": "LEGACY",
"framework": "CVI_WHY_CHANGE",
"status": "active",
"referenceMode": "specific",
"proofPointMode": "none",
"product": {
"type": "PRODUCT",
"oId": "<string>",
"name": "<string>",
"data": {
"type": "PRODUCT",
"internalName": "<string>",
"summary": "<string>",
"distinctCapabilities": [
"Capability 1",
"Capability 2"
],
"keyFunctionality": [
"Functionality 1",
"Functionality 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>"
]
}
],
"additionalProperties": {}
},
"description": "<string>"
},
"service": {
"oId": "<string>",
"name": "<string>",
"data": null,
"description": "<string>"
},
"buyerPersonas": [
{
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"hypotheses": [
{
"oId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"name": "<string>",
"details": "<string>",
"persona": {
"name": "<string>",
"oId": "<string>"
},
"playbook": {
"name": "<string>",
"oId": "<string>"
},
"user": {
"name": "<string>",
"oId": "<string>"
},
"archivedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"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>"
]
}
],
"additionalProperties": {}
}
}
],
"useCases": [
{
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"data": {
"summary": "<string>",
"scenarios": [
"<string>"
],
"desiredOutcomes": [
"<string>"
],
"businessDrivers": [
"<string>"
],
"strategicImpact": [
"<string>"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
],
"additionalProperties": {}
}
}
],
"references": [
{
"oId": "<string>",
"name": "<string>",
"data": {
"businessModel": [
"<string>"
],
"theirChallenge": [
"<string>"
],
"howTheyUseUs": [
"<string>"
],
"whyTheyChoseUs": [
"<string>"
],
"impactTheySaw": [
"<string>"
],
"stakeholdersInvolved": [
"<string>"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
],
"additionalProperties": {}
},
"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
}
]
}
}{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"message": "<string>"
}{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"message": "<string>"
}Update Playbook
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"
]
},
"keyInsight": [
"Enterprise buyers value ROI demonstrations",
"Decision process involves multiple stakeholders"
],
"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>"
]
}
]
}
'import requests
url = "https://app.octavehq.com/api/v2/playbook/update"
payload = {
"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"]
},
"keyInsight": ["Enterprise buyers value ROI demonstrations", "Decision process involves multiple stakeholders"],
"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>"]
}
]
}
headers = {
"api_key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {api_key: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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']},
keyInsight: [
'Enterprise buyers value ROI demonstrations',
'Decision process involves multiple stakeholders'
],
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>']}]
})
};
fetch('https://app.octavehq.com/api/v2/playbook/update', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.octavehq.com/api/v2/playbook/update",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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'
]
],
'keyInsight' => [
'Enterprise buyers value ROI demonstrations',
'Decision process involves multiple stakeholders'
],
'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>'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"api_key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.octavehq.com/api/v2/playbook/update"
payload := strings.NewReader("{\n \"oId\": \"pb_1234\",\n \"name\": \"Enterprise Sales Playbook\",\n \"description\": \"Comprehensive playbook for enterprise sales processes\",\n \"explanation\": \"This playbook focuses on enterprise accounts with complex decision-making processes\",\n \"attributes\": {\n \"industry\": [\n \"technology\",\n \"healthcare\"\n ],\n \"size\": [\n \"enterprise\"\n ]\n },\n \"keyInsight\": [\n \"Enterprise buyers value ROI demonstrations\",\n \"Decision process involves multiple stakeholders\"\n ],\n \"exampleDomains\": [\n \"acme.com\",\n \"example.com\",\n \"enterprise.com\"\n ],\n \"exampleDescription\": \"Target Fortune 500 companies with existing CRM systems looking to modernize\",\n \"approachAngle\": [\n \"ROI-focused approach\",\n \"Security-first messaging\",\n \"Integration benefits\"\n ],\n \"strategicNarrative\": [\n \"Digital transformation is essential\",\n \"Legacy systems are holding you back\"\n ],\n \"customFields\": [\n {\n \"title\": \"<string>\",\n \"value\": [\n \"<string>\"\n ]\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("api_key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.octavehq.com/api/v2/playbook/update")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"oId\": \"pb_1234\",\n \"name\": \"Enterprise Sales Playbook\",\n \"description\": \"Comprehensive playbook for enterprise sales processes\",\n \"explanation\": \"This playbook focuses on enterprise accounts with complex decision-making processes\",\n \"attributes\": {\n \"industry\": [\n \"technology\",\n \"healthcare\"\n ],\n \"size\": [\n \"enterprise\"\n ]\n },\n \"keyInsight\": [\n \"Enterprise buyers value ROI demonstrations\",\n \"Decision process involves multiple stakeholders\"\n ],\n \"exampleDomains\": [\n \"acme.com\",\n \"example.com\",\n \"enterprise.com\"\n ],\n \"exampleDescription\": \"Target Fortune 500 companies with existing CRM systems looking to modernize\",\n \"approachAngle\": [\n \"ROI-focused approach\",\n \"Security-first messaging\",\n \"Integration benefits\"\n ],\n \"strategicNarrative\": [\n \"Digital transformation is essential\",\n \"Legacy systems are holding you back\"\n ],\n \"customFields\": [\n {\n \"title\": \"<string>\",\n \"value\": [\n \"<string>\"\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octavehq.com/api/v2/playbook/update")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"oId\": \"pb_1234\",\n \"name\": \"Enterprise Sales Playbook\",\n \"description\": \"Comprehensive playbook for enterprise sales processes\",\n \"explanation\": \"This playbook focuses on enterprise accounts with complex decision-making processes\",\n \"attributes\": {\n \"industry\": [\n \"technology\",\n \"healthcare\"\n ],\n \"size\": [\n \"enterprise\"\n ]\n },\n \"keyInsight\": [\n \"Enterprise buyers value ROI demonstrations\",\n \"Decision process involves multiple stakeholders\"\n ],\n \"exampleDomains\": [\n \"acme.com\",\n \"example.com\",\n \"enterprise.com\"\n ],\n \"exampleDescription\": \"Target Fortune 500 companies with existing CRM systems looking to modernize\",\n \"approachAngle\": [\n \"ROI-focused approach\",\n \"Security-first messaging\",\n \"Integration benefits\"\n ],\n \"strategicNarrative\": [\n \"Digital transformation is essential\",\n \"Legacy systems are holding you back\"\n ],\n \"customFields\": [\n {\n \"title\": \"<string>\",\n \"value\": [\n \"<string>\"\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"data": {
"oId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"data": {
"explanation": "<string>",
"attributes": {},
"keyInsight": [],
"exampleDomains": [],
"exampleDescription": "",
"approachAngle": [
"<string>"
],
"strategicNarrative": [
"<string>"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
],
"methodology": {
"type": "CVI_WHY_CHANGE",
"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": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z",
"archivedAt": "2023-11-07T05:31:56Z",
"name": "<string>",
"description": "<string>",
"qualifyingQuestions": [
{
"question": "<string>",
"rationale": "<string>",
"fitType": "GOOD",
"weight": "MEDIUM",
"archivedAt": "2023-11-07T05:31:56Z"
}
],
"active": true,
"type": "LEGACY",
"framework": "CVI_WHY_CHANGE",
"status": "active",
"referenceMode": "specific",
"proofPointMode": "none",
"product": {
"type": "PRODUCT",
"oId": "<string>",
"name": "<string>",
"data": {
"type": "PRODUCT",
"internalName": "<string>",
"summary": "<string>",
"distinctCapabilities": [
"Capability 1",
"Capability 2"
],
"keyFunctionality": [
"Functionality 1",
"Functionality 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>"
]
}
],
"additionalProperties": {}
},
"description": "<string>"
},
"service": {
"oId": "<string>",
"name": "<string>",
"data": null,
"description": "<string>"
},
"buyerPersonas": [
{
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"hypotheses": [
{
"oId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"name": "<string>",
"details": "<string>",
"persona": {
"name": "<string>",
"oId": "<string>"
},
"playbook": {
"name": "<string>",
"oId": "<string>"
},
"user": {
"name": "<string>",
"oId": "<string>"
},
"archivedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"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>"
]
}
],
"additionalProperties": {}
}
}
],
"useCases": [
{
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"data": {
"summary": "<string>",
"scenarios": [
"<string>"
],
"desiredOutcomes": [
"<string>"
],
"businessDrivers": [
"<string>"
],
"strategicImpact": [
"<string>"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
],
"additionalProperties": {}
}
}
],
"references": [
{
"oId": "<string>",
"name": "<string>",
"data": {
"businessModel": [
"<string>"
],
"theirChallenge": [
"<string>"
],
"howTheyUseUs": [
"<string>"
],
"whyTheyChoseUs": [
"<string>"
],
"impactTheySaw": [
"<string>"
],
"stakeholdersInvolved": [
"<string>"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
],
"additionalProperties": {}
},
"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
}
]
}
}{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"message": "<string>"
}{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"message": "<string>"
}Authorizations
Body
Playbook update input
The ID of the playbook to update
1"pb_1234"
The name of the playbook
"Enterprise Sales Playbook"
A description of the playbook
"Comprehensive playbook for enterprise sales processes"
Detailed explanation of the playbook strategy
"This playbook focuses on enterprise accounts with complex decision-making processes"
Key attributes and characteristics of the playbook
Show child attributes
Show child attributes
{
"industry": ["technology", "healthcare"],
"size": ["enterprise"]
}
Key insights that drive this playbook strategy
[
"Enterprise buyers value ROI demonstrations",
"Decision process involves multiple stakeholders"
]
Example company domains that fit this playbook
["acme.com", "example.com", "enterprise.com"]
Example description or scenario for this playbook
"Target Fortune 500 companies with existing CRM systems looking to modernize"
Different angles or approaches for this playbook
[
"ROI-focused approach",
"Security-first messaging",
"Integration benefits"
]
Strategic narrative components for this playbook
[
"Digital transformation is essential",
"Legacy systems are holding you back"
]
Custom fields for additional playbook information
Show child attributes
Show child attributes