Skip to content

Changelog

  • POST /v1/inbound-submissions: records the conversion of a person who asked to be contacted (website form, landing page, app). It follows the same path as a Preflow form: MQL by default ("qualified": false for a contact only), answers on the lead, attribution (UTM, campaign, page, Meta cookies), Inbound cadence. A lost, won, archived or already-handled lead only gets the record. form_id applies a Preflow form’s MQL rules. submission_id is unique in the workspace. Limit of 120 per minute per key. Guide: Receive leads from your website.
  • GET /v1/inbound-submissions/{id}.
  • inbound.submission_received webhook.
  • The event type catalog in the OpenAPI spec (WebhookEventTypeName) now lists the lead, account and meeting events, which already existed.
  • GET /v1/whatsapp/senders, GET /v1/whatsapp/templates, GET /v1/whatsapp/window.
  • POST /v1/files (upload through a signed URL, up to 16 MB).
  • POST /v1/whatsapp/messages (text, approved template or media, to a phone number or a lead), GET /v1/whatsapp/messages/{id} (delivery status), GET /v1/whatsapp/messages?to= (history) and GET /v1/whatsapp/messages/{id}/media.
  • Default line per key, chosen on the keys screen.
  • Webhook endpoints (up to 10 per workspace) with the webhooks:manage scope: create, edit, disable/re-enable, delete, new secret (the previous one stays valid for 24 more hours), test, 30-day delivery log and redelivery.
  • Events whatsapp.message.received, whatsapp.message.sent, whatsapp.message.status_updated and whatsapp.template.status_updated, signed per the Standard Webhooks spec, delivered at least once with retries for about 2 days. Guide in Webhooks.
  • GET /v1/event-types and GET /v1/events/{id}.
  • Subscribing to or reading an event type also requires the read scope of its module (whatsapp:read, leads:read, accounts:read, meetings:read).
  • Redelivery refuses a delivery that already succeeded and accepts up to 10 per minute per endpoint; a failure before the TLS connection shows up only as dns_or_address_refused.
  • Secret keys per workspace (pf_live_ / pf_test_), with scopes, created and revoked in Settings → Integrations → API & webhooks.
  • Only a workspace admin or owner can create and revoke keys; a key stops working when the person who created it is no longer an admin.
  • GET /v1/me and GET /v1/openapi.json.
  • Idempotency on every write, a limit of 600 requests per minute per key and a single error format.

v1 — leads, accounts, funnels, cadences and meetings

Section titled “v1 — leads, accounts, funnels, cadences and meetings”
  • POST /v1/leads: creates a lead that comes in as inbound and follows the workspace’s Inbound settings. Accepts phone-only leads; external_id is unique per workspace.
  • GET /v1/leads, GET /v1/leads/{id} and GET /v1/leads/{id}/activities.
  • GET /v1/accounts, GET /v1/accounts/{id} and GET /v1/funnels.
  • GET /v1/cadences, POST /v1/leads/{id}/cadence-enrollments and POST /v1/leads/{id}/cadence-stop.
  • GET /v1/meetings and GET /v1/meetings/{id}.