Ads · Conversions

Update account conversion goals

Updates account conversion goals. Fields you leave out keep their current values. Works with Google Ads.

PATCHhttps://api.pozy.ai/v1/ads/conversions/goals

Google WorkspaceupdateAdConversionGoals

Request

Send your API key as Authorization: Bearer pz_live_.... Read-only keys cannot call it. Keys with the ads resource group disabled get 403 resource_group_disabled. Authentication

Request body

application/json, required

accountIdstringrequired
adAccountIdstring
Matches ^\d+$.
customerIdstringdeprecated
Matches ^\d+$.
goalsarray of objectrequired
At least 1 item. Up to 100 items.
- categorystringrequired
  Matches ^[A-Z][A-Z0-9_]*$.
- originstringrequired
  Matches ^[A-Z][A-Z0-9_]*$.
- biddablebooleanrequired

Example

curl -X PATCH "https://api.pozy.ai/v1/ads/conversions/goals" \
  -H "Authorization: Bearer $POZY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "accountId": "696e0b682d0a31188e7a2ba9",
  "goals": [
    {
      "category": "string",
      "origin": "string",
      "biddable": true
    }
  ]
}'

const res = await fetch("https://api.pozy.ai/v1/ads/conversions/goals", {
  method: "PATCH",
  headers: {
    Authorization: `Bearer ${process.env.POZY_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    accountId: "696e0b682d0a31188e7a2ba9",
    goals: [
      {
        category: "string",
        origin: "string",
        biddable: true
      }
    ]
  }),
});
const data = await res.json();
if (!res.ok) throw new Error(data?.error ?? `Request failed with status ${res.status}`);
console.log(data);

import os
import requests

resp = requests.patch(
    "https://api.pozy.ai/v1/ads/conversions/goals",
    headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
    json={
        "accountId": "696e0b682d0a31188e7a2ba9",
        "goals": [
            {
                "category": "string",
                "origin": "string",
                "biddable": True,
            },
        ],
    },
    timeout=30,
)
resp.raise_for_status()
print(resp.json())

Response

200 on success

customerIdstring
goalsarray of object
- categorystring
- originstring
- biddableboolean
- resourceNamestring
- conversionActionsarray of object
  4 child fields
  - idstring
  - namestring
  - statusstring
  - primaryForGoalboolean

200 response

{
  "customerId": "691909ff82eb5ed7c816716d",
  "goals": [
    {
      "category": "string",
      "origin": "string",
      "biddable": true,
      "resourceName": "Acme",
      "conversionActions": [
        {
          "id": "6bfebd43ddc270f6d2c56fc5",
          "name": "Acme",
          "status": "active",
          "primaryForGoal": true
        }
      ]
    }
  ]
}

Errors

Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:

400	invalid_request_error	A parameter or body field is missing or invalid. `param` names it.
401	authentication_error	The API key is missing, revoked or expired.
403	permission_error	The key is read-only, scoped to other profiles, or has this resource group disabled.
429	rate_limit_error	Too many requests this minute. Wait for `Retry-After` seconds.

Every code is listed in Errors.

Request

Request body

Example

Response

Errors

More in Conversions