Skip to main content
POST
/
api
/
v2
/
objection
/
create
Create Objection
curl --request POST \
  --url https://app.octavehq.com/api/v2/objection/create \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "name": "Too expensive for our stage",
  "internalName": "<string>",
  "description": "<string>",
  "underlyingConcern": "<string>",
  "assumptionsAndMisconceptions": [
    "<string>"
  ],
  "areasToProbeAndClarify": [
    "<string>"
  ],
  "reframeAndResponse": [
    "<string>"
  ],
  "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": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "name": "<string>",
    "internalName": "<string>",
    "description": "<string>",
    "deletedAt": "<string>",
    "archivedAt": "<string>",
    "active": true,
    "data": {
      "underlyingConcern": "<string>",
      "assumptionsAndMisconceptions": [
        "<string>"
      ],
      "areasToProbeAndClarify": [
        "<string>"
      ],
      "reframeAndResponse": [
        "<string>"
      ],
      "customFields": [
        {
          "title": "<string>",
          "value": [
            "<string>"
          ]
        }
      ]
    },
    "user": {
      "oId": "<string>",
      "firstName": "John",
      "lastName": "Doe"
    },
    "workspace": {
      "oId": "<string>"
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.octavehq.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

api_key
string
header
required

Body

application/json

Objection creation input

name
string
required

External name of the objection

Minimum string length: 1
Example:

"Too expensive for our stage"

internalName
string

Internal name of the objection

description
string

Description of the objection

underlyingConcern
string

What the buyer is really worried about

assumptionsAndMisconceptions
string[]

Mistaken beliefs to address (bullet strings)

areasToProbeAndClarify
string[]

Discovery questions or topics to clarify

reframeAndResponse
string[]

How to reframe and respond (bullet strings)

customFields
object[]

Custom fields

primaryOfferingOId
string

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

Example:

"o_123456"

linkingStrategy
object

Strategy for linking this objection to offerings (products/services/solutions)

Response

Objection created successfully

_metadata
object
required
data
object
required