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": {
    "requestId": "requestId",
    "timestamp": "2021-01-01T00:00:00.000Z",
    "usage": 0,
    "message": "message"
  },
  "data": {
    "oId": "p_1234",
    "createdAt": "2021-01-01",
    "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>"
          ]
        }
      ]
    },
    "user": {
      "oId": "u_1234",
      "firstName": "John",
      "lastName": "Doe"
    },
    "workspace": {
      "oId": "wa_1234"
    },
    "name": "VP of Sales",
    "internalName": "Sally the Sales Leader",
    "description": "<string>",
    "deletedAt": "2021-01-01",
    "archivedAt": "2021-01-01",
    "updatedAt": "2021-01-01",
    "unrecognized": false,
    "rejected": false,
    "active": true,
    "qualifyingQuestions": [
      {
        "question": "<string>",
        "rationale": "<string>",
        "fitType": "GOOD",
        "weight": "MEDIUM",
        "archivedAt": "<string>"
      }
    ]
  }
}

POST

api

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": {
    "requestId": "requestId",
    "timestamp": "2021-01-01T00:00:00.000Z",
    "usage": 0,
    "message": "message"
  },
  "data": {
    "oId": "p_1234",
    "createdAt": "2021-01-01",
    "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>"
          ]
        }
      ]
    },
    "user": {
      "oId": "u_1234",
      "firstName": "John",
      "lastName": "Doe"
    },
    "workspace": {
      "oId": "wa_1234"
    },
    "name": "VP of Sales",
    "internalName": "Sally the Sales Leader",
    "description": "<string>",
    "deletedAt": "2021-01-01",
    "archivedAt": "2021-01-01",
    "updatedAt": "2021-01-01",
    "unrecognized": false,
    "rejected": false,
    "active": true,
    "qualifyingQuestions": [
      {
        "question": "<string>",
        "rationale": "<string>",
        "fitType": "GOOD",
        "weight": "MEDIUM",
        "archivedAt": "<string>"
      }
    ]
  }
}

Authorizations

api_key

string

header

required

Body

application/json

Persona creation input

name

string

required

The external name of the persona

Minimum string 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

Show child attributes

customFields.title

string

required

customFields.value

string[]

required

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 offerings (products/services)

Option 1
Option 2

Show child attributes

linkingStrategy.mode

enum<string>

required

Link to all active offerings in the workspace

Available options:

ALL

Example:

"ALL"

Response

Persona created successfully

_metadata

object

required

Show child attributes

_metadata.requestId

string

required

Request ID

Example:

"requestId"

_metadata.timestamp

string

required

Timestamp

Example:

"2021-01-01T00:00:00.000Z"

_metadata.usage

number

default:0

API usage

Example:

0

_metadata.message

string

Message

Example:

"message"

data

object

required

Show child attributes

data.oId

string

required

The ID of the persona

Minimum string length: 1

Example:

"p_1234"

data.createdAt

string

required

The date and time the persona was created

Example:

"2021-01-01"

data.data

object

required

Show child attributes

data.data.internalName

string | null

The internal name of the persona

data.data.primaryResponsibilities

string[]

The primary responsibilities of the persona

Example:

["Responsibility 1", "Responsibility 2"]

data.data.painPoints

string[]

The pain points of the persona

Example:

["Pain Point 1", "Pain Point 2"]

data.data.keyConcerns

string[]

The key concerns of the persona

Example:

["Concern 1", "Concern 2"]

data.data.keyObjectives

string[]

The key objectives of the persona

Example:

["Objective 1", "Objective 2"]

data.data.commonJobTitles

string[]

The common job titles of the persona

Example:

["Job Title 1", "Job Title 2"]

data.data.whyTheyMatterToUs

string[]

The reasons why the persona matters to us

Example:

["Reason 1", "Reason 2"]

data.data.whyWeMatterToThem

string[]

The reasons why we matter to this type of persona

Example:

["Reason 1", "Reason 2"]

data.data.customFields

object[]

Show child attributes

data.data.customFields.title

string

required

data.data.customFields.value

string[]

required

data.user

object

required

Show child attributes

data.user.oId

string | null

The ID of the user who created the persona

Example:

"u_1234"

data.user.firstName

string | null

The first name of the user who created the persona

Example:

"John"

data.user.lastName

string | null

The last name of the user who created the persona

Example:

"Doe"

data.workspace

object

required

Show child attributes

data.workspace.oId

string | null

The ID of the workspace that the persona belongs to

Example:

"wa_1234"

data.name

string | null

The name of the persona

Example:

"VP of Sales"

data.internalName

string | null

The internal name of the persona

Example:

"Sally the Sales Leader"

data.description

string | null

The description of the persona

data.deletedAt

string | null

The date and time the persona was deleted

Example:

"2021-01-01"

data.archivedAt

string | null

The date and time the persona was archived

Example:

"2021-01-01"

data.updatedAt

string | null

The date and time the persona was updated

Example:

"2021-01-01"

data.unrecognized

boolean | null

Whether the persona is unrecognized

Example:

false

data.rejected

boolean | null

Whether the persona is rejected

Example:

false

data.active

boolean

default:true

Whether the persona is active and can be used

Example:

true

data.qualifyingQuestions

object[] | null

Show child attributes

data.qualifyingQuestions.question

string

required

The question to ask to qualify the entity

data.qualifyingQuestions.rationale

string

required

The rationale for the question as to why it helps qualify

data.qualifyingQuestions.fitType

enum<string>

required

The fit type of the question

Available options:

GOOD,

BAD

Example:

"GOOD"

data.qualifyingQuestions.weight

enum<string>

required

The weight of the question

Available options:

LOW,

MEDIUM,

HIGH,

INSTANT_QUALIFIER,

INSTANT_DISQUALIFIER

Example:

"MEDIUM"

data.qualifyingQuestions.archivedAt

string | null

The date and time the question was archived

Update Persona Generate Personas

⌘I

Agents

Async

Workspace

API Key

Persona

Playbook

Use Case

Reference

Product

Segment

Competitor

Proof Point

Create Persona

Authorizations

Body

Response