Skip to main content
POST
/
api
/
v2
/
persona
/
create
Create Persona
curl --request POST \
  --url https://app.octavehq.com/api/v2/persona/create \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '{
  "name": "VP of Sales",
  "internalName": "Sally the Sales Leader",
  "description": "Senior sales leaders responsible for revenue growth",
  "primaryResponsibilities": [
    "Drive revenue growth",
    "Manage sales team"
  ],
  "painPoints": [
    "Long sales cycles",
    "Difficulty tracking performance"
  ],
  "keyConcerns": [
    "Meeting quotas",
    "Team productivity"
  ],
  "keyObjectives": [
    "Increase revenue by 20%",
    "Reduce churn"
  ],
  "commonJobTitles": [
    "VP of Sales",
    "Sales Director",
    "Chief Revenue Officer"
  ],
  "whyTheyMatterToUs": [
    "Decision makers",
    "Budget holders"
  ],
  "whyWeMatterToThem": [
    "Help achieve revenue goals",
    "Improve team efficiency"
  ],
  "customFields": [
    {
      "title": "<string>",
      "value": [
        "<string>"
      ]
    }
  ],
  "primaryOfferingOId": "o_123456",
  "linkingStrategy": {
    "mode": "ALL"
  }
}'
{
  "_metadata": {
    "usage": 0,
    "requestId": "requestId",
    "message": "message",
    "timestamp": "2021-01-01T00:00:00.000Z"
  },
  "data": {
    "oId": "p_1234",
    "name": "VP of Sales",
    "internalName": "Sally the Sales Leader",
    "description": "<string>",
    "createdAt": "2021-01-01",
    "deletedAt": "2021-01-01",
    "archivedAt": "2021-01-01",
    "updatedAt": "2021-01-01",
    "unrecognized": false,
    "rejected": false,
    "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>"
      }
    ],
    "user": {
      "oId": "u_1234",
      "firstName": "John",
      "lastName": "Doe"
    },
    "workspace": {
      "oId": "wa_1234"
    }
  }
}

Authorizations

api_key
string
header
required

Body

application/json

Persona creation input

name
string
required

The external name of the persona

Minimum length: 1
Example:

"VP of Sales"

internalName
string

The internal name of the persona

Example:

"Sally the Sales Leader"

description
string

A description of the persona

Example:

"Senior sales leaders responsible for revenue growth"

primaryResponsibilities
string[]

The primary responsibilities of the persona

Example:
["Drive revenue growth", "Manage sales team"]
painPoints
string[]

The pain points of the persona

Example:
[
"Long sales cycles",
"Difficulty tracking performance"
]
keyConcerns
string[]

The key concerns of the persona

Example:
["Meeting quotas", "Team productivity"]
keyObjectives
string[]

The key objectives of the persona

Example:
["Increase revenue by 20%", "Reduce churn"]
commonJobTitles
string[]

The common job titles of the persona

Example:
[
"VP of Sales",
"Sales Director",
"Chief Revenue Officer"
]
whyTheyMatterToUs
string[]

The reasons why the persona matters to us

Example:
["Decision makers", "Budget holders"]
whyWeMatterToThem
string[]

The reasons why we matter to this type of persona

Example:
[
"Help achieve revenue goals",
"Improve team efficiency"
]
customFields
object[]

Custom fields for additional persona information

primaryOfferingOId
string

Primary Offering to use as context when generating personas. If not provided, the primary company attached to the Workspace will be used.

Example:

"o_123456"

linkingStrategy
object

Strategy for linking this persona to products/offerings

  • Option 1
  • Option 2

Response

Persona created successfully

_metadata
object
required
data
object
required
I