Glossary

Terms are in alphabetical order. Field names are in code; follow the links for the full guide.

#0-9

10DLC: The US registration that lets you send business SMS from ordinary 10-digit numbers. You register a brand and a campaign once with POST /v1/sms/registrations (10DLC).

#A

Account: See connected account.

Account-day: One connected account on one UTC day. Billing adds up account-days for the month and divides by 30, which is how accounts are prorated (pricing).

Account group: A named set of connected accounts, possibly from several profiles, that you can target together. Managed at /v1/account-groups (account groups).

Account health: Whether an account can still post and read, and what to do if not. GET /v1/accounts/health covers all accounts; GET /v1/accounts/{accountId}/health one (account health).

accountId: The id of a connected account, the _id returned by GET /v1/accounts. Posts, messages, analytics and ads calls take it to say which account to act on.

Ad account: The advertiser account on an ad network (a Meta ad account, a Google Ads customer) that campaigns are created in. Listed under the connected ads account with the Ad Accounts endpoints (ads).

Ad rule: An automation that watches ad metrics and acts, such as pausing an ad that spends without converting. Managed at /v1/ads/rules (rules).

Ad set: The level between a campaign and its ads that holds budget, schedule and targeting on networks that have one. Created with POST /v1/ads/ad-sets.

API key: A secret beginning pz_live_ that authenticates server requests as Authorization: Bearer .... Managed at /v1/api-keys (authentication).

Approval: A post saved with requiresApproval: true waits in pending_approval until someone approves or rejects it with POST /v1/posts/{postId}/review (drafts and approvals).

Audience: A list of people to target or exclude in ads: customer lists, website visitors, lookalikes. Managed at /v1/ads/audiences (audiences).

Authenticity score: A 0 to 100 score of how organic a post's views look, built from its verified samples. Read it at GET /v1/posts/{postId}/authenticity; post.authenticity_changed fires when it moves (tracking).

#B

Best time to post: The hours and weekdays when an account's posts have historically done best. GET /v1/analytics/best-time (best time).

Boost: Turning an existing organic post into an ad without building a campaign by hand. POST /v1/ads/boost (boost posts).

Branded calling: Showing your business name and logo on the recipient's phone when you call. Set up with the Branded Calling endpoints and verified identities (branded calling).

Broadcast: One message sent to many contacts at once, scheduled or sent right away. /v1/broadcasts (broadcasts).

Business agent: An AI agent that answers customers on a WhatsApp number using your business information, with a budget and an allowlist. /v1/accounts/{accountId}/business-agent (business agent).

#C

Caller identity: A verified business identity used by branded calling, created with POST /v1/branded-calling/identities.

Campaign: The top level of an ad structure, holding the objective and often the budget. /v1/ads/campaigns (ads).

Catalog: A product feed used for shopping and dynamic ads. /v1/ads/catalogs (catalogs).

Changelog: The list of API changes, on the web at /docs/changelog and for code at GET /v1/changelog (versioning).

Comment-to-DM: An automation that replies by DM to people who comment a keyword on a post. /v1/comment-automations (comment-to-DM).

Connect flow: The sequence that authorises Pozy to act on an account: you request a URL with GET /v1/connect/{platform}, the owner approves, the account appears in the profile (connecting accounts).

Connected account: One authorised login on one platform: an Instagram account, a Facebook Page, a WhatsApp number, an ad account, a store. Listed at GET /v1/accounts, billed per month.

Contact: A person you talk to across channels, with their handles, phone numbers and custom fields. /v1/contacts (contacts).

Content decay: How quickly a post's engagement fades after publishing. GET /v1/analytics/content-decay (content decay).

Conversation: A DM thread with one person on one account. /v1/inbox/conversations (messages).

Conversion: An action you report to an ad network, such as a purchase or a sign-up, so it can optimise and attribute ads. /v1/ads/conversions (conversions).

Creator campaign: A program that pays creators for posts that meet your brief, with submissions, approvals and payouts. /v1/creator-campaigns (creator campaigns).

Credentials connect: A connect flow that takes a token or an app password instead of OAuth, used by Bluesky, self-hosted WordPress, Webflow and others (credentials).

Custom field: A field you define for contacts, such as plan or order number, filled per contact. Definitions at /v1/custom-fields (custom fields).

customContent: Per-target text on a post that replaces content for that one account.

#D

Default profile: The profile flagged isDefault: true. Every workspace has exactly one (profiles).

Disabled resource groups: Areas of the API an API key may not call, listed in its disabledResourceGroups (authentication).

Draft: A saved post that will not publish until you schedule it. Created with isDraft: true (drafts).

Dry run: A post request with dryRun: true that checks whether it could publish without publishing anything.

Duplicate content check: The rule that refuses identical content to the same account within 24 hours with a 409 and details.existingPostId (idempotency).

#E

Early charge: A charge taken mid-month when accrued usage reaches the workspace's threshold. The first is at $10, and the threshold doubles after each successful early charge, up to $10,240 (billing).

Error code: The stable code in an error body, such as read_only_key. Branch on it rather than on the message (errors).

Event: Something that happened, delivered to your webhook endpoints as a signed JSON POST, such as post.published (events).

External post: A post published on the platform outside Pozy, picked up so you can see it and its analytics. Fires post.external.created; pull one in with POST /v1/posts/sync-external (external posts).

externalId: Your own id stored on a profile, unique in the workspace and returned in every webhook's profiles array (build a platform).

#F

First comment: A comment Pozy posts on your post right after it publishes, often used for links or hashtags. Set with firstComment in the platform settings (first comments).

Flow (WhatsApp): A multi-screen form inside a WhatsApp chat, such as a booking or a survey. /v1/whatsapp/flows (flows).

Free tier: Two connected accounts at no charge and without a card, applied as a $12 monthly credit (pricing).

#H

Handoff: Moving a conversation between an automation and a person. conversation.control_changed fires when control changes hands.

Headless connect: A connect flow where you draw the selection screens (which Page, which location) in your own UI using the select endpoints (headless).

Hosted connect: A connect flow where Pozy hosts every screen, optionally with your brand (hosted connect).

#I

Idempotency key: A value you send in the Idempotency-Key header so a retried create returns the original result instead of a duplicate (idempotency).

Inbox: The unified view of DMs, comments, reviews and mentions across accounts (inbox).

#K

KYC: The identity and address checks some countries require before you can buy a phone number there. /v1/phone-numbers/kyc (KYC).

#L

Lead form: An ad form that collects contact details without leaving the platform. /v1/ads/lead-forms; lead.received fires for each submission (lead forms).

#M

Managed ad: An ad that is running or in review through Pozy. Billed per active ad per month past the first 500 (pricing).

MCP server: Pozy's Model Context Protocol server at https://mcp.pozy.ai/mcp, which lets AI assistants use Pozy as tools (MCP).

Media item: An image, video, GIF or document attached to a post in mediaItems, by URL (media).

Mention: A post or comment that tags one of your accounts. GET /v1/inbox/mentions (mentions).

Member: A person in the workspace with a role: owner, admin, member, viewer or billing (roles).

#O

OAuth app (your own): Your platform developer app, registered with Pozy so connect flows show your app's name. Coming soon. /v1/connect/oauth-apps (own apps).

operationId: The name of an endpoint in the OpenAPI spec, such as createPost. It is the last segment of each API reference URL, the method name most generated clients use, and the id the MCP server's call_tool takes.

Outbound message: A message you send: an inbox reply, a broadcast recipient, a sequence step. The first 10,000 each month are free (pricing).

#P

Pagination: Reading a list a page at a time with page, skip or cursor (pagination).

Partial: A post status meaning some targets published and others failed. Retry the failed ones with POST /v1/posts/{postId}/retry.

Payment required: A 402 response with code: "payment_required" and a reason, returned before an action that needs a card (billing).

Phone handoff: A connect option that shows a QR code so the owner can finish connecting on their phone, where the platform app is already signed in (phone handoff).

Pixel: A tracking tag installed on a website that reports visits and conversions to an ad network. /v1/accounts/{accountId}/tracking-tags (pixels).

Platform: A network or service Pozy connects to, named by a lowercase id such as instagram, twitter (X) or googlebusiness (platforms).

platformSpecificData: Per-target options that only one platform understands, such as TikTok privacy or YouTube visibility (platform settings).

Porting: Moving an existing phone number to Pozy from another carrier. /v1/phone-numbers/port-in (porting).

Post: Content published to one or more accounts, with one target per account. /v1/posts (publishing).

Presigned upload: A short-lived URL from POST /v1/media/presign that you PUT a file to, then reference in mediaItems (media).

Profile: A group of connected accounts for one brand or customer. /v1/profiles (profiles).

profileId: The id of a profile. Pass it to connect, list and analytics calls to work inside one profile.

Profile-scoped key: An API key with scope: "profiles" that can only reach the profiles in its profileIds (tenant keys).

#Q

Queue: A weekly schedule of time slots for a profile. Posts added to the queue take the next free slot. /v1/queue/slots (queues).

#R

Rate limit: Requests per minute allowed for the workspace: 30 free, 120 with a payment method, 300 enterprise (rate limits).

RCS agent: A verified business sender for RCS, the rich messaging channel on Android. /v1/rcs/agents (RCS).

Read-only key: An API key with permission: "read". Any non-GET request fails with read_only_key.

Recycling: Republishing an evergreen post on a schedule. Configured with recycling on a post; post.recycled fires for each copy (queues).

Request id: The X-Request-Id header on every response. Include it when you contact support (support).

Resource group: The area of the API an endpoint belongs to, such as publishing or ads. Keys can disable whole groups.

Review: A customer rating on Google Business Profile or Facebook, readable and answerable from the inbox. /v1/inbox/reviews (reviews).

Role: A member's level of access: owner, admin, member, viewer or billing (roles).

#S

Sandbox (WhatsApp): A shared test number you can message from your own phone without setting up a WhatsApp Business Account. /v1/whatsapp/sandbox/sessions (sandbox).

scheduledFor: When a post, or one target, should publish. Read in timezone when you send one (scheduling).

Scopes: The permissions a platform grants at connect time. Some connect calls take scopes to ask for more or fewer (scopes).

Segment (SMS): The unit SMS is billed in: up to 160 plain characters, or fewer with emoji and other special characters.

Selection step: The part of a connect flow where the owner picks which Page, organisation, board or location to connect.

Sender ID: An alphanumeric name shown instead of a number on SMS in countries that allow it. /v1/sms/sender-ids (sender IDs).

Sequence: A series of timed messages that contacts are enrolled in, stopping when they reply. /v1/sequences (sequences).

Signature: The X-Pozy-Signature header on each webhook: a hex HMAC-SHA256 of the raw body using the endpoint's secret (verify signatures).

SIP trunk: A connection that routes calls on your Pozy numbers to and from your own phone system. /v1/phone-numbers/sip-trunks (SIP trunks).

Status (post): A post's state: draft, pending_approval, scheduled, publishing, published, partial, failed or cancelled (lifecycle).

#T

Target: One account a post goes to, an entry in the post's platforms array with its own status and URL.

Template (WhatsApp): A pre-approved message format required to start a WhatsApp conversation outside the 24-hour window. /v1/whatsapp/templates (templates).

Thread: A chain of posts published as replies to each other, on X, Threads and Bluesky (threads).

Timezone: An IANA name such as Europe/Madrid sent with scheduledFor so local times are read correctly.

Tracking window: A period, 30 days by default and up to 90, during which Pozy records every reading of a post's metrics. /v1/analytics/tracking; post.tracking_completed fires after the final read (tracking).

#U

Usage: What the workspace used and spent in a period, by day, product, profile or account. GET /v1/usage (usage).

#V

Validation: Checking a post, its length or its media against platform rules before publishing. /v1/tools/validate/* (validation).

Voice agent: An AI agent that answers or places phone calls on a Pozy number (AI voice agents).

#W

WABA: WhatsApp Business Account, the Meta account that owns WhatsApp numbers, templates and flows (WhatsApp).

Webhook endpoint: A URL, a secret and a list of events that Pozy delivers to. /v1/webhooks/settings (webhooks).

Welcome screen: A branded page shown at the start of hosted connect, saved with PUT /v1/connect/welcome-screen (welcome screen).

Workflow: A graph of triggers, messages, waits and conditions that runs on DMs, comments and other events. /v1/workflows (workflows).

Workspace: Your team in Pozy. It owns profiles, keys, webhooks and billing, and every request is scoped to one (concepts).

#X

X: The platform formerly called Twitter. Its id in the API is twitter. X bills every API call, so Pozy bills X usage per call (pricing).

X spend cap: A monthly limit on X costs. At the cap, billable X calls pause until the 1st (billing).