Marketing studio

AI ad copy per placement and language grounded on CRM facts (RERA line and disclaimer attached), branded creatives from listing photos, social posts on a calendar, and ad audiences synced as hashed identifiers with booked-buyer suppression.

GET/v1/marketing/ad-copy

Studio sessions, newest first

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

Parameters

cursorquery: string
limitquery: integer
subject_typequery: "property" | "project"
archivedquery: "true" | "false"

Response · 200

datarequired: array of AdCopySetSummary
metarequired: PageMeta

Request

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

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "subject_type": "property",
      "property_id": "cmusrceel0000q7kaafxqi1om",
      "project_id": "cmusrceel0000q7kaafxqi1om",
      "title": "string",
      "objective": "leads",
      "tone": "professional",
      "languages": [
        "en"
      ],
      "platforms": [
        "meta_feed"
      ],
      "rera_numbers": [
        "string"
      ],
      "project_status": "string",
      "notes": "string",
      "ai_model": "string",
      "created_by_id": "cmusrceel0000q7kaafxqi1om",
      "created_at": "2026-10-06T05:30:00.000Z",
      "archived_at": "2026-10-06T05:30:00.000Z",
      "variants": 0,
      "approved": 0,
      "blocked": 0
    }
  ],
  "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/marketing/ad-copy

Write ad copy for a listing or project with AI

One variant per placement × language (English, Hindi, Hinglish), grounded on the record’s saved facts: numbers not in the facts and forbidden claims are flagged and block approval; the RERA line and the company disclaimer are attached. Metered on the AI wallet.

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

Request body

subjectrequired: "property" | "project"
subject_idrequired: Id
Opaque record id.
platforms: array of "meta_feed" | "instagram" | "google_search" | "google_display" | "whatsapp_status" | "portal" or null
languages: array of "en" | "hi" | "hinglish" or null
objective: "leads" | "site_visits" | "awareness"
tone: "professional" | "warm" | "premium"
notes: string or null

Response · 201

datarequired: object
data.setrequired: AdCopySet
One studio session: the facts the AI was given and its variants.
data.creditsrequired: integer
data.request_idrequired: string
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/marketing/ad-copy' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"subject":"property","subject_id":"cmusrceel0000q7kaafxqi1om","platforms":["meta_feed"],"languages":["en"],"objective":"leads","tone":"professional","notes":"string"}'

Response example

{
  "data": {
    "set": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "subject_type": "property",
      "property_id": "cmusrceel0000q7kaafxqi1om",
      "project_id": "cmusrceel0000q7kaafxqi1om",
      "title": "string",
      "objective": "leads",
      "tone": "professional",
      "languages": [
        "en"
      ],
      "platforms": [
        "meta_feed"
      ],
      "rera_numbers": [
        "string"
      ],
      "project_status": "string",
      "notes": "string",
      "ai_model": "string",
      "created_by_id": "cmusrceel0000q7kaafxqi1om",
      "created_at": "2026-10-06T05:30:00.000Z",
      "archived_at": "2026-10-06T05:30:00.000Z",
      "variants": [
        {
          "id": "cmusrceel0000q7kaafxqi1om",
          "set_id": "cmusrceel0000q7kaafxqi1om",
          "platform": "meta_feed",
          "language": "en",
          "headline": "string",
          "primary_text": "string",
          "description": "string",
          "cta": "learn_more",
          "rera_line": "string",
          "disclaimer": "string",
          "hashtags": [
            "string"
          ],
          "findings": [
            {
              "source": null,
              "code": null,
              "severity": null,
              "message": null,
              "field": null
            }
          ],
          "blocked": true,
          "status": "draft",
          "source": "string",
          "edited_at": "2026-10-06T05:30:00.000Z",
          "approved_at": "2026-10-06T05:30:00.000Z",
          "approved_by_id": "cmusrceel0000q7kaafxqi1om",
          "created_at": "2026-10-06T05:30:00.000Z",
          "updated_at": "2026-10-06T05:30:00.000Z"
        }
      ],
      "approved": 0,
      "blocked": 0,
      "facts": {},
      "missing_facts": [
        "string"
      ]
    },
    "credits": 0,
    "request_id": "string"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
402 CREDITS_EXHAUSTED — the AI wallet is empty or the monthly AI limit is reached.
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.
503 NOT_CONFIGURED — AI is not set up on this PropZolo deployment (ask your PropZolo admin).

GET/v1/marketing/ad-copy/{id}

A studio session with its variants

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: AdCopySet
One studio session: the facts the AI was given and its variants.
metarequired: object

Request

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

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "subject_type": "property",
    "property_id": "cmusrceel0000q7kaafxqi1om",
    "project_id": "cmusrceel0000q7kaafxqi1om",
    "title": "string",
    "objective": "leads",
    "tone": "professional",
    "languages": [
      "en"
    ],
    "platforms": [
      "meta_feed"
    ],
    "rera_numbers": [
      "string"
    ],
    "project_status": "string",
    "notes": "string",
    "ai_model": "string",
    "created_by_id": "cmusrceel0000q7kaafxqi1om",
    "created_at": "2026-10-06T05:30:00.000Z",
    "archived_at": "2026-10-06T05:30:00.000Z",
    "variants": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "set_id": "cmusrceel0000q7kaafxqi1om",
        "platform": "meta_feed",
        "language": "en",
        "headline": "string",
        "primary_text": "string",
        "description": "string",
        "cta": "learn_more",
        "rera_line": "string",
        "disclaimer": "string",
        "hashtags": [
          "string"
        ],
        "findings": [
          {
            "source": "rules",
            "code": "string",
            "severity": "block",
            "message": "string",
            "field": "string"
          }
        ],
        "blocked": true,
        "status": "draft",
        "source": "string",
        "edited_at": "2026-10-06T05:30:00.000Z",
        "approved_at": "2026-10-06T05:30:00.000Z",
        "approved_by_id": "cmusrceel0000q7kaafxqi1om",
        "created_at": "2026-10-06T05:30:00.000Z",
        "updated_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "approved": 0,
    "blocked": 0,
    "facts": {},
    "missing_facts": [
      "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/marketing/ad-copy/{id}/archive

Archive a studio session

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: object
data.idrequired: Id
Opaque record id.
data.archived_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/marketing/ad-copy/{id}/archive' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "archived_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/marketing/ad-copy/{id}/creatives

Creatives of a studio session

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: array of MarketingCreative
A branded image; `url` once rendered (no EXIF/GPS).
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/marketing/ad-copy/{id}/creatives' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "set_id": "cmusrceel0000q7kaafxqi1om",
      "variant_id": "cmusrceel0000q7kaafxqi1om",
      "source_media_id": "cmusrceel0000q7kaafxqi1om",
      "template": "classic",
      "format": "square",
      "text": {
        "headline": "string",
        "price": "string",
        "place": "string",
        "rera": "string",
        "brand": "string"
      },
      "status": "pending",
      "width": 0,
      "height": 0,
      "failure": "string",
      "url": "string",
      "created_at": "2026-10-06T05:30:00.000Z",
      "rendered_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.

POST/v1/marketing/ad-copy/{id}/creatives

Render a branded creative from a photo

Queued for rendering: poll the session’s creatives until it is `ready` (or `failed`).

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

media_idrequired: Id
Opaque record id.
template: "classic" | "bold_band" | "minimal" or null
format: "square" | "portrait" | "story" | "landscape"
variant_id: Id or null
Opaque record id.

Response · 202

datarequired: MarketingCreative
A branded image; `url` once rendered (no EXIF/GPS).
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/marketing/ad-copy/{id}/creatives' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"media_id":"cmusrceel0000q7kaafxqi1om","template":"classic","format":"square","variant_id":"cmusrceel0000q7kaafxqi1om"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "set_id": "cmusrceel0000q7kaafxqi1om",
    "variant_id": "cmusrceel0000q7kaafxqi1om",
    "source_media_id": "cmusrceel0000q7kaafxqi1om",
    "template": "classic",
    "format": "square",
    "text": {
      "headline": "string",
      "price": "string",
      "place": "string",
      "rera": "string",
      "brand": "string"
    },
    "status": "pending",
    "width": 0,
    "height": 0,
    "failure": "string",
    "url": "string",
    "created_at": "2026-10-06T05:30:00.000Z",
    "rendered_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/marketing/ad-copy/{id}/photos

Photos of the session’s listing or project that can become creatives

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: array of StudioPhoto
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/marketing/ad-copy/{id}/photos' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "caption": "string",
      "room_tag": "string",
      "is_cover": true,
      "thumb_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.
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.

PATCH/v1/marketing/ad-variants/{id}

Edit an ad variant

The rules, grounding and compliance checks run again on the new text; an approved variant becomes a draft.

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

headline: string
primary_text: string
description: string or null
cta: "learn_more" | "call_now" | "book_visit" | "whatsapp" | "get_quote" | "sign_up"
hashtags: array of string
disclaimer: string or null
rera_line: string or null

Response · 200

datarequired: AdVariant
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/marketing/ad-variants/{id}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"headline":"string","primary_text":"string","description":"string","cta":"learn_more","hashtags":["string"],"disclaimer":"string","rera_line":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "set_id": "cmusrceel0000q7kaafxqi1om",
    "platform": "meta_feed",
    "language": "en",
    "headline": "string",
    "primary_text": "string",
    "description": "string",
    "cta": "learn_more",
    "rera_line": "string",
    "disclaimer": "string",
    "hashtags": [
      "string"
    ],
    "findings": [
      {
        "source": "rules",
        "code": "string",
        "severity": "block",
        "message": "string",
        "field": "string"
      }
    ],
    "blocked": true,
    "status": "draft",
    "source": "string",
    "edited_at": "2026-10-06T05:30:00.000Z",
    "approved_at": "2026-10-06T05:30:00.000Z",
    "approved_by_id": "cmusrceel0000q7kaafxqi1om",
    "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/marketing/ad-variants/{id}/approve

Approve an ad variant

409 while the variant has a blocking finding. Approved variants can be scheduled as posts.

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: AdVariant
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/marketing/ad-variants/{id}/approve' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "set_id": "cmusrceel0000q7kaafxqi1om",
    "platform": "meta_feed",
    "language": "en",
    "headline": "string",
    "primary_text": "string",
    "description": "string",
    "cta": "learn_more",
    "rera_line": "string",
    "disclaimer": "string",
    "hashtags": [
      "string"
    ],
    "findings": [
      {
        "source": "rules",
        "code": "string",
        "severity": "block",
        "message": "string",
        "field": "string"
      }
    ],
    "blocked": true,
    "status": "draft",
    "source": "string",
    "edited_at": "2026-10-06T05:30:00.000Z",
    "approved_at": "2026-10-06T05:30:00.000Z",
    "approved_by_id": "cmusrceel0000q7kaafxqi1om",
    "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.
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/marketing/ad-variants/{id}/archive

Archive an ad variant

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: AdVariant
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/marketing/ad-variants/{id}/archive' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "set_id": "cmusrceel0000q7kaafxqi1om",
    "platform": "meta_feed",
    "language": "en",
    "headline": "string",
    "primary_text": "string",
    "description": "string",
    "cta": "learn_more",
    "rera_line": "string",
    "disclaimer": "string",
    "hashtags": [
      "string"
    ],
    "findings": [
      {
        "source": "rules",
        "code": "string",
        "severity": "block",
        "message": "string",
        "field": "string"
      }
    ],
    "blocked": true,
    "status": "draft",
    "source": "string",
    "edited_at": "2026-10-06T05:30:00.000Z",
    "approved_at": "2026-10-06T05:30:00.000Z",
    "approved_by_id": "cmusrceel0000q7kaafxqi1om",
    "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.
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/marketing/audiences

Ad audiences

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

Parameters

archivedquery: "true" | "false"

Response · 200

datarequired: array of MarketingAudience
metarequired: object

Request

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

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "description": "string",
      "segment": {
        "kind": "leads",
        "filter": null
      },
      "destinations": [
        "meta"
      ],
      "schedule": "manual",
      "status": "active",
      "last_synced_at": "2026-10-06T05:30:00.000Z",
      "last_counts": {
        "segment": 0,
        "eligible": 0,
        "excluded": {},
        "by_destination": {}
      },
      "created_by_id": "cmusrceel0000q7kaafxqi1om",
      "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.
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/marketing/audiences

Create an ad audience from a CRM segment

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

Request body

namerequired: string
description: string or null
segmentrequired: AudienceSegmentInput
A lead or contact smart list (the filter DSL).
destinationsrequired: array of "meta" | "google"
schedule: "manual" | "daily" | "weekly"

Response · 201

datarequired: MarketingAudience
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/marketing/audiences' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"name":"string","description":"string","segment":{"kind":"leads","filter":null},"destinations":["meta"],"schedule":"manual"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "description": "string",
    "segment": {
      "kind": "leads",
      "filter": null
    },
    "destinations": [
      "meta"
    ],
    "schedule": "manual",
    "status": "active",
    "last_synced_at": "2026-10-06T05:30:00.000Z",
    "last_counts": {
      "segment": 0,
      "eligible": 0,
      "excluded": {},
      "by_destination": {}
    },
    "created_by_id": "cmusrceel0000q7kaafxqi1om",
    "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.

POST/v1/marketing/audiences/preview

Who a segment would upload

Counts only: the segment, the people eligible and those left out by reason (booked buyers always).

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

Request body

segmentrequired: AudienceSegmentInput
A lead or contact smart list (the filter DSL).

Response · 200

datarequired: object
data.segmentrequired: integer
data.eligiblerequired: integer
data.excludedrequired: map of integer
data.allowed_basesrequired: array of "consent" | "contract" | "legitimate_use"
data.servablerequired: boolean
data.min_servablerequired: integer
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/marketing/audiences/preview' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"segment":{"kind":"leads","filter":null}}'

Response example

{
  "data": {
    "segment": 0,
    "eligible": 0,
    "excluded": {},
    "allowed_bases": [
      "consent"
    ],
    "servable": true,
    "min_servable": 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.
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/marketing/audiences/{id}

An ad audience with its recent sync runs

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: MarketingAudienceDetail
metarequired: object

Request

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

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "description": "string",
    "segment": {
      "kind": "leads",
      "filter": null
    },
    "destinations": [
      "meta"
    ],
    "schedule": "manual",
    "status": "active",
    "last_synced_at": "2026-10-06T05:30:00.000Z",
    "last_counts": {
      "segment": 0,
      "eligible": 0,
      "excluded": {},
      "by_destination": {}
    },
    "created_by_id": "cmusrceel0000q7kaafxqi1om",
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z",
    "syncs": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "audience_id": "cmusrceel0000q7kaafxqi1om",
        "destination": "meta",
        "trigger": "manual",
        "status": "queued",
        "eligible": 0,
        "added": 0,
        "removed": 0,
        "excluded": {},
        "error": "string",
        "created_at": "2026-10-06T05:30:00.000Z",
        "started_at": "2026-10-06T05:30:00.000Z",
        "finished_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.

PATCH/v1/marketing/audiences/{id}

Change, pause or resume an ad audience

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

name: string
description: string or null
segment: AudienceSegmentInput
A lead or contact smart list (the filter DSL).
destinations: array of "meta" | "google"
schedule: "manual" | "daily" | "weekly"
status: "active" | "paused"

Response · 200

datarequired: MarketingAudience
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/marketing/audiences/{id}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"name":"string","description":"string","segment":{"kind":"leads","filter":null},"destinations":["meta"],"schedule":"manual","status":"active"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "description": "string",
    "segment": {
      "kind": "leads",
      "filter": null
    },
    "destinations": [
      "meta"
    ],
    "schedule": "manual",
    "status": "active",
    "last_synced_at": "2026-10-06T05:30:00.000Z",
    "last_counts": {
      "segment": 0,
      "eligible": 0,
      "excluded": {},
      "by_destination": {}
    },
    "created_by_id": "cmusrceel0000q7kaafxqi1om",
    "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/marketing/audiences/{id}/archive

Archive an ad audience

One last run per platform removes everyone it uploaded.

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: object
data.idrequired: Id
Opaque record id.
data.statusrequired: "archived"
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/marketing/audiences/{id}/archive' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "status": "archived"
  },
  "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/marketing/audiences/{id}/sync

Sync an ad audience now

One run per platform (hashed phones and emails; never booked buyers or people without a lawful basis). Shares personal data with an ad platform: privileged sessions need a fresh step-up.

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 202

datarequired: MarketingAudienceDetail
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/marketing/audiences/{id}/sync' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "description": "string",
    "segment": {
      "kind": "leads",
      "filter": null
    },
    "destinations": [
      "meta"
    ],
    "schedule": "manual",
    "status": "active",
    "last_synced_at": "2026-10-06T05:30:00.000Z",
    "last_counts": {
      "segment": 0,
      "eligible": 0,
      "excluded": {},
      "by_destination": {}
    },
    "created_by_id": "cmusrceel0000q7kaafxqi1om",
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z",
    "syncs": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "audience_id": "cmusrceel0000q7kaafxqi1om",
        "destination": "meta",
        "trigger": "manual",
        "status": "queued",
        "eligible": 0,
        "added": 0,
        "removed": 0,
        "excluded": {},
        "error": "string",
        "created_at": "2026-10-06T05:30:00.000Z",
        "started_at": "2026-10-06T05:30:00.000Z",
        "finished_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/marketing/connections

Live social and ad accounts

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

Response · 200

datarequired: MarketingConnections
metarequired: object

Request

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

Response example

{
  "data": {
    "can_manage": true,
    "meta": {
      "connection_id": "cmusrceel0000q7kaafxqi1om",
      "status": "pending",
      "health": "ok",
      "ad_account_id": "string",
      "ad_account_name": "string",
      "page_id": "string",
      "page_name": "string",
      "instagram_user_id": "string",
      "instagram_username": "string",
      "secret_hints": {},
      "last_error": "string",
      "last_ok_at": "2026-10-06T05:30:00.000Z",
      "connected_at": "2026-10-06T05:30:00.000Z"
    },
    "google": {
      "connection_id": "cmusrceel0000q7kaafxqi1om",
      "status": "pending",
      "health": "ok",
      "customer_id": "string",
      "customer_name": "string",
      "account_email": "string",
      "last_error": "string",
      "audiences_ready": true
    },
    "google_app_ready": true,
    "accounts": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "provider": "facebook_page",
        "external_id": "string",
        "name": "string",
        "status": "active",
        "last_error": "string",
        "connected_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.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

PUT/v1/marketing/connections/meta

Connect or update Meta ads audiences & posts

Meta is asked for the ad account, Page and Instagram names first; nothing is saved when it refuses (422 with the field). Tokens left out keep the stored ones. The Page and Instagram account become live social accounts.

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

Request body

access_token: string
page_access_token: string
ad_account_idrequired: string
page_id: string or null
instagram_user_id: string or null

Response · 200

datarequired: MarketingConnections
metarequired: object

Request

curl -X PUT 'https://api.propzolo.com/v1/marketing/connections/meta' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"access_token":"string","page_access_token":"string","ad_account_id":"string","page_id":"string","instagram_user_id":"string"}'

Response example

{
  "data": {
    "can_manage": true,
    "meta": {
      "connection_id": "cmusrceel0000q7kaafxqi1om",
      "status": "pending",
      "health": "ok",
      "ad_account_id": "string",
      "ad_account_name": "string",
      "page_id": "string",
      "page_name": "string",
      "instagram_user_id": "string",
      "instagram_username": "string",
      "secret_hints": {},
      "last_error": "string",
      "last_ok_at": "2026-10-06T05:30:00.000Z",
      "connected_at": "2026-10-06T05:30:00.000Z"
    },
    "google": {
      "connection_id": "cmusrceel0000q7kaafxqi1om",
      "status": "pending",
      "health": "ok",
      "customer_id": "string",
      "customer_name": "string",
      "account_email": "string",
      "last_error": "string",
      "audiences_ready": true
    },
    "google_app_ready": true,
    "accounts": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "provider": "facebook_page",
        "external_id": "string",
        "name": "string",
        "status": "active",
        "last_error": "string",
        "connected_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.

DELETE/v1/marketing/connections/meta

Disconnect Meta ads audiences & posts

Tokens wiped; the live accounts are disconnected and their scheduled posts cancelled.

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

Response · 200

datarequired: MarketingConnections
metarequired: object

Request

curl -X DELETE 'https://api.propzolo.com/v1/marketing/connections/meta' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "can_manage": true,
    "meta": {
      "connection_id": "cmusrceel0000q7kaafxqi1om",
      "status": "pending",
      "health": "ok",
      "ad_account_id": "string",
      "ad_account_name": "string",
      "page_id": "string",
      "page_name": "string",
      "instagram_user_id": "string",
      "instagram_username": "string",
      "secret_hints": {},
      "last_error": "string",
      "last_ok_at": "2026-10-06T05:30:00.000Z",
      "connected_at": "2026-10-06T05:30:00.000Z"
    },
    "google": {
      "connection_id": "cmusrceel0000q7kaafxqi1om",
      "status": "pending",
      "health": "ok",
      "customer_id": "string",
      "customer_name": "string",
      "account_email": "string",
      "last_error": "string",
      "audiences_ready": true
    },
    "google_app_ready": true,
    "accounts": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "provider": "facebook_page",
        "external_id": "string",
        "name": "string",
        "status": "active",
        "last_error": "string",
        "connected_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.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/marketing/connections/meta/check

Check the Meta tokens again

A revoked token marks the connection broken and its live accounts “reconnect needed”.

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

Response · 200

datarequired: MarketingConnections
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/marketing/connections/meta/check' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "can_manage": true,
    "meta": {
      "connection_id": "cmusrceel0000q7kaafxqi1om",
      "status": "pending",
      "health": "ok",
      "ad_account_id": "string",
      "ad_account_name": "string",
      "page_id": "string",
      "page_name": "string",
      "instagram_user_id": "string",
      "instagram_username": "string",
      "secret_hints": {},
      "last_error": "string",
      "last_ok_at": "2026-10-06T05:30:00.000Z",
      "connected_at": "2026-10-06T05:30:00.000Z"
    },
    "google": {
      "connection_id": "cmusrceel0000q7kaafxqi1om",
      "status": "pending",
      "health": "ok",
      "customer_id": "string",
      "customer_name": "string",
      "account_email": "string",
      "last_error": "string",
      "audiences_ready": true
    },
    "google_app_ready": true,
    "accounts": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "provider": "facebook_page",
        "external_id": "string",
        "name": "string",
        "status": "active",
        "last_error": "string",
        "connected_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.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/marketing/social-accounts

Connected social accounts

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

Response · 200

datarequired: array of SocialAccount
`mode: fake` — a demo connection; posts go to the demo publisher.
metarequired: object

Request

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

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "provider": "facebook_page",
      "external_id": "string",
      "name": "string",
      "mode": "live",
      "status": "active",
      "last_error": "string",
      "connected_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.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/marketing/social-accounts

Connect a social account (demo mode until the provider apps are approved)

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

Request body

providerrequired: "facebook_page" | "instagram_business" | "google_business"
namerequired: string

Response · 201

datarequired: SocialAccount
`mode: fake` — a demo connection; posts go to the demo publisher.
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/marketing/social-accounts' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"provider":"facebook_page","name":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "provider": "facebook_page",
    "external_id": "string",
    "name": "string",
    "mode": "live",
    "status": "active",
    "last_error": "string",
    "connected_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.

POST/v1/marketing/social-accounts/{id}/disconnect

Disconnect a social account

Its drafts and scheduled posts are cancelled.

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: SocialAccount
`mode: fake` — a demo connection; posts go to the demo publisher.
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/marketing/social-accounts/{id}/disconnect' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "provider": "facebook_page",
    "external_id": "string",
    "name": "string",
    "mode": "live",
    "status": "active",
    "last_error": "string",
    "connected_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.
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/marketing/social-posts

Posts for the calendar

A company-local month (`month=2026-10`) by scheduled time; without a month, the latest 500.

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

Parameters

monthquery: string
statusquery: "draft" | "scheduled" | "publishing" | "published" | "failed" | "cancelled"

Response · 200

datarequired: array of SocialPost
metarequired: object

Request

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

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "account_id": "cmusrceel0000q7kaafxqi1om",
      "account_name": "string",
      "provider": "facebook_page",
      "demo": true,
      "variant_id": "cmusrceel0000q7kaafxqi1om",
      "creative_id": "cmusrceel0000q7kaafxqi1om",
      "creative_url": "string",
      "text": "string",
      "link_url": "string",
      "status": "draft",
      "scheduled_at": "2026-10-06T05:30:00.000Z",
      "attempts": 0,
      "next_attempt_at": "2026-10-06T05:30:00.000Z",
      "external_post_id": "string",
      "permalink": "string",
      "last_error": "string",
      "published_at": "2026-10-06T05:30:00.000Z",
      "cancelled_at": "2026-10-06T05:30:00.000Z",
      "created_by_id": "cmusrceel0000q7kaafxqi1om",
      "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.
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/marketing/social-posts

Draft, schedule or publish a post

From an approved ad variant (its text with the RERA line and disclaimer) or typed text (compliance-checked). No `scheduled_at`: a draft; `publish_now`: the next worker pick-up.

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

Request body

account_idrequired: Id
Opaque record id.
variant_id: Id or null
Opaque record id.
creative_id: Id or null
Opaque record id.
text: string or null
link_url: string (uri) or null
scheduled_at: string (date-time) or null
publish_now: boolean

Response · 201

datarequired: SocialPost
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/marketing/social-posts' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"account_id":"cmusrceel0000q7kaafxqi1om","variant_id":"cmusrceel0000q7kaafxqi1om","creative_id":"cmusrceel0000q7kaafxqi1om","text":"string","link_url":"https://example.com","scheduled_at":"2026-10-06T05:30:00.000Z","publish_now":false}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "account_id": "cmusrceel0000q7kaafxqi1om",
    "account_name": "string",
    "provider": "facebook_page",
    "demo": true,
    "variant_id": "cmusrceel0000q7kaafxqi1om",
    "creative_id": "cmusrceel0000q7kaafxqi1om",
    "creative_url": "string",
    "text": "string",
    "link_url": "string",
    "status": "draft",
    "scheduled_at": "2026-10-06T05:30:00.000Z",
    "attempts": 0,
    "next_attempt_at": "2026-10-06T05:30:00.000Z",
    "external_post_id": "string",
    "permalink": "string",
    "last_error": "string",
    "published_at": "2026-10-06T05:30:00.000Z",
    "cancelled_at": "2026-10-06T05:30:00.000Z",
    "created_by_id": "cmusrceel0000q7kaafxqi1om",
    "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.

GET/v1/marketing/social-posts/{id}

A post

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: SocialPost
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/marketing/social-posts/{id}' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "account_id": "cmusrceel0000q7kaafxqi1om",
    "account_name": "string",
    "provider": "facebook_page",
    "demo": true,
    "variant_id": "cmusrceel0000q7kaafxqi1om",
    "creative_id": "cmusrceel0000q7kaafxqi1om",
    "creative_url": "string",
    "text": "string",
    "link_url": "string",
    "status": "draft",
    "scheduled_at": "2026-10-06T05:30:00.000Z",
    "attempts": 0,
    "next_attempt_at": "2026-10-06T05:30:00.000Z",
    "external_post_id": "string",
    "permalink": "string",
    "last_error": "string",
    "published_at": "2026-10-06T05:30:00.000Z",
    "cancelled_at": "2026-10-06T05:30:00.000Z",
    "created_by_id": "cmusrceel0000q7kaafxqi1om",
    "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.
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/marketing/social-posts/{id}

Edit or reschedule a post that has not gone out

409 once publishing started (statuses only move forward).

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

variant_id: Id or null
Opaque record id.
creative_id: Id or null
Opaque record id.
text: string or null
link_url: string (uri) or null
scheduled_at: string (date-time) or null
publish_now: boolean

Response · 200

datarequired: SocialPost
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/marketing/social-posts/{id}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"variant_id":"cmusrceel0000q7kaafxqi1om","creative_id":"cmusrceel0000q7kaafxqi1om","text":"string","link_url":"https://example.com","scheduled_at":"2026-10-06T05:30:00.000Z","publish_now":false}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "account_id": "cmusrceel0000q7kaafxqi1om",
    "account_name": "string",
    "provider": "facebook_page",
    "demo": true,
    "variant_id": "cmusrceel0000q7kaafxqi1om",
    "creative_id": "cmusrceel0000q7kaafxqi1om",
    "creative_url": "string",
    "text": "string",
    "link_url": "string",
    "status": "draft",
    "scheduled_at": "2026-10-06T05:30:00.000Z",
    "attempts": 0,
    "next_attempt_at": "2026-10-06T05:30:00.000Z",
    "external_post_id": "string",
    "permalink": "string",
    "last_error": "string",
    "published_at": "2026-10-06T05:30:00.000Z",
    "cancelled_at": "2026-10-06T05:30:00.000Z",
    "created_by_id": "cmusrceel0000q7kaafxqi1om",
    "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/marketing/social-posts/{id}/cancel

Cancel a draft or scheduled post

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: SocialPost
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/marketing/social-posts/{id}/cancel' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "account_id": "cmusrceel0000q7kaafxqi1om",
    "account_name": "string",
    "provider": "facebook_page",
    "demo": true,
    "variant_id": "cmusrceel0000q7kaafxqi1om",
    "creative_id": "cmusrceel0000q7kaafxqi1om",
    "creative_url": "string",
    "text": "string",
    "link_url": "string",
    "status": "draft",
    "scheduled_at": "2026-10-06T05:30:00.000Z",
    "attempts": 0,
    "next_attempt_at": "2026-10-06T05:30:00.000Z",
    "external_post_id": "string",
    "permalink": "string",
    "last_error": "string",
    "published_at": "2026-10-06T05:30:00.000Z",
    "cancelled_at": "2026-10-06T05:30:00.000Z",
    "created_by_id": "cmusrceel0000q7kaafxqi1om",
    "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.
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/settings/marketing-studio

The marketing studio settings

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

Response · 200

datarequired: MarketingStudioSettings
metarequired: object

Request

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

Response example

{
  "data": {
    "disclaimer": "string",
    "brand_color": "string",
    "default_platforms": [
      "meta_feed"
    ],
    "default_languages": [
      "en"
    ],
    "default_template": "classic",
    "audiences": {
      "allowed_bases": [
        "consent"
      ],
      "destinations": [
        "meta"
      ]
    }
  },
  "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.

PUT/v1/settings/marketing-studio

Save the marketing studio settings

Disclaimer, brand colour, defaults and the audience rules (lawful bases, platforms). Audited.

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

Request body

disclaimerrequired: string or null
brand_colorrequired: string or null
default_platformsrequired: array of "meta_feed" | "instagram" | "google_search" | "google_display" | "whatsapp_status" | "portal"
default_languagesrequired: array of "en" | "hi" | "hinglish"
default_templaterequired: "classic" | "bold_band" | "minimal"
audiencesrequired: object
audiences.allowed_basesrequired: array of "consent" | "contract" | "legitimate_use"
audiences.destinationsrequired: array of "meta" | "google"

Response · 200

datarequired: MarketingStudioSettings
metarequired: object

Request

curl -X PUT 'https://api.propzolo.com/v1/settings/marketing-studio' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"disclaimer":"string","brand_color":"string","default_platforms":["meta_feed"],"default_languages":["en"],"default_template":"classic","audiences":{"allowed_bases":["consent"],"destinations":["meta"]}}'

Response example

{
  "data": {
    "disclaimer": "string",
    "brand_color": "string",
    "default_platforms": [
      "meta_feed"
    ],
    "default_languages": [
      "en"
    ],
    "default_template": "classic",
    "audiences": {
      "allowed_bases": [
        "consent"
      ],
      "destinations": [
        "meta"
      ]
    }
  },
  "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.