Ad conversions

Qualified leads, site visits and bookings of ad leads sent back to Meta and Google Ads: settings, test events, the delivery log and objections.

GET/v1/ad-conversions

Ad conversions settings

Milestone rules, the Meta and Google connections with their settings (no secrets) and 30-day counts, the WhatsApp Business Accounts, the platform windows and the privacy-notice line.

Access: Signed-in members only (web or Android session) — not for API keys. Permission settings.integrations or settings.view.

Response · 200

datarequired: AdConversionsOverview
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/ad-conversions' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "milestones": [
      {
        "key": "lead_created",
        "label": "string"
      }
    ],
    "rules": {
      "qualified": {
        "status_keys": [
          "string"
        ],
        "sub_status_keys": [
          "string"
        ]
      },
      "visit_scheduled": {
        "status_keys": [
          "string"
        ],
        "sub_status_keys": [
          "string"
        ]
      },
      "visit_done": {
        "status_keys": [
          "string"
        ],
        "sub_status_keys": [
          "string"
        ]
      },
      "booked": {
        "status_keys": [
          "string"
        ],
        "sub_status_keys": [
          "string"
        ]
      }
    },
    "statuses": [
      {
        "key": "string",
        "name": "string",
        "category": "string",
        "pipeline": "string",
        "sub_statuses": [
          {
            "key": "string",
            "name": "string"
          }
        ]
      }
    ],
    "windows": {},
    "notice_line": "string",
    "meta": {
      "connection": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "provider": "string",
        "connector_key": "string",
        "name": "string",
        "status": "pending",
        "health": "ok",
        "config": {},
        "has_secret": true,
        "secret_hints": {},
        "inbound_url": "string",
        "scopes": [
          "string"
        ],
        "connected_at": "2026-10-06T05:30:00.000Z",
        "connected_by_id": "cmusrceel0000q7kaafxqi1om",
        "last_ok_at": "2026-10-06T05:30:00.000Z",
        "last_error": "string",
        "error_count": 0,
        "created_at": "2026-10-06T05:30:00.000Z",
        "updated_at": "2026-10-06T05:30:00.000Z"
      },
      "settings": {
        "enabled": true,
        "dataset_id": "string",
        "dataset_name": "string",
        "test_event_code": "string",
        "whatsapp_datasets": [
          {
            "waba_id": "string",
            "dataset_id": "string",
            "linked_at": "string"
          }
        ],
        "mapping": {},
        "hashed_identifiers": true,
        "send_client_ip": true,
        "value": "commission"
      },
      "configured": true,
      "counts": {},
      "whatsapp_accounts": [
        {
          "waba_id": "string",
          "name": "string",
          "dataset_id": "string"
        }
      ]
    },
    "google": {
      "available": true,
      "listing": true,
      "connection": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "provider": "string",
        "connector_key": "string",
        "name": "string",
        "status": "pending",
        "health": "ok",
        "config": {},
        "has_secret": true,
        "secret_hints": {},
        "inbound_url": "string",
        "scopes": [
          "string"
        ],
        "connected_at": "2026-10-06T05:30:00.000Z",
        "connected_by_id": "cmusrceel0000q7kaafxqi1om",
        "last_ok_at": "2026-10-06T05:30:00.000Z",
        "last_error": "string",
        "error_count": 0,
        "created_at": "2026-10-06T05:30:00.000Z",
        "updated_at": "2026-10-06T05:30:00.000Z"
      },
      "settings": {
        "enabled": true,
        "customer_id": "string",
        "customer_name": "string",
        "login_customer_id": "string",
        "account_email": "string",
        "mapping": {},
        "enhanced_conversions": true,
        "test_mode": true,
        "value": "commission"
      },
      "configured": true,
      "counts": {}
    }
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/ad-conversions/deliveries

The conversion delivery log

Newest first, keyset-paginated; filter by connection, platform, status, milestone or lead. A year is kept.

Access: Signed-in members only (web or Android session) — not for API keys. Permission settings.integrations or settings.view.

Parameters

connection_idquery: Id
Opaque record id.
platformquery: "meta" | "google"
statusquery: "pending" | "sending" | "sent" | "failed" | "skipped"
milestonequery: "lead_created" | "qualified" | "visit_scheduled" | "visit_done" | "booked" | "test"
lead_idquery: Id
Opaque record id.
cursorquery: string
limitquery: integer

Response · 200

datarequired: array of AdConversionDelivery
metarequired: PageMeta

Request

curl -X GET 'https://api.propzolo.com/v1/ad-conversions/deliveries' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "connection_id": "cmusrceel0000q7kaafxqi1om",
      "platform": "meta",
      "channel": "string",
      "kind": "event",
      "lead_id": "cmusrceel0000q7kaafxqi1om",
      "lead_ref": "string",
      "milestone": "string",
      "milestone_label": "string",
      "event_name": "string",
      "destination": "string",
      "status": "pending",
      "reason": "string",
      "attempts": 0,
      "next_attempt_at": "2026-10-06T05:30:00.000Z",
      "sent_at": "2026-10-06T05:30:00.000Z",
      "event_time": "2026-10-06T05:30:00.000Z",
      "value_paise": 850000000,
      "error": "string",
      "identifiers": [
        "string"
      ],
      "response": {},
      "created_at": "2026-10-06T05:30:00.000Z"
    }
  ],
  "meta": {
    "next_cursor": "string",
    "has_more": true
  }
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/ad-conversions/deliveries/{id}/retry

Send a failed conversion again

Access: Signed-in members only (web or Android session) — not for API keys. Permission settings.integrations.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: AdConversionDelivery
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/ad-conversions/deliveries/{id}/retry' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "connection_id": "cmusrceel0000q7kaafxqi1om",
    "platform": "meta",
    "channel": "string",
    "kind": "event",
    "lead_id": "cmusrceel0000q7kaafxqi1om",
    "lead_ref": "string",
    "milestone": "string",
    "milestone_label": "string",
    "event_name": "string",
    "destination": "string",
    "status": "pending",
    "reason": "string",
    "attempts": 0,
    "next_attempt_at": "2026-10-06T05:30:00.000Z",
    "sent_at": "2026-10-06T05:30:00.000Z",
    "event_time": "2026-10-06T05:30:00.000Z",
    "value_paise": 850000000,
    "error": "string",
    "identifiers": [
      "string"
    ],
    "response": {},
    "created_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/ad-conversions/google/oauth/callback

Google sign-in callback

Always redirects back to Settings → Integrations → Ad conversions with `google=connected` or an error.

Access: Signed-in members only (web or Android session) — not for API keys. Permission settings.integrations.

Parameters

codequery: string
statequery: string
errorquery: string
scopequery: string

Response · 200

datarequired: object
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/ad-conversions/google/oauth/callback' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {},
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/ad-conversions/google/oauth/start

Start the Google sign-in for Ads

Returns Google’s consent URL (or redirects to it with `?redirect=1`). 404 until PropZolo set it up.

Access: Signed-in members only (web or Android session) — not for API keys. Permission settings.integrations.

Parameters

redirectquery: "1"

Response · 200

datarequired: object
data.urlrequired: string
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/ad-conversions/google/oauth/start' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "url": "string"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

PATCH/v1/ad-conversions/google/{id}

Change the Google Ads conversions settings

Access: Signed-in members only (web or Android session) — not for API keys. Permission settings.integrations.

Parameters

idpathrequired: Id
Opaque record id.

Request body

enabled: boolean
customer_id: string or null
customer_name: string or null
login_customer_id: string or null
mapping: map of object
enhanced_conversions: boolean
test_mode: boolean
value: "commission" | "agreed_value" | "none"
What a booking is worth to the ads: the deal’s expected commission, its agreed value, or none.

Response · 200

datarequired: IntegrationConnection
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/ad-conversions/google/{id}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"enabled":true,"customer_id":"string","customer_name":"string","login_customer_id":"string","mapping":{},"enhanced_conversions":true,"test_mode":true,"value":"commission"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "provider": "string",
    "connector_key": "string",
    "name": "string",
    "status": "pending",
    "health": "ok",
    "config": {},
    "has_secret": true,
    "secret_hints": {},
    "inbound_url": "string",
    "scopes": [
      "string"
    ],
    "connected_at": "2026-10-06T05:30:00.000Z",
    "connected_by_id": "cmusrceel0000q7kaafxqi1om",
    "last_ok_at": "2026-10-06T05:30:00.000Z",
    "last_error": "string",
    "error_count": 0,
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/ad-conversions/google/{id}/accounts

Google Ads accounts and conversion actions

The accounts the signed-in Google user reaches and, for `customer_id`, its enabled conversion actions. Needs PropZolo’s Google Ads developer token (409 without it — type the ids instead).

Access: Signed-in members only (web or Android session) — not for API keys. Permission settings.integrations.

Parameters

idpathrequired: Id
Opaque record id.
customer_idquery: string
login_customer_idquery: string

Response · 200

datarequired: object
data.customersrequired: array of string
data.conversion_actionsrequired: array of object
data.conversion_actions[].idrequired: string
data.conversion_actions[].namerequired: string
data.conversion_actions[].typerequired: string
data.conversion_actions[].statusrequired: string
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/ad-conversions/google/{id}/accounts' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "customers": [
      "string"
    ],
    "conversion_actions": [
      {
        "id": "string",
        "name": "string",
        "type": "string",
        "status": "string"
      }
    ]
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/ad-conversions/meta

Connect the Meta Conversions API

Checks the token against the dataset with Meta, then stores the connection — off until switched on. The token comes from Events Manager → the dataset → Settings → Conversions API → Generate access token.

Access: Signed-in members only (web or Android session) — not for API keys. Permission settings.integrations.

Parameters

Idempotency-Keyheader: string
Unique key (a UUID) per logical request. A retry with the same key and body replays the first response for 24 hours (marked Idempotent-Replayed: true); the same key with another body is a 409.

Request body

dataset_idrequired: string
access_tokenrequired: string
test_event_code: string or null

Response · 201

datarequired: IntegrationConnection
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/ad-conversions/meta' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Idempotency-Key: 6c0f1d3e-…' \
  -H 'Content-Type: application/json' \
  -d '{"dataset_id":"string","access_token":"string","test_event_code":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "provider": "string",
    "connector_key": "string",
    "name": "string",
    "status": "pending",
    "health": "ok",
    "config": {},
    "has_secret": true,
    "secret_hints": {},
    "inbound_url": "string",
    "scopes": [
      "string"
    ],
    "connected_at": "2026-10-06T05:30:00.000Z",
    "connected_by_id": "cmusrceel0000q7kaafxqi1om",
    "last_ok_at": "2026-10-06T05:30:00.000Z",
    "last_error": "string",
    "error_count": 0,
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

PATCH/v1/ad-conversions/meta/{id}

Change the Meta Conversions API settings

Switch on / off, the milestone → event mapping, the test code, identifiers, value; a new token is checked.

Access: Signed-in members only (web or Android session) — not for API keys. Permission settings.integrations.

Parameters

idpathrequired: Id
Opaque record id.

Request body

enabled: boolean
dataset_id: string
test_event_code: string or null
mapping: map of object
hashed_identifiers: boolean
send_client_ip: boolean
value: "commission" | "agreed_value" | "none"
What a booking is worth to the ads: the deal’s expected commission, its agreed value, or none.
access_token: string

Response · 200

datarequired: IntegrationConnection
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/ad-conversions/meta/{id}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"enabled":true,"dataset_id":"string","test_event_code":"string","mapping":{},"hashed_identifiers":true,"send_client_ip":true,"value":"commission","access_token":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "provider": "string",
    "connector_key": "string",
    "name": "string",
    "status": "pending",
    "health": "ok",
    "config": {},
    "has_secret": true,
    "secret_hints": {},
    "inbound_url": "string",
    "scopes": [
      "string"
    ],
    "connected_at": "2026-10-06T05:30:00.000Z",
    "connected_by_id": "cmusrceel0000q7kaafxqi1om",
    "last_ok_at": "2026-10-06T05:30:00.000Z",
    "last_error": "string",
    "error_count": 0,
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/ad-conversions/meta/{id}/whatsapp-datasets

Link the datasets of WhatsApp Business Accounts

For Click-to-WhatsApp leads: asks Meta for the dataset of each WhatsApp Business Account (creating one when it has none) with the connection’s token, or stores the dataset ids given.

Access: Signed-in members only (web or Android session) — not for API keys. Permission settings.integrations.

Parameters

idpathrequired: Id
Opaque record id.

Request body

accountsrequired: array of object
accounts[].waba_idrequired: string
accounts[].dataset_id: string or null

Response · 200

datarequired: IntegrationConnection
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/ad-conversions/meta/{id}/whatsapp-datasets' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"accounts":[{"waba_id":"string","dataset_id":"string"}]}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "provider": "string",
    "connector_key": "string",
    "name": "string",
    "status": "pending",
    "health": "ok",
    "config": {},
    "has_secret": true,
    "secret_hints": {},
    "inbound_url": "string",
    "scopes": [
      "string"
    ],
    "connected_at": "2026-10-06T05:30:00.000Z",
    "connected_by_id": "cmusrceel0000q7kaafxqi1om",
    "last_ok_at": "2026-10-06T05:30:00.000Z",
    "last_error": "string",
    "error_count": 0,
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

PUT/v1/ad-conversions/milestones

Set which statuses count as milestones

Access: Signed-in members only (web or Android session) — not for API keys. Permission settings.integrations.

Request body

qualifiedrequired: object
qualified.status_keysrequired: array of string
qualified.sub_status_keysrequired: array of string
visit_scheduledrequired: object
visit_scheduled.status_keysrequired: array of string
visit_scheduled.sub_status_keysrequired: array of string
visit_donerequired: object
visit_done.status_keysrequired: array of string
visit_done.sub_status_keysrequired: array of string
bookedrequired: object
booked.status_keysrequired: array of string
booked.sub_status_keysrequired: array of string

Response · 200

datarequired: AdMilestoneRules
Status and sub-status keys that reach each milestone.
metarequired: object

Request

curl -X PUT 'https://api.propzolo.com/v1/ad-conversions/milestones' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"qualified":{"status_keys":["string"],"sub_status_keys":["string"]},"visit_scheduled":{"status_keys":["string"],"sub_status_keys":["string"]},"visit_done":{"status_keys":["string"],"sub_status_keys":["string"]},"booked":{"status_keys":["string"],"sub_status_keys":["string"]}}'

Response example

{
  "data": {
    "qualified": {
      "status_keys": [
        "string"
      ],
      "sub_status_keys": [
        "string"
      ]
    },
    "visit_scheduled": {
      "status_keys": [
        "string"
      ],
      "sub_status_keys": [
        "string"
      ]
    },
    "visit_done": {
      "status_keys": [
        "string"
      ],
      "sub_status_keys": [
        "string"
      ]
    },
    "booked": {
      "status_keys": [
        "string"
      ],
      "sub_status_keys": [
        "string"
      ]
    }
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/ad-conversions/{id}/retry-failed

Send failed conversions again

Every failed conversion of the connection (up to 500) goes back to the queue with a fresh retry ladder.

Access: Signed-in members only (web or Android session) — not for API keys. Permission settings.integrations.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: object
data.countrequired: integer
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/ad-conversions/{id}/retry-failed' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "count": 0
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/ad-conversions/{id}/test

Send a test conversion

Meta: one CRM Lead event under the test event code (Events Manager → Test events). Google: one conversion validated for the action (nothing recorded). Logged as a test delivery.

Access: Signed-in members only (web or Android session) — not for API keys. Permission settings.integrations.

Parameters

idpathrequired: Id
Opaque record id.

Request body

test_event_code: string or null
action_id: string or null

Response · 200

datarequired: object
data.okrequired: boolean
data.messagerequired: string
data.delivery_idrequired: Id
Opaque record id.
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/ad-conversions/{id}/test' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"test_event_code":"string","action_id":"string"}'

Response example

{
  "data": {
    "ok": true,
    "message": "string",
    "delivery_id": "cmusrceel0000q7kaafxqi1om"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/contacts/{id}/ads-measurement

Whether the person’s ad conversions may be shared

Access: Signed-in members only (web or Android session) — not for API keys. Permission contacts.view.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: AdsMeasurement
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/contacts/{id}/ads-measurement' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "contact_id": "cmusrceel0000q7kaafxqi1om",
    "state": "allowed",
    "decided_at": "2026-10-06T05:30:00.000Z",
    "decided_by": "string"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

PUT/v1/contacts/{id}/ads-measurement

Record or lift an objection to ad measurement

Appends to the consent ledger (purpose `ads_measurement`). An objection stops every conversion still waiting.

Access: Signed-in members only (web or Android session) — not for API keys. Permission contacts.edit.

Parameters

idpathrequired: Id
Opaque record id.

Request body

objectedrequired: boolean
note: string or null

Response · 200

datarequired: AdsMeasurement
metarequired: object

Request

curl -X PUT 'https://api.propzolo.com/v1/contacts/{id}/ads-measurement' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"objected":true,"note":"string"}'

Response example

{
  "data": {
    "contact_id": "cmusrceel0000q7kaafxqi1om",
    "state": "allowed",
    "decided_at": "2026-10-06T05:30:00.000Z",
    "decided_by": "string"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

{ "data": { "milestones": [ { "key": "lead_created", "label": "string" } ], "rules": { "qualified": { "status_keys": [ "string" ], "sub_status_keys": [ "string" ] }, "visit_scheduled": { "status_keys": [ "string" ], "sub_status_keys": [ "string" ] }, "visit_done": { "status_keys": [ "string" ], "sub_status_keys": [ "string" ] }, "booked": { "status_keys": [ "string" ], "sub_status_keys": [ "string" ] } }, "statuses": [ { "key": "string", "name": "string", "category": "string", "pipeline": "string", "sub_statuses": [ { "key": "string", "name": "string" } ] } ], "windows": {}, "notice_line": "string", "meta": { "connection": { "id": "cmusrceel0000q7kaafxqi1om", "provider": "string", "connector_key": "string", "name": "string", "status": "pending", "health": "ok", "config": {}, "has_secret": true, "secret_hints": {}, "inbound_url": "string", "scopes": [ "string" ], "connected_at": "2026-10-06T05:30:00.000Z", "connected_by_id": "cmusrceel0000q7kaafxqi1om", "last_ok_at": "2026-10-06T05:30:00.000Z", "last_error": "string", "error_count": 0, "created_at": "2026-10-06T05:30:00.000Z", "updated_at": "2026-10-06T05:30:00.000Z" }, "settings": { "enabled": true, "dataset_id": "string", "dataset_name": "string", "test_event_code": "string", "whatsapp_datasets": [ { "waba_id": "string", "dataset_id": "string", "linked_at": "string" } ], "mapping": {}, "hashed_identifiers": true, "send_client_ip": true, "value": "commission" }, "configured": true, "counts": {}, "whatsapp_accounts": [ { "waba_id": "string", "name": "string", "dataset_id": "string" } ] }, "google": { "available": true, "listing": true, "connection": { "id": "cmusrceel0000q7kaafxqi1om", "provider": "string", "connector_key": "string", "name": "string", "status": "pending", "health": "ok", "config": {}, "has_secret": true, "secret_hints": {}, "inbound_url": "string", "scopes": [ "string" ], "connected_at": "2026-10-06T05:30:00.000Z", "connected_by_id": "cmusrceel0000q7kaafxqi1om", "last_ok_at": "2026-10-06T05:30:00.000Z", "last_error": "string", "error_count": 0, "created_at": "2026-10-06T05:30:00.000Z", "updated_at": "2026-10-06T05:30:00.000Z" }, "settings": { "enabled": true, "customer_id": "string", "customer_name": "string", "login_customer_id": "string", "account_email": "string", "mapping": {}, "enhanced_conversions": true, "test_mode": true, "value": "commission" }, "configured": true, "counts": {} } }, "meta": {} }

{ "data": [ { "id": "cmusrceel0000q7kaafxqi1om", "connection_id": "cmusrceel0000q7kaafxqi1om", "platform": "meta", "channel": "string", "kind": "event", "lead_id": "cmusrceel0000q7kaafxqi1om", "lead_ref": "string", "milestone": "string", "milestone_label": "string", "event_name": "string", "destination": "string", "status": "pending", "reason": "string", "attempts": 0, "next_attempt_at": "2026-10-06T05:30:00.000Z", "sent_at": "2026-10-06T05:30:00.000Z", "event_time": "2026-10-06T05:30:00.000Z", "value_paise": 850000000, "error": "string", "identifiers": [ "string" ], "response": {}, "created_at": "2026-10-06T05:30:00.000Z" } ], "meta": { "next_cursor": "string", "has_more": true } }

{ "data": { "id": "cmusrceel0000q7kaafxqi1om", "connection_id": "cmusrceel0000q7kaafxqi1om", "platform": "meta", "channel": "string", "kind": "event", "lead_id": "cmusrceel0000q7kaafxqi1om", "lead_ref": "string", "milestone": "string", "milestone_label": "string", "event_name": "string", "destination": "string", "status": "pending", "reason": "string", "attempts": 0, "next_attempt_at": "2026-10-06T05:30:00.000Z", "sent_at": "2026-10-06T05:30:00.000Z", "event_time": "2026-10-06T05:30:00.000Z", "value_paise": 850000000, "error": "string", "identifiers": [ "string" ], "response": {}, "created_at": "2026-10-06T05:30:00.000Z" }, "meta": {} }

curl -X PATCH 'https://api.propzolo.com/v1/ad-conversions/google/{id}' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Content-Type: application/json' \ -d '{"enabled":true,"customer_id":"string","customer_name":"string","login_customer_id":"string","mapping":{},"enhanced_conversions":true,"test_mode":true,"value":"commission"}'

{ "data": { "id": "cmusrceel0000q7kaafxqi1om", "provider": "string", "connector_key": "string", "name": "string", "status": "pending", "health": "ok", "config": {}, "has_secret": true, "secret_hints": {}, "inbound_url": "string", "scopes": [ "string" ], "connected_at": "2026-10-06T05:30:00.000Z", "connected_by_id": "cmusrceel0000q7kaafxqi1om", "last_ok_at": "2026-10-06T05:30:00.000Z", "last_error": "string", "error_count": 0, "created_at": "2026-10-06T05:30:00.000Z", "updated_at": "2026-10-06T05:30:00.000Z" }, "meta": {} }

{ "data": { "customers": [ "string" ], "conversion_actions": [ { "id": "string", "name": "string", "type": "string", "status": "string" } ] }, "meta": {} }

curl -X POST 'https://api.propzolo.com/v1/ad-conversions/meta' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Idempotency-Key: 6c0f1d3e-…' \ -H 'Content-Type: application/json' \ -d '{"dataset_id":"string","access_token":"string","test_event_code":"string"}'

curl -X PATCH 'https://api.propzolo.com/v1/ad-conversions/meta/{id}' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Content-Type: application/json' \ -d '{"enabled":true,"dataset_id":"string","test_event_code":"string","mapping":{},"hashed_identifiers":true,"send_client_ip":true,"value":"commission","access_token":"string"}'

curl -X POST 'https://api.propzolo.com/v1/ad-conversions/meta/{id}/whatsapp-datasets' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Content-Type: application/json' \ -d '{"accounts":[{"waba_id":"string","dataset_id":"string"}]}'

curl -X PUT 'https://api.propzolo.com/v1/ad-conversions/milestones' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Content-Type: application/json' \ -d '{"qualified":{"status_keys":["string"],"sub_status_keys":["string"]},"visit_scheduled":{"status_keys":["string"],"sub_status_keys":["string"]},"visit_done":{"status_keys":["string"],"sub_status_keys":["string"]},"booked":{"status_keys":["string"],"sub_status_keys":["string"]}}'

{ "data": { "qualified": { "status_keys": [ "string" ], "sub_status_keys": [ "string" ] }, "visit_scheduled": { "status_keys": [ "string" ], "sub_status_keys": [ "string" ] }, "visit_done": { "status_keys": [ "string" ], "sub_status_keys": [ "string" ] }, "booked": { "status_keys": [ "string" ], "sub_status_keys": [ "string" ] } }, "meta": {} }

curl -X POST 'https://api.propzolo.com/v1/ad-conversions/{id}/test' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Content-Type: application/json' \ -d '{"test_event_code":"string","action_id":"string"}'