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": "px_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",
  "distinctCapabilities": [
    "Email automation",
    "Lead scoring",
    "Campaign analytics"
  ],
  "keyFeatures": [
    "Smart Send Time",
    "Predictive Lead Scoring",
    "Journey Builder"
  ],
  "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>"
      ]
    }
  ],
  "additionalProperties": {
    "tier": "Enterprise",
    "region": "APAC"
  }
}
'

import requests

url = "https://app.octavehq.com/api/v2/product/update"

payload = {
    "oId": "px_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",
    "distinctCapabilities": ["Email automation", "Lead scoring", "Campaign analytics"],
    "keyFeatures": ["Smart Send Time", "Predictive Lead Scoring", "Journey Builder"],
    "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>"]
        }
    ],
    "additionalProperties": {
        "tier": "Enterprise",
        "region": "APAC"
    }
}
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: 'px_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',
    distinctCapabilities: ['Email automation', 'Lead scoring', 'Campaign analytics'],
    keyFeatures: ['Smart Send Time', 'Predictive Lead Scoring', 'Journey Builder'],
    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>']}],
    additionalProperties: {tier: 'Enterprise', region: 'APAC'}
  })
};

fetch('https://app.octavehq.com/api/v2/product/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/product/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' => 'px_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',
    'distinctCapabilities' => [
        'Email automation',
        'Lead scoring',
        'Campaign analytics'
    ],
    'keyFeatures' => [
        'Smart Send Time',
        'Predictive Lead Scoring',
        'Journey Builder'
    ],
    '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>'
                ]
        ]
    ],
    'additionalProperties' => [
        'tier' => 'Enterprise',
        'region' => 'APAC'
    ]
  ]),
  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/product/update"

	payload := strings.NewReader("{\n  \"oId\": \"px_1234\",\n  \"name\": \"Marketing Automation Platform\",\n  \"internalName\": \"MAP Product\",\n  \"description\": \"A comprehensive marketing automation solution for businesses\",\n  \"primaryUrl\": \"https://www.product.com\",\n  \"type\": \"PRODUCT\",\n  \"summary\": \"Enterprise-grade marketing automation\",\n  \"distinctCapabilities\": [\n    \"Email automation\",\n    \"Lead scoring\",\n    \"Campaign analytics\"\n  ],\n  \"keyFeatures\": [\n    \"Smart Send Time\",\n    \"Predictive Lead Scoring\",\n    \"Journey Builder\"\n  ],\n  \"differentiatedValue\": [\n    \"AI-powered personalization\",\n    \"Advanced segmentation\"\n  ],\n  \"statusQuo\": [\n    \"Manual email campaigns\",\n    \"Generic messaging\"\n  ],\n  \"challengesAddressed\": [\n    \"Low email engagement\",\n    \"Poor lead qualification\"\n  ],\n  \"customerBenefits\": [\n    \"Increased conversion rates\",\n    \"Time savings\"\n  ],\n  \"customFields\": [\n    {\n      \"title\": \"<string>\",\n      \"value\": [\n        \"<string>\"\n      ]\n    }\n  ],\n  \"additionalProperties\": {\n    \"tier\": \"Enterprise\",\n    \"region\": \"APAC\"\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/product/update")
  .header("api_key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"oId\": \"px_1234\",\n  \"name\": \"Marketing Automation Platform\",\n  \"internalName\": \"MAP Product\",\n  \"description\": \"A comprehensive marketing automation solution for businesses\",\n  \"primaryUrl\": \"https://www.product.com\",\n  \"type\": \"PRODUCT\",\n  \"summary\": \"Enterprise-grade marketing automation\",\n  \"distinctCapabilities\": [\n    \"Email automation\",\n    \"Lead scoring\",\n    \"Campaign analytics\"\n  ],\n  \"keyFeatures\": [\n    \"Smart Send Time\",\n    \"Predictive Lead Scoring\",\n    \"Journey Builder\"\n  ],\n  \"differentiatedValue\": [\n    \"AI-powered personalization\",\n    \"Advanced segmentation\"\n  ],\n  \"statusQuo\": [\n    \"Manual email campaigns\",\n    \"Generic messaging\"\n  ],\n  \"challengesAddressed\": [\n    \"Low email engagement\",\n    \"Poor lead qualification\"\n  ],\n  \"customerBenefits\": [\n    \"Increased conversion rates\",\n    \"Time savings\"\n  ],\n  \"customFields\": [\n    {\n      \"title\": \"<string>\",\n      \"value\": [\n        \"<string>\"\n      ]\n    }\n  ],\n  \"additionalProperties\": {\n    \"tier\": \"Enterprise\",\n    \"region\": \"APAC\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.octavehq.com/api/v2/product/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\": \"px_1234\",\n  \"name\": \"Marketing Automation Platform\",\n  \"internalName\": \"MAP Product\",\n  \"description\": \"A comprehensive marketing automation solution for businesses\",\n  \"primaryUrl\": \"https://www.product.com\",\n  \"type\": \"PRODUCT\",\n  \"summary\": \"Enterprise-grade marketing automation\",\n  \"distinctCapabilities\": [\n    \"Email automation\",\n    \"Lead scoring\",\n    \"Campaign analytics\"\n  ],\n  \"keyFeatures\": [\n    \"Smart Send Time\",\n    \"Predictive Lead Scoring\",\n    \"Journey Builder\"\n  ],\n  \"differentiatedValue\": [\n    \"AI-powered personalization\",\n    \"Advanced segmentation\"\n  ],\n  \"statusQuo\": [\n    \"Manual email campaigns\",\n    \"Generic messaging\"\n  ],\n  \"challengesAddressed\": [\n    \"Low email engagement\",\n    \"Poor lead qualification\"\n  ],\n  \"customerBenefits\": [\n    \"Increased conversion rates\",\n    \"Time savings\"\n  ],\n  \"customFields\": [\n    {\n      \"title\": \"<string>\",\n      \"value\": [\n        \"<string>\"\n      ]\n    }\n  ],\n  \"additionalProperties\": {\n    \"tier\": \"Enterprise\",\n    \"region\": \"APAC\"\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": "p_1234",
    "createdAt": "2021-01-01",
    "data": {
      "type": "PRODUCT",
      "internalName": "<string>",
      "summary": "<string>",
      "distinctCapabilities": [
        "Capability 1",
        "Capability 2"
      ],
      "keyFeatures": [
        "Feature 1",
        "Feature 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>"
          ]
        }
      ],
      "additionalProperties": {}
    },
    "user": {
      "oId": "u_1234",
      "firstName": "John",
      "lastName": "Doe"
    },
    "workspace": {
      "oId": "wa_1234"
    },
    "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,
    "qualifyingQuestions": [
      {
        "question": "<string>",
        "rationale": "<string>",
        "fitType": "GOOD",
        "weight": "MEDIUM",
        "archivedAt": "2023-11-07T05:31:56Z"
      }
    ]
  }
}

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

POST

api

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": "px_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",
  "distinctCapabilities": [
    "Email automation",
    "Lead scoring",
    "Campaign analytics"
  ],
  "keyFeatures": [
    "Smart Send Time",
    "Predictive Lead Scoring",
    "Journey Builder"
  ],
  "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>"
      ]
    }
  ],
  "additionalProperties": {
    "tier": "Enterprise",
    "region": "APAC"
  }
}
'

import requests

url = "https://app.octavehq.com/api/v2/product/update"

payload = {
    "oId": "px_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",
    "distinctCapabilities": ["Email automation", "Lead scoring", "Campaign analytics"],
    "keyFeatures": ["Smart Send Time", "Predictive Lead Scoring", "Journey Builder"],
    "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>"]
        }
    ],
    "additionalProperties": {
        "tier": "Enterprise",
        "region": "APAC"
    }
}
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: 'px_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',
    distinctCapabilities: ['Email automation', 'Lead scoring', 'Campaign analytics'],
    keyFeatures: ['Smart Send Time', 'Predictive Lead Scoring', 'Journey Builder'],
    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>']}],
    additionalProperties: {tier: 'Enterprise', region: 'APAC'}
  })
};

fetch('https://app.octavehq.com/api/v2/product/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/product/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' => 'px_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',
    'distinctCapabilities' => [
        'Email automation',
        'Lead scoring',
        'Campaign analytics'
    ],
    'keyFeatures' => [
        'Smart Send Time',
        'Predictive Lead Scoring',
        'Journey Builder'
    ],
    '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>'
                ]
        ]
    ],
    'additionalProperties' => [
        'tier' => 'Enterprise',
        'region' => 'APAC'
    ]
  ]),
  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/product/update"

	payload := strings.NewReader("{\n  \"oId\": \"px_1234\",\n  \"name\": \"Marketing Automation Platform\",\n  \"internalName\": \"MAP Product\",\n  \"description\": \"A comprehensive marketing automation solution for businesses\",\n  \"primaryUrl\": \"https://www.product.com\",\n  \"type\": \"PRODUCT\",\n  \"summary\": \"Enterprise-grade marketing automation\",\n  \"distinctCapabilities\": [\n    \"Email automation\",\n    \"Lead scoring\",\n    \"Campaign analytics\"\n  ],\n  \"keyFeatures\": [\n    \"Smart Send Time\",\n    \"Predictive Lead Scoring\",\n    \"Journey Builder\"\n  ],\n  \"differentiatedValue\": [\n    \"AI-powered personalization\",\n    \"Advanced segmentation\"\n  ],\n  \"statusQuo\": [\n    \"Manual email campaigns\",\n    \"Generic messaging\"\n  ],\n  \"challengesAddressed\": [\n    \"Low email engagement\",\n    \"Poor lead qualification\"\n  ],\n  \"customerBenefits\": [\n    \"Increased conversion rates\",\n    \"Time savings\"\n  ],\n  \"customFields\": [\n    {\n      \"title\": \"<string>\",\n      \"value\": [\n        \"<string>\"\n      ]\n    }\n  ],\n  \"additionalProperties\": {\n    \"tier\": \"Enterprise\",\n    \"region\": \"APAC\"\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/product/update")
  .header("api_key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"oId\": \"px_1234\",\n  \"name\": \"Marketing Automation Platform\",\n  \"internalName\": \"MAP Product\",\n  \"description\": \"A comprehensive marketing automation solution for businesses\",\n  \"primaryUrl\": \"https://www.product.com\",\n  \"type\": \"PRODUCT\",\n  \"summary\": \"Enterprise-grade marketing automation\",\n  \"distinctCapabilities\": [\n    \"Email automation\",\n    \"Lead scoring\",\n    \"Campaign analytics\"\n  ],\n  \"keyFeatures\": [\n    \"Smart Send Time\",\n    \"Predictive Lead Scoring\",\n    \"Journey Builder\"\n  ],\n  \"differentiatedValue\": [\n    \"AI-powered personalization\",\n    \"Advanced segmentation\"\n  ],\n  \"statusQuo\": [\n    \"Manual email campaigns\",\n    \"Generic messaging\"\n  ],\n  \"challengesAddressed\": [\n    \"Low email engagement\",\n    \"Poor lead qualification\"\n  ],\n  \"customerBenefits\": [\n    \"Increased conversion rates\",\n    \"Time savings\"\n  ],\n  \"customFields\": [\n    {\n      \"title\": \"<string>\",\n      \"value\": [\n        \"<string>\"\n      ]\n    }\n  ],\n  \"additionalProperties\": {\n    \"tier\": \"Enterprise\",\n    \"region\": \"APAC\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.octavehq.com/api/v2/product/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\": \"px_1234\",\n  \"name\": \"Marketing Automation Platform\",\n  \"internalName\": \"MAP Product\",\n  \"description\": \"A comprehensive marketing automation solution for businesses\",\n  \"primaryUrl\": \"https://www.product.com\",\n  \"type\": \"PRODUCT\",\n  \"summary\": \"Enterprise-grade marketing automation\",\n  \"distinctCapabilities\": [\n    \"Email automation\",\n    \"Lead scoring\",\n    \"Campaign analytics\"\n  ],\n  \"keyFeatures\": [\n    \"Smart Send Time\",\n    \"Predictive Lead Scoring\",\n    \"Journey Builder\"\n  ],\n  \"differentiatedValue\": [\n    \"AI-powered personalization\",\n    \"Advanced segmentation\"\n  ],\n  \"statusQuo\": [\n    \"Manual email campaigns\",\n    \"Generic messaging\"\n  ],\n  \"challengesAddressed\": [\n    \"Low email engagement\",\n    \"Poor lead qualification\"\n  ],\n  \"customerBenefits\": [\n    \"Increased conversion rates\",\n    \"Time savings\"\n  ],\n  \"customFields\": [\n    {\n      \"title\": \"<string>\",\n      \"value\": [\n        \"<string>\"\n      ]\n    }\n  ],\n  \"additionalProperties\": {\n    \"tier\": \"Enterprise\",\n    \"region\": \"APAC\"\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": "p_1234",
    "createdAt": "2021-01-01",
    "data": {
      "type": "PRODUCT",
      "internalName": "<string>",
      "summary": "<string>",
      "distinctCapabilities": [
        "Capability 1",
        "Capability 2"
      ],
      "keyFeatures": [
        "Feature 1",
        "Feature 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>"
          ]
        }
      ],
      "additionalProperties": {}
    },
    "user": {
      "oId": "u_1234",
      "firstName": "John",
      "lastName": "Doe"
    },
    "workspace": {
      "oId": "wa_1234"
    },
    "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,
    "qualifyingQuestions": [
      {
        "question": "<string>",
        "rationale": "<string>",
        "fitType": "GOOD",
        "weight": "MEDIUM",
        "archivedAt": "2023-11-07T05:31:56Z"
      }
    ]
  }
}

{
  "_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

Product update input

oId

string

required

The ID of the product to update

Minimum string length: 1

Example:

"px_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,

SOLUTION

Example:

"PRODUCT"

summary

string

A brief summary of the product

Example:

"Enterprise-grade marketing automation"

distinctCapabilities

string[]

What the product does at the functional level — outcome-oriented capabilities, not mechanisms (mechanisms live in keyFeatures).

Example:

[
  "Email automation",
  "Lead scoring",
  "Campaign analytics"
]

keyFeatures

string[]

Specific, named, often branded components of the product worth highlighting — the 'how' behind the capabilities.

Example:

[
  "Smart Send Time",
  "Predictive Lead Scoring",
  "Journey Builder"
]

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

Show child attributes

additionalProperties

object

Workspace-defined additional property values for this product, keyed by property key.

Show child attributes

Example:

{ "tier": "Enterprise", "region": "APAC" }

Response

Product updated successfully

_metadata

object

required

Show child attributes

data

object

required

Show child attributes

Agents

Async

Workspace

Research

API Key

Motion

Motion Playbook

Motion ICP

Product

Service

Solution

Segment

Persona

Use Case

Reference

Proof Point

Competitor

Alternative

Buying Trigger

Core Feature

Objection

Brand Voice

Context

Workflow

Events

Findings

Suggestions

Revisions

Insights

Reports

CRM

Resource

Skill

Asset

Workspace Company

Update Product

Authorizations

Body

Response