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"
],
"strategicImpact": [
"Increased revenue growth",
"Improved market positioning"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
],
"additionalProperties": {
"tier": "Enterprise",
"region": "APAC"
},
"primaryOfferingOId": "o_123456",
"linkingStrategy": {
"mode": "ALL"
}
}
'import requests
url = "https://app.octavehq.com/api/v2/use-case/create"
payload = {
"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"],
"strategicImpact": ["Increased revenue growth", "Improved market positioning"],
"customFields": [
{
"title": "<string>",
"value": ["<string>"]
}
],
"additionalProperties": {
"tier": "Enterprise",
"region": "APAC"
},
"primaryOfferingOId": "o_123456",
"linkingStrategy": { "mode": "ALL" }
}
headers = {
"api_key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {api_key: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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'],
strategicImpact: ['Increased revenue growth', 'Improved market positioning'],
customFields: [{title: '<string>', value: ['<string>']}],
additionalProperties: {tier: 'Enterprise', region: 'APAC'},
primaryOfferingOId: 'o_123456',
linkingStrategy: {mode: 'ALL'}
})
};
fetch('https://app.octavehq.com/api/v2/use-case/create', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.octavehq.com/api/v2/use-case/create",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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'
],
'strategicImpact' => [
'Increased revenue growth',
'Improved market positioning'
],
'customFields' => [
[
'title' => '<string>',
'value' => [
'<string>'
]
]
],
'additionalProperties' => [
'tier' => 'Enterprise',
'region' => 'APAC'
],
'primaryOfferingOId' => 'o_123456',
'linkingStrategy' => [
'mode' => 'ALL'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"api_key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.octavehq.com/api/v2/use-case/create"
payload := strings.NewReader("{\n \"name\": \"Lead Generation\",\n \"internalName\": \"Lead Gen Process\",\n \"description\": \"Automated lead generation and qualification process\",\n \"primaryUrl\": \"https://www.example.com/lead-generation\",\n \"summary\": \"Streamlined lead capture and qualification\",\n \"scenarios\": [\n \"New prospect visits website\",\n \"Existing customer referral\"\n ],\n \"desiredOutcomes\": [\n \"Qualified leads\",\n \"Reduced manual work\",\n \"Higher conversion\"\n ],\n \"businessDrivers\": [\n \"Need to scale sales\",\n \"Reduce acquisition costs\"\n ],\n \"strategicImpact\": [\n \"Increased revenue growth\",\n \"Improved market positioning\"\n ],\n \"customFields\": [\n {\n \"title\": \"<string>\",\n \"value\": [\n \"<string>\"\n ]\n }\n ],\n \"additionalProperties\": {\n \"tier\": \"Enterprise\",\n \"region\": \"APAC\"\n },\n \"primaryOfferingOId\": \"o_123456\",\n \"linkingStrategy\": {\n \"mode\": \"ALL\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("api_key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.octavehq.com/api/v2/use-case/create")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Lead Generation\",\n \"internalName\": \"Lead Gen Process\",\n \"description\": \"Automated lead generation and qualification process\",\n \"primaryUrl\": \"https://www.example.com/lead-generation\",\n \"summary\": \"Streamlined lead capture and qualification\",\n \"scenarios\": [\n \"New prospect visits website\",\n \"Existing customer referral\"\n ],\n \"desiredOutcomes\": [\n \"Qualified leads\",\n \"Reduced manual work\",\n \"Higher conversion\"\n ],\n \"businessDrivers\": [\n \"Need to scale sales\",\n \"Reduce acquisition costs\"\n ],\n \"strategicImpact\": [\n \"Increased revenue growth\",\n \"Improved market positioning\"\n ],\n \"customFields\": [\n {\n \"title\": \"<string>\",\n \"value\": [\n \"<string>\"\n ]\n }\n ],\n \"additionalProperties\": {\n \"tier\": \"Enterprise\",\n \"region\": \"APAC\"\n },\n \"primaryOfferingOId\": \"o_123456\",\n \"linkingStrategy\": {\n \"mode\": \"ALL\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octavehq.com/api/v2/use-case/create")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Lead Generation\",\n \"internalName\": \"Lead Gen Process\",\n \"description\": \"Automated lead generation and qualification process\",\n \"primaryUrl\": \"https://www.example.com/lead-generation\",\n \"summary\": \"Streamlined lead capture and qualification\",\n \"scenarios\": [\n \"New prospect visits website\",\n \"Existing customer referral\"\n ],\n \"desiredOutcomes\": [\n \"Qualified leads\",\n \"Reduced manual work\",\n \"Higher conversion\"\n ],\n \"businessDrivers\": [\n \"Need to scale sales\",\n \"Reduce acquisition costs\"\n ],\n \"strategicImpact\": [\n \"Increased revenue growth\",\n \"Improved market positioning\"\n ],\n \"customFields\": [\n {\n \"title\": \"<string>\",\n \"value\": [\n \"<string>\"\n ]\n }\n ],\n \"additionalProperties\": {\n \"tier\": \"Enterprise\",\n \"region\": \"APAC\"\n },\n \"primaryOfferingOId\": \"o_123456\",\n \"linkingStrategy\": {\n \"mode\": \"ALL\"\n }\n}"
response = http.request(request)
puts response.read_body{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"data": {
"oId": "uc_1234",
"createdAt": "2021-01-01",
"user": {
"oId": "<string>",
"firstName": "John",
"lastName": "Doe"
},
"workspace": {
"oId": "<string>"
},
"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>"
],
"strategicImpact": [
"<string>"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
],
"additionalProperties": {}
},
"scenarios": [
"<string>"
],
"desiredOutcomes": [
"<string>"
]
}
}{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"message": "<string>"
}{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"message": "<string>"
}Use Case
Create Use Case
Create a new use case
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"
],
"strategicImpact": [
"Increased revenue growth",
"Improved market positioning"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
],
"additionalProperties": {
"tier": "Enterprise",
"region": "APAC"
},
"primaryOfferingOId": "o_123456",
"linkingStrategy": {
"mode": "ALL"
}
}
'import requests
url = "https://app.octavehq.com/api/v2/use-case/create"
payload = {
"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"],
"strategicImpact": ["Increased revenue growth", "Improved market positioning"],
"customFields": [
{
"title": "<string>",
"value": ["<string>"]
}
],
"additionalProperties": {
"tier": "Enterprise",
"region": "APAC"
},
"primaryOfferingOId": "o_123456",
"linkingStrategy": { "mode": "ALL" }
}
headers = {
"api_key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {api_key: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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'],
strategicImpact: ['Increased revenue growth', 'Improved market positioning'],
customFields: [{title: '<string>', value: ['<string>']}],
additionalProperties: {tier: 'Enterprise', region: 'APAC'},
primaryOfferingOId: 'o_123456',
linkingStrategy: {mode: 'ALL'}
})
};
fetch('https://app.octavehq.com/api/v2/use-case/create', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.octavehq.com/api/v2/use-case/create",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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'
],
'strategicImpact' => [
'Increased revenue growth',
'Improved market positioning'
],
'customFields' => [
[
'title' => '<string>',
'value' => [
'<string>'
]
]
],
'additionalProperties' => [
'tier' => 'Enterprise',
'region' => 'APAC'
],
'primaryOfferingOId' => 'o_123456',
'linkingStrategy' => [
'mode' => 'ALL'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"api_key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.octavehq.com/api/v2/use-case/create"
payload := strings.NewReader("{\n \"name\": \"Lead Generation\",\n \"internalName\": \"Lead Gen Process\",\n \"description\": \"Automated lead generation and qualification process\",\n \"primaryUrl\": \"https://www.example.com/lead-generation\",\n \"summary\": \"Streamlined lead capture and qualification\",\n \"scenarios\": [\n \"New prospect visits website\",\n \"Existing customer referral\"\n ],\n \"desiredOutcomes\": [\n \"Qualified leads\",\n \"Reduced manual work\",\n \"Higher conversion\"\n ],\n \"businessDrivers\": [\n \"Need to scale sales\",\n \"Reduce acquisition costs\"\n ],\n \"strategicImpact\": [\n \"Increased revenue growth\",\n \"Improved market positioning\"\n ],\n \"customFields\": [\n {\n \"title\": \"<string>\",\n \"value\": [\n \"<string>\"\n ]\n }\n ],\n \"additionalProperties\": {\n \"tier\": \"Enterprise\",\n \"region\": \"APAC\"\n },\n \"primaryOfferingOId\": \"o_123456\",\n \"linkingStrategy\": {\n \"mode\": \"ALL\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("api_key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.octavehq.com/api/v2/use-case/create")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Lead Generation\",\n \"internalName\": \"Lead Gen Process\",\n \"description\": \"Automated lead generation and qualification process\",\n \"primaryUrl\": \"https://www.example.com/lead-generation\",\n \"summary\": \"Streamlined lead capture and qualification\",\n \"scenarios\": [\n \"New prospect visits website\",\n \"Existing customer referral\"\n ],\n \"desiredOutcomes\": [\n \"Qualified leads\",\n \"Reduced manual work\",\n \"Higher conversion\"\n ],\n \"businessDrivers\": [\n \"Need to scale sales\",\n \"Reduce acquisition costs\"\n ],\n \"strategicImpact\": [\n \"Increased revenue growth\",\n \"Improved market positioning\"\n ],\n \"customFields\": [\n {\n \"title\": \"<string>\",\n \"value\": [\n \"<string>\"\n ]\n }\n ],\n \"additionalProperties\": {\n \"tier\": \"Enterprise\",\n \"region\": \"APAC\"\n },\n \"primaryOfferingOId\": \"o_123456\",\n \"linkingStrategy\": {\n \"mode\": \"ALL\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octavehq.com/api/v2/use-case/create")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Lead Generation\",\n \"internalName\": \"Lead Gen Process\",\n \"description\": \"Automated lead generation and qualification process\",\n \"primaryUrl\": \"https://www.example.com/lead-generation\",\n \"summary\": \"Streamlined lead capture and qualification\",\n \"scenarios\": [\n \"New prospect visits website\",\n \"Existing customer referral\"\n ],\n \"desiredOutcomes\": [\n \"Qualified leads\",\n \"Reduced manual work\",\n \"Higher conversion\"\n ],\n \"businessDrivers\": [\n \"Need to scale sales\",\n \"Reduce acquisition costs\"\n ],\n \"strategicImpact\": [\n \"Increased revenue growth\",\n \"Improved market positioning\"\n ],\n \"customFields\": [\n {\n \"title\": \"<string>\",\n \"value\": [\n \"<string>\"\n ]\n }\n ],\n \"additionalProperties\": {\n \"tier\": \"Enterprise\",\n \"region\": \"APAC\"\n },\n \"primaryOfferingOId\": \"o_123456\",\n \"linkingStrategy\": {\n \"mode\": \"ALL\"\n }\n}"
response = http.request(request)
puts response.read_body{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"data": {
"oId": "uc_1234",
"createdAt": "2021-01-01",
"user": {
"oId": "<string>",
"firstName": "John",
"lastName": "Doe"
},
"workspace": {
"oId": "<string>"
},
"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>"
],
"strategicImpact": [
"<string>"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
],
"additionalProperties": {}
},
"scenarios": [
"<string>"
],
"desiredOutcomes": [
"<string>"
]
}
}{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"message": "<string>"
}{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"message": "<string>"
}Authorizations
Body
application/json
Use case creation input
The name of the use case
Minimum string length:
1Example:
"Lead Generation"
The internal name of the use case
Example:
"Lead Gen Process"
A description of the use case
Example:
"Automated lead generation and qualification process"
The primary URL of the use case
Example:
"https://www.example.com/lead-generation"
A brief summary of the use case
Example:
"Streamlined lead capture and qualification"
Different scenarios where this use case applies
Example:
[
"New prospect visits website",
"Existing customer referral"
]
The desired outcomes from this use case
Example:
[
"Qualified leads",
"Reduced manual work",
"Higher conversion"
]
Business drivers that motivate this use case
Example:
[
"Need to scale sales",
"Reduce acquisition costs"
]
The strategic, business-level benefit realized when this use case is solved well: quantifiable impact on revenue, cost, risk, and/or efficiency, and the broader value to the company.
Example:
[
"Increased revenue growth",
"Improved market positioning"
]
Custom fields for additional use case information
Show child attributes
Show child attributes
Workspace-defined additional property values for this use case, keyed by property key.
Show child attributes
Show child attributes
Example:
{ "tier": "Enterprise", "region": "APAC" }
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"
Strategy for linking this use case to offerings (products/services)
- Option 1
- Option 2
Show child attributes
Show child attributes
⌘I