Skip to main content
POST
/
api
/
v2
/
buying-trigger
/
update
Update Buying Trigger
curl --request POST \
  --url https://app.octavehq.com/api/v2/buying-trigger/update \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "oId": "btr_1234",
  "name": "<string>",
  "internalName": "<string>",
  "description": "<string>",
  "whyThisCreatesUrgency": [
    "<string>"
  ],
  "whoFeelsThisMost": [
    "<string>"
  ],
  "costOfInaction": [
    "<string>"
  ],
  "howWeHelpInThisMoment": [
    "<string>"
  ],
  "customFields": [
    {
      "title": "<string>",
      "value": [
        "<string>"
      ]
    }
  ]
}
'
import requests

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

payload = {
"oId": "btr_1234",
"name": "<string>",
"internalName": "<string>",
"description": "<string>",
"whyThisCreatesUrgency": ["<string>"],
"whoFeelsThisMost": ["<string>"],
"costOfInaction": ["<string>"],
"howWeHelpInThisMoment": ["<string>"],
"customFields": [
{
"title": "<string>",
"value": ["<string>"]
}
]
}
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({
oId: 'btr_1234',
name: '<string>',
internalName: '<string>',
description: '<string>',
whyThisCreatesUrgency: ['<string>'],
whoFeelsThisMost: ['<string>'],
costOfInaction: ['<string>'],
howWeHelpInThisMoment: ['<string>'],
customFields: [{title: '<string>', value: ['<string>']}]
})
};

fetch('https://app.octavehq.com/api/v2/buying-trigger/update', 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/update",
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([
'oId' => 'btr_1234',
'name' => '<string>',
'internalName' => '<string>',
'description' => '<string>',
'whyThisCreatesUrgency' => [
'<string>'
],
'whoFeelsThisMost' => [
'<string>'
],
'costOfInaction' => [
'<string>'
],
'howWeHelpInThisMoment' => [
'<string>'
],
'customFields' => [
[
'title' => '<string>',
'value' => [
'<string>'
]
]
]
]),
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/update"

payload := strings.NewReader("{\n \"oId\": \"btr_1234\",\n \"name\": \"<string>\",\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}")

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/update")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"oId\": \"btr_1234\",\n \"name\": \"<string>\",\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}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://app.octavehq.com/api/v2/buying-trigger/update")

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 \"oId\": \"btr_1234\",\n \"name\": \"<string>\",\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}"

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>"
}
{
"_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 update input

oId
string
required

The ID of the buying trigger to update

Minimum string length: 1
Example:

"btr_1234"

name
string

The name of the buying trigger

internalName
string

The internal name of the buying trigger

description
string

A description of the buying trigger

whyThisCreatesUrgency
string[]
whoFeelsThisMost
string[]
costOfInaction
string[]
howWeHelpInThisMoment
string[]
customFields
object[]

Custom fields for additional buying trigger information

Response

Buying trigger updated successfully

_metadata
object
required
data
object
required