POST
/
api
/
v2
/
playbook
/
create
Create Playbook
curl --request POST \
  --url https://app.octavehq.com/api/v2/playbook/create \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '{
  "name": "<string>",
  "description": "<string>",
  "keyInsight": "<string>",
  "type": "LEGACY",
  "context": "<string>",
  "personaOIds": [
    "<string>"
  ],
  "useCaseOIds": [
    "<string>"
  ],
  "competitorOId": "<string>",
  "segmentOId": "<string>",
  "proofPointOIds": [
    "<string>"
  ],
  "referenceOIds": [
    "<string>"
  ],
  "createTemplates": true,
  "productOId": "<string>",
  "status": "active",
  "referenceMode": "specific",
  "proofPointMode": "none",
  "additionalContextSources": [
    {
      "type": "URL",
      "value": "https://example.com/market-research"
    },
    {
      "type": "TEXT",
      "value": "Additional market insights about the target segment."
    }
  ]
}'
{
  "_metadata": {
    "usage": 0,
    "requestId": "requestId",
    "message": "message",
    "timestamp": "2021-01-01T00:00:00.000Z"
  },
  "playbook": {
    "oId": "<string>",
    "name": "<string>",
    "description": "<string>",
    "type": "LEGACY",
    "keyInsight": [
      "<string>"
    ]
  },
  "personas": [
    {
      "oId": "p_1234",
      "name": "VP of Sales",
      "internalName": "Sally the Sales Leader",
      "description": "<string>",
      "active": true,
      "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>"
            ]
          }
        ]
      },
      "qualifyingQuestions": [
        {
          "question": "<string>",
          "rationale": "<string>",
          "fitType": "GOOD",
          "weight": "MEDIUM",
          "archivedAt": "<string>"
        }
      ],
      "activeSequences": 123,
      "sentEmails": 123,
      "valueProps": [
        {
          "title": "<string>",
          "details": "<string>",
          "evidence": [
            "<string>"
          ]
        }
      ]
    }
  ],
  "templates": [
    [
      {
        "oId": "<string>",
        "name": "<string>",
        "persona": {
          "oId": "<string>",
          "name": "<string>"
        },
        "status": "active"
      }
    ]
  ]
}

Authorizations

api_key
string
header
required

Body

application/json

Playbook creation input

The body is of type object.

Response

200
application/json

Playbook data

The response is of type object.