Campaign spend

Spend entries per campaign and source per period, behind cost per lead / visit / deal and source ROI.

GET/v1/campaigns

Campaigns and their spend

Spend entries per campaign and source with their periods and attributed leads (at most 500).

Access: API key or member session. Permission marketing.view.

Parameters

source_idquery: Id
Opaque record id.
qquery: string

Response · 200

datarequired: array of MarketingCampaign
metarequired: object

Request

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

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "source": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "type": "string"
      },
      "external_id": "string",
      "project": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "spend": 850000000,
      "starts_on": "2026-10-06",
      "ends_on": "2026-10-06",
      "leads": 0,
      "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.
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/campaigns

Record campaign spend

A spend for a period needs its first day; names and campaign ids are unique per source (409).

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

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

namerequired: string
source_idrequired: Id
Opaque record id.
external_id: string or null
The ad platform’s campaign id; incoming leads with it are attributed to this campaign.
project_id: Id or null
Opaque record id.
spendrequired: PaiseInput
Spend over the period, in paise.
starts_on: LocalDate or null
Calendar date YYYY-MM-DD in the company time zone.
ends_on: LocalDate or null
Inclusive; default: the first day.

Response · 201

datarequired: MarketingCampaign
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/campaigns' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Idempotency-Key: 6c0f1d3e-…' \
  -H 'Content-Type: application/json' \
  -d '{"name":"string","source_id":"cmusrceel0000q7kaafxqi1om","external_id":"string","project_id":"cmusrceel0000q7kaafxqi1om","spend":0,"starts_on":"2026-10-06","ends_on":"2026-10-06"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "source": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "type": "string"
    },
    "external_id": "string",
    "project": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "spend": 850000000,
    "starts_on": "2026-10-06",
    "ends_on": "2026-10-06",
    "leads": 0,
    "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.
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/campaigns/{id}

Change a campaign’s spend or period

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

name: string
source_id: Id
Opaque record id.
external_id: string or null
The ad platform’s campaign id; incoming leads with it are attributed to this campaign.
project_id: Id or null
Opaque record id.
spend: PaiseInput
Spend over the period, in paise.
starts_on: LocalDate or null
Calendar date YYYY-MM-DD in the company time zone.
ends_on: LocalDate or null
Inclusive; default: the first day.

Response · 200

datarequired: MarketingCampaign
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/campaigns/{id}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"name":"string","source_id":"cmusrceel0000q7kaafxqi1om","external_id":"string","project_id":"cmusrceel0000q7kaafxqi1om","spend":0,"starts_on":"2026-10-06","ends_on":"2026-10-06"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "source": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "type": "string"
    },
    "external_id": "string",
    "project": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "spend": 850000000,
    "starts_on": "2026-10-06",
    "ends_on": "2026-10-06",
    "leads": 0,
    "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.
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.

DELETE/v1/campaigns/{id}

Delete a campaign no lead came from

A campaign with attributed leads answers 409 — set its spend to 0 instead.

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: object
data.idrequired: Id
Opaque record id.
data.deletedrequired: true
metarequired: object

Request

curl -X DELETE 'https://api.propzolo.com/v1/campaigns/{id}' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "deleted": true
  },
  "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.

{ "data": [ { "id": "cmusrceel0000q7kaafxqi1om", "name": "string", "source": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string", "type": "string" }, "external_id": "string", "project": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "spend": 850000000, "starts_on": "2026-10-06", "ends_on": "2026-10-06", "leads": 0, "created_at": "2026-10-06T05:30:00.000Z" } ], "meta": {} }

curl -X POST 'https://api.propzolo.com/v1/campaigns' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Idempotency-Key: 6c0f1d3e-…' \ -H 'Content-Type: application/json' \ -d '{"name":"string","source_id":"cmusrceel0000q7kaafxqi1om","external_id":"string","project_id":"cmusrceel0000q7kaafxqi1om","spend":0,"starts_on":"2026-10-06","ends_on":"2026-10-06"}'

{ "data": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string", "source": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string", "type": "string" }, "external_id": "string", "project": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "spend": 850000000, "starts_on": "2026-10-06", "ends_on": "2026-10-06", "leads": 0, "created_at": "2026-10-06T05:30:00.000Z" }, "meta": {} }

curl -X PATCH 'https://api.propzolo.com/v1/campaigns/{id}' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Content-Type: application/json' \ -d '{"name":"string","source_id":"cmusrceel0000q7kaafxqi1om","external_id":"string","project_id":"cmusrceel0000q7kaafxqi1om","spend":0,"starts_on":"2026-10-06","ends_on":"2026-10-06"}'

DELETE/v1/campaigns/{id}

Delete a campaign no lead came from

A campaign with attributed leads answers 409 — set its spend to 0 instead.

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: object
data.idrequired: Id
Opaque record id.
data.deletedrequired: true
metarequired: object

Request

curl -X DELETE 'https://api.propzolo.com/v1/campaigns/{id}' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "deleted": true
  },
  "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.