Skip to main content
POST
/
api
/
v2
/
playbook
/
update
Update Playbook
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>"
      ]
    }
  ]
}
'
{
  "_metadata": {
    "requestId": "requestId",
    "timestamp": "2021-01-01T00:00:00.000Z",
    "usage": 0,
    "message": "message"
  },
  "data": {
    "oId": "<string>",
    "createdAt": "<string>",
    "data": {
      "explanation": "<string>",
      "attributes": {},
      "keyInsight": [],
      "exampleDomains": [],
      "exampleDescription": "",
      "approachAngle": [
        "<string>"
      ],
      "strategicNarrative": [
        "<string>"
      ],
      "customFields": [
        {
          "title": "<string>",
          "value": [
            "<string>"
          ]
        }
      ]
    },
    "user": {
      "oId": "<string>",
      "firstName": "<string>",
      "lastName": "<string>"
    },
    "workspace": {
      "oId": "<string>"
    },
    "product": {
      "type": "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>"
    },
    "updatedAt": "<string>",
    "deletedAt": "<string>",
    "archivedAt": "<string>",
    "name": "<string>",
    "description": "<string>",
    "qualifyingQuestions": [
      {
        "question": "<string>",
        "rationale": "<string>",
        "fitType": "GOOD",
        "weight": "MEDIUM",
        "archivedAt": "<string>"
      }
    ],
    "shared": true,
    "active": true,
    "type": "LEGACY",
    "framework": "CVI_WHY_CHANGE",
    "status": "active",
    "referenceMode": "specific",
    "proofPointMode": "none",
    "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"
          ],
          "customFields": [
            {
              "title": "<string>",
              "value": [
                "<string>"
              ]
            }
          ]
        }
      }
    ],
    "useCases": [
      {
        "oId": "<string>",
        "name": "<string>",
        "description": "<string>",
        "data": {
          "summary": "<string>",
          "scenarios": [
            "<string>"
          ],
          "desiredOutcomes": [
            "<string>"
          ],
          "businessDrivers": [
            "<string>"
          ],
          "businessImpact": [
            "<string>"
          ],
          "customFields": [
            {
              "title": "<string>",
              "value": [
                "<string>"
              ]
            }
          ]
        }
      }
    ],
    "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": "<unknown>"
    },
    "competitor": {
      "oId": "<string>",
      "name": "<string>",
      "description": "<string>",
      "data": "<unknown>"
    },
    "proofPoints": [
      {
        "oId": "<string>",
        "name": "<string>",
        "description": "<string>",
        "data": "<unknown>"
      }
    ]
  }
}

Authorizations

​
api_key
string
header
required

Body

application/json

Playbook update input

​
oId
string
required

The ID of the playbook to update

Minimum string length: 1
Example:

"pb_1234"

​
name
string

The name of the playbook

Example:

"Enterprise Sales Playbook"

​
description
string

A description of the playbook

Example:

"Comprehensive playbook for enterprise sales processes"

​
explanation
string

Detailed explanation of the playbook strategy

Example:

"This playbook focuses on enterprise accounts with complex decision-making processes"

​
attributes
object

Key attributes and characteristics of the playbook

Example:
{
  "industry": ["technology", "healthcare"],
  "size": ["enterprise"]
}
​
keyInsight
string[]

Key insights that drive this playbook strategy

Example:
[
  "Enterprise buyers value ROI demonstrations",
  "Decision process involves multiple stakeholders"
]
​
exampleDomains
string[]

Example company domains that fit this playbook

Example:
["acme.com", "example.com", "enterprise.com"]
​
exampleDescription
string

Example description or scenario for this playbook

Example:

"Target Fortune 500 companies with existing CRM systems looking to modernize"

​
approachAngle
string[]

Different angles or approaches for this playbook

Example:
[
  "ROI-focused approach",
  "Security-first messaging",
  "Integration benefits"
]
​
strategicNarrative
string[]

Strategic narrative components for this playbook

Example:
[
  "Digital transformation is essential",
  "Legacy systems are holding you back"
]
​
customFields
object[]

Custom fields for additional playbook information

Response

Playbook updated successfully

​
_metadata
object
required
​
data
object
required