Ads · Conversions

Update a conversion action's settings

Updates a conversion action's settings. Fields you leave out keep their current values. Works with Google Ads.

PATCHhttps://api.pozy.ai/v1/ads/conversions/actions/{actionId}

Google WorkspaceupdateConversionAction

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

Path parameters

Name	Type	Notes
`actionId`required	string	Matches `^\d+$`

Request body

application/json, required

accountIdstringrequired
adAccountIdstring
Matches ^\d+$.
customerIdstringdeprecated
Matches ^\d+$.
namestring
1 to 100 characters.
statusstring
One of ENABLED, REMOVED.
defaultValuenumber
At least 0.
alwaysUseDefaultValueboolean
categorystring
One of DEFAULT, PAGE_VIEW, PURCHASE, SIGNUP, DOWNLOAD, ADD_TO_CART, BEGIN_CHECKOUT, SUBSCRIBE_PAID, PHONE_CALL_LEAD, IMPORTED_LEAD, SUBMIT_LEAD_FORM, BOOK_APPOINTMENT, REQUEST_QUOTE, GET_DIRECTIONS, OUTBOUND_CLICK, CONTACT, ENGAGEMENT, STORE_VISIT, STORE_SALE, QUALIFIED_LEAD, CONVERTED_LEAD.
countingTypestring
One of ONE_PER_CLICK, MANY_PER_CLICK.
defaultCurrencystring
Matches ^[A-Z]{3}$.
clickThroughLookbackWindowDaysinteger
1 to 90.
viewThroughLookbackWindowDaysinteger
1 to 30.
primaryForGoalboolean

Example

curl -X PATCH "https://api.pozy.ai/v1/ads/conversions/actions/61612c66812de20faf72cf60" \
  -H "Authorization: Bearer $POZY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "accountId": "696e0b682d0a31188e7a2ba9"
}'

const res = await fetch("https://api.pozy.ai/v1/ads/conversions/actions/61612c66812de20faf72cf60", {
  method: "PATCH",
  headers: {
    Authorization: `Bearer ${process.env.POZY_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    accountId: "696e0b682d0a31188e7a2ba9"
  }),
});
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/actions/61612c66812de20faf72cf60",
    headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
    json={
        "accountId": "696e0b682d0a31188e7a2ba9",
    },
    timeout=30,
)
resp.raise_for_status()
print(resp.json())

Response

200 on success

customerIdstring
actionobject
11 child fields
- idstring
- namestring
- statusstring
- primaryForGoalboolean
- categorystring
- countingTypestring
- defaultValuenumber
- defaultCurrencystring
- alwaysUseDefaultValueboolean
- clickThroughLookbackWindowDaysinteger
- viewThroughLookbackWindowDaysinteger

200 response

{
  "customerId": "691909ff82eb5ed7c816716d",
  "action": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "name": "Acme",
    "status": "active",
    "primaryForGoal": true,
    "category": "string",
    "countingType": "string",
    "defaultValue": 12.5,
    "defaultCurrency": "string",
    "alwaysUseDefaultValue": true,
    "clickThroughLookbackWindowDays": 1,
    "viewThroughLookbackWindowDays": 1
  }
}

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.
404	not_found	Nothing with that id exists in your workspace.
429	rate_limit_error	Too many requests this minute. Wait for `Retry-After` seconds.

Every code is listed in Errors.