Save ChatGPT Ads (OpenAI Conversions API) destination
Creates or updates the property's ChatGPT Ads (OpenAI Conversions API) destination, so its purchases are also sent to ChatGPT Ads.
PUT /companies/{companyId}/properties/{propertyId}/destinations/openai
Scope setup · Access Changes data · Operation id destinations.set_openai
Try it
productmetrics runs after productmetrics login; curl needs PM_TOKEN (see Authentication). Set $COMPANY_ID, $PROPERTY_ID first.
productmetrics destinations set-openai \
--company-id $COMPANY_ID \
--property-id $PROPERTY_ID \
--pixel-id 6f1c2a7e-3b4d-4e8f-9a01-2c3d4e5f6a7b \
--enabled \
--jsonResponse
API response (200), shortened:
{
"data": {
"id": "6f1c2a7e-3b4d-4e8f-9a01-2c3d4e5f6a7b",
"property_id": "8c1f4d2e-7a3b-4c5d-9e6f-0a1b2c3d4e5f",
"property_name": "Example Store",
"pixel_id": "6f1c2a7e-3b4d-4e8f-9a01-2c3d4e5f6a7b",
"token_hint": "…9c2e",
"enabled": true
// … 6 more fields
},
"request_id": "req_01JJXRJ18PNK4GRZDM928P4FQ6"
}CLI output: productmetrics destinations set-openai --json prints { "ok": true, "data": …, "request_id": "…" } with the same data.
Before you call
Needs editor or admin access and a tracked property. pixelId is the ChatGPT Ads pixel id; apiKey is the Conversions API key the person creates in their ChatGPT Ads account. apiKey is required when the destination is created or its pixel changes, and may be left out otherwise. It is a credential: ask the person for it, never invent, guess or reuse one, and never repeat it back. Then call destinations.test_openai to send a test event and destinations.list_openai to read the status.
Path parameters
| Name | Type | Description |
|---|---|---|
companyId | string (uuid) | Your workspace id, from productmetrics whoami or properties.list (company_id). |
propertyId | string (uuid) | The property id, from productmetrics whoami or properties.list (property_id). |
Body
| Name | Type | Required | Description |
|---|---|---|---|
pixelId | string | Yes | The ChatGPT Ads pixel id. |
apiKey | string | No | The Conversions API key the person creates in their ChatGPT Ads account. Required when the destination is created or its pixel changes. 20 to 4096 characters. |
enabled | boolean | Yes | Whether purchases are sent to this ChatGPT Ads destination. |
Errors
A failure answers with its HTTP status and { error: { code, message, details? }, request_id }. Branch on code (stable, lower_snake); show message to the person. The CLI prints the same error with "ok": false.
{
"error": {
"code": "insufficient_scope",
"message": "This operation needs the setup scope; connect again and allow it.",
"details": {
"required_scope": "setup"
}
},
"request_id": "req_01JTVDETBMC4G5YAC814X73EZQ"
}| Status | Code | When |
|---|---|---|
| 400 | invalid_request | A path, query or body value does not match this page. details.issues lists each location, path and message. |
| 401 | invalid_token | The token is missing, expired or revoked: sign in again (productmetrics login). The WWW-Authenticate header says why. |
| 403 | insufficient_scope | The token lacks the setup scope (details.required_scope): sign in again and allow it. |
| 404 | not_found | An id in the path does not exist, or the signed-in person cannot open it. |
| 429 | rate_limited | More than 600 requests a minute for this person: wait the Retry-After seconds (60) and retry. |