Skip to main content
POST
/
api
/
v2
/
buying-trigger
/
create
Create Buying Trigger
curl --request POST \
  --url https://app.octavehq.com/api/v2/buying-trigger/create \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "name": "New CIO cloud mandate",
  "internalName": "<string>",
  "description": "<string>",
  "whyThisCreatesUrgency": [
    "<string>"
  ],
  "whoFeelsThisMost": [
    "<string>"
  ],
  "costOfInaction": [
    "<string>"
  ],
  "howWeHelpInThisMoment": [
    "<string>"
  ],
  "customFields": [
    {
      "title": "<string>",
      "value": [
        "<string>"
      ]
    }
  ],
  "primaryOfferingOId": "o_123456",
  "linkingStrategy": {
    "mode": "ALL"
  }
}
'
import requests

url = "https://app.octavehq.com/api/v2/buying-trigger/create"

payload = {
    "name": "New CIO cloud mandate",
    "internalName": "<string>",
    "description": "<string>",
    "whyThisCreatesUrgency": ["<string>"],
    "whoFeelsThisMost": ["<string>"],
    "costOfInaction": ["<string>"],
    "howWeHelpInThisMoment": ["<string>"],
    "customFields": [
        {
            "title": "<string>",
            "value": ["<string>"]
        }
    ],
    "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: 'New CIO cloud mandate',
    internalName: '<string>',
    description: '<string>',
    whyThisCreatesUrgency: ['<string>'],
    whoFeelsThisMost: ['<string>'],
    costOfInaction: ['<string>'],
    howWeHelpInThisMoment: ['<string>'],
    customFields: [{title: '<string>', value: ['<string>']}],
    primaryOfferingOId: 'o_123456',
    linkingStrategy: {mode: 'ALL'}
  })
};

fetch('https://app.octavehq.com/api/v2/buying-trigger/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/buying-trigger/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' => 'New CIO cloud mandate',
    'internalName' => '<string>',
    'description' => '<string>',
    'whyThisCreatesUrgency' => [
        '<string>'
    ],
    'whoFeelsThisMost' => [
        '<string>'
    ],
    'costOfInaction' => [
        '<string>'
    ],
    'howWeHelpInThisMoment' => [
        '<string>'
    ],
    'customFields' => [
        [
                'title' => '<string>',
                'value' => [
                                '<string>'
                ]
        ]
    ],
    '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/buying-trigger/create"

	payload := strings.NewReader("{\n  \"name\": \"New CIO cloud mandate\",\n  \"internalName\": \"<string>\",\n  \"description\": \"<string>\",\n  \"whyThisCreatesUrgency\": [\n    \"<string>\"\n  ],\n  \"whoFeelsThisMost\": [\n    \"<string>\"\n  ],\n  \"costOfInaction\": [\n    \"<string>\"\n  ],\n  \"howWeHelpInThisMoment\": [\n    \"<string>\"\n  ],\n  \"customFields\": [\n    {\n      \"title\": \"<string>\",\n      \"value\": [\n        \"<string>\"\n      ]\n    }\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/buying-trigger/create")
  .header("api_key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"New CIO cloud mandate\",\n  \"internalName\": \"<string>\",\n  \"description\": \"<string>\",\n  \"whyThisCreatesUrgency\": [\n    \"<string>\"\n  ],\n  \"whoFeelsThisMost\": [\n    \"<string>\"\n  ],\n  \"costOfInaction\": [\n    \"<string>\"\n  ],\n  \"howWeHelpInThisMoment\": [\n    \"<string>\"\n  ],\n  \"customFields\": [\n    {\n      \"title\": \"<string>\",\n      \"value\": [\n        \"<string>\"\n      ]\n    }\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/buying-trigger/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\": \"New CIO cloud mandate\",\n  \"internalName\": \"<string>\",\n  \"description\": \"<string>\",\n  \"whyThisCreatesUrgency\": [\n    \"<string>\"\n  ],\n  \"whoFeelsThisMost\": [\n    \"<string>\"\n  ],\n  \"costOfInaction\": [\n    \"<string>\"\n  ],\n  \"howWeHelpInThisMoment\": [\n    \"<string>\"\n  ],\n  \"customFields\": [\n    {\n      \"title\": \"<string>\",\n      \"value\": [\n        \"<string>\"\n      ]\n    }\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": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "name": "<string>",
    "internalName": "<string>",
    "description": "<string>",
    "deletedAt": "<string>",
    "archivedAt": "<string>",
    "active": true,
    "data": {
      "whyThisCreatesUrgency": [
        "<string>"
      ],
      "whoFeelsThisMost": [
        "<string>"
      ],
      "costOfInaction": [
        "<string>"
      ],
      "howWeHelpInThisMoment": [
        "<string>"
      ],
      "customFields": [
        {
          "title": "<string>",
          "value": [
            "<string>"
          ]
        }
      ]
    },
    "user": {
      "oId": "<string>",
      "firstName": "John",
      "lastName": "Doe"
    },
    "workspace": {
      "oId": "<string>"
    }
  }
}
{
  "_metadata": {
    "requestId": "requestId",
    "timestamp": "2021-01-01T00:00:00.000Z",
    "usage": 0,
    "message": "message"
  },
  "message": "<string>"
}

Authorizations

​
api_key
string
header
required

Body

application/json

Buying trigger creation input

​
name
string
required

External name of the buying trigger

Minimum string length: 1
Example:

"New CIO cloud mandate"

​
internalName
string

Internal name of the buying trigger

​
description
string

Description of the buying trigger

​
whyThisCreatesUrgency
string[]

Why this moment shifts the buyer from passive to active (one string per bullet)

​
whoFeelsThisMost
string[]

Which organizations and roles feel this trigger most (one string per bullet)

​
costOfInaction
string[]

Consequences of waiting while this trigger is in play (one string per bullet)

​
howWeHelpInThisMoment
string[]

Concrete ways the offering maps to this moment (one string per bullet)

​
customFields
object[]

Custom fields

​
primaryOfferingOId
string

Primary offering for context when creating the entity (optional).

Example:

"o_123456"

​
linkingStrategy
object

Strategy for linking this buying trigger to offerings (products/services)

Response

Buying trigger created successfully

​
_metadata
object
required
​
data
object
required