Create a conversion destination (POST /v1/accounts/{accountId}/conversion-destinations)

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
`accountId`required	string

Request body

application/json, required

adAccountIdstringrequired
namestringrequired
Up to 255 characters.
typestringrequired
attributionTypestring
One of LAST_TOUCH_BY_CAMPAIGN, LAST_TOUCH_BY_CONVERSION.
postClickAttributionWindowSizeinteger
One of 1, 7, 30, 90, 365.
viewThroughAttributionWindowSizeinteger
One of 1, 7, 30, 90, 365.
valueTypestring
One of DYNAMIC, FIXED, NO_VALUE.
valueobject
- currencyCodestringrequired
  3 to 3 characters.
- amountstringrequired
autoAssociationTypestring
One of ALL_CAMPAIGNS, OBJECTIVE_BASED, NONE. Default ALL_CAMPAIGNS.
countingTypestring
One of MANY_PER_CLICK, ONE_PER_CLICK.
primaryForGoalboolean

Example

curl -X POST "https://api.pozy.ai/v1/accounts/696e0b682d0a31188e7a2ba9/conversion-destinations" \
  -H "Authorization: Bearer $POZY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "adAccountId": "666219aad7bab67ace411e4f",
  "name": "Acme",
  "type": "string"
}'

const res = await fetch("https://api.pozy.ai/v1/accounts/696e0b682d0a31188e7a2ba9/conversion-destinations", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.POZY_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    adAccountId: "666219aad7bab67ace411e4f",
    name: "Acme",
    type: "string"
  }),
});
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.post(
    "https://api.pozy.ai/v1/accounts/696e0b682d0a31188e7a2ba9/conversion-destinations",
    headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
    json={
        "adAccountId": "666219aad7bab67ace411e4f",
        "name": "Acme",
        "type": "string",
    },
    timeout=30,
)
resp.raise_for_status()
print(resp.json())

Response

201 on success

platformstring
One of linkedinads, googleads.
destinationobject
- idstringrequired
- namestringrequired
- typestring
- statusstring
  One of active, inactive.
- adAccountIdstring

201 response

{
  "platform": "linkedinads",
  "destination": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "name": "Acme",
    "type": "string",
    "status": "active",
    "adAccountId": "666219aad7bab67ace411e4f"
  }
}

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.