Skip to main content
POST
/
api
/
v2
/
product
/
update
Update Product
curl --request POST \
  --url https://app.octavehq.com/api/v2/product/update \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '{
  "oId": "prod_1234",
  "name": "Marketing Automation Platform",
  "internalName": "MAP Product",
  "description": "A comprehensive marketing automation solution for businesses",
  "primaryUrl": "https://www.product.com",
  "type": "PRODUCT",
  "summary": "Enterprise-grade marketing automation",
  "capabilities": [
    "Email automation",
    "Lead scoring",
    "Campaign analytics"
  ],
  "differentiatedValue": [
    "AI-powered personalization",
    "Advanced segmentation"
  ],
  "statusQuo": [
    "Manual email campaigns",
    "Generic messaging"
  ],
  "challengesAddressed": [
    "Low email engagement",
    "Poor lead qualification"
  ],
  "customerBenefits": [
    "Increased conversion rates",
    "Time savings"
  ],
  "customFields": [
    {
      "title": "<string>",
      "value": [
        "<string>"
      ]
    }
  ]
}'
{
  "_metadata": {
    "usage": 0,
    "requestId": "requestId",
    "message": "message",
    "timestamp": "2021-01-01T00:00:00.000Z"
  },
  "data": {
    "oId": "p_1234",
    "createdAt": "2021-01-01",
    "updatedAt": "2021-01-01",
    "archivedAt": "2021-01-01",
    "deletedAt": "2021-01-01",
    "name": "Product Name",
    "internalName": "Product Internal Name",
    "description": "Product Description",
    "primaryUrl": "https://www.product.com",
    "active": true,
    "data": {
      "type": "PRODUCT",
      "internalName": "<string>",
      "summary": "<string>",
      "capabilities": [
        "Capability 1",
        "Capability 2"
      ],
      "differentiatedValue": [
        "Differentiated Value 1",
        "Differentiated Value 2"
      ],
      "statusQuo": [
        "Status Quo 1",
        "Status Quo 2"
      ],
      "challengesAddressed": [
        "Challenge 1",
        "Challenge 2"
      ],
      "customerBenefits": [
        "Benefit 1",
        "Benefit 2"
      ],
      "customFields": [
        {
          "title": "<string>",
          "value": [
            "<string>"
          ]
        }
      ]
    },
    "qualifyingQuestions": [
      {
        "question": "<string>",
        "rationale": "<string>",
        "fitType": "GOOD",
        "weight": "MEDIUM",
        "archivedAt": "<string>"
      }
    ],
    "user": {
      "oId": "u_1234",
      "firstName": "John",
      "lastName": "Doe"
    },
    "workspace": {
      "oId": "wa_1234"
    }
  }
}

Authorizations

api_key
string
header
required

Body

application/json

Product update input

oId
string
required

The ID of the product to update

Minimum length: 1
Example:

"prod_1234"

name
string

The external name of the product

Example:

"Marketing Automation Platform"

internalName
string

The internal name of the product

Example:

"MAP Product"

description
string

A description of the product

Example:

"A comprehensive marketing automation solution for businesses"

primaryUrl
string<uri>

The primary URL of the product

Example:

"https://www.product.com"

type
enum<string>

The type of offering

Available options:
PRODUCT,
SERVICE
Example:

"PRODUCT"

summary
string

A brief summary of the product

Example:

"Enterprise-grade marketing automation"

capabilities
string[]

Key capabilities of the product

Example:
[
"Email automation",
"Lead scoring",
"Campaign analytics"
]
differentiatedValue
string[]

The differentiated value of the product

Example:
[
"AI-powered personalization",
"Advanced segmentation"
]
statusQuo
string[]

The current state or status quo that the product addresses

Example:
[
"Manual email campaigns",
"Generic messaging"
]
challengesAddressed
string[]

The challenges addressed by the offering

Example:
[
"Low email engagement",
"Poor lead qualification"
]
customerBenefits
string[]

The customer benefits of the offering

Example:
[
"Increased conversion rates",
"Time savings"
]
customFields
object[]

Custom fields for additional product information

Response

Product updated successfully

_metadata
object
required
data
object
required
I