Skip to main content
POST
/
api
/
v2
/
use-case
/
create
Create Use Case
curl --request POST \
  --url https://app.octavehq.com/api/v2/use-case/create \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '{
  "name": "Lead Generation",
  "internalName": "Lead Gen Process",
  "description": "Automated lead generation and qualification process",
  "primaryUrl": "https://www.example.com/lead-generation",
  "summary": "Streamlined lead capture and qualification",
  "scenarios": [
    "New prospect visits website",
    "Existing customer referral"
  ],
  "desiredOutcomes": [
    "Qualified leads",
    "Reduced manual work",
    "Higher conversion"
  ],
  "businessDrivers": [
    "Need to scale sales",
    "Reduce acquisition costs"
  ],
  "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": "uc_1234",
    "createdAt": "2021-01-01",
    "updatedAt": "2021-01-01",
    "deletedAt": "2021-01-01",
    "archivedAt": "2021-01-01",
    "name": "Use Case Name",
    "internalName": "Use Case Internal Name",
    "description": "Use Case Description",
    "primaryUrl": "https://www.use-case.com",
    "active": true,
    "data": {
      "summary": "<string>",
      "scenarios": [
        "<string>"
      ],
      "desiredOutcomes": [
        "<string>"
      ],
      "businessDrivers": [
        "<string>"
      ],
      "customFields": [
        {
          "title": "<string>",
          "value": [
            "<string>"
          ]
        }
      ]
    },
    "user": {
      "oId": "<string>",
      "firstName": "John",
      "lastName": "Doe"
    },
    "workspace": {
      "oId": "<string>"
    },
    "scenarios": [
      "<string>"
    ],
    "desiredOutcomes": [
      "<string>"
    ]
  }
}

Authorizations

api_key
string
header
required

Body

application/json

Use case creation input

name
string
required

The name of the use case

Minimum length: 1
Example:

"Lead Generation"

internalName
string

The internal name of the use case

Example:

"Lead Gen Process"

description
string

A description of the use case

Example:

"Automated lead generation and qualification process"

primaryUrl
string<uri>

The primary URL of the use case

Example:

"https://www.example.com/lead-generation"

summary
string

A brief summary of the use case

Example:

"Streamlined lead capture and qualification"

scenarios
string[]

Different scenarios where this use case applies

Example:
[
"New prospect visits website",
"Existing customer referral"
]
desiredOutcomes
string[]

The desired outcomes from this use case

Example:
[
"Qualified leads",
"Reduced manual work",
"Higher conversion"
]
businessDrivers
string[]

Business drivers that motivate this use case

Example:
[
"Need to scale sales",
"Reduce acquisition costs"
]
customFields
object[]

Custom fields for additional use case 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 Strategy for linking this use case to products/offerings

  • Option 1
  • Option 2

Response

Use case created successfully

_metadata
object
required
data
object
required
I