Skip to content
Shortcut: /, ⌘K or Ctrl+K

Glossary

Look up the terms the Polymorfa docs, Console and API use.

View as Markdown

Terms are in alphabetical order. Search matches each term and its definition. Text in code is a literal API value.

19 terms

TermDefinition
BanSafe

Polymorfa's account-safety system for real Numbers. It estimates each eligible Number's Health, records findings and offers protections such as Safe Mode, the warm-up plan and Ban Credit. See Safety.

Client token

A short-lived credential with the prefix pmfa_ct_ for browser and mobile code. A team key or project token mints it, limited to one Number or Customer and the actions you allow. A client token can't mint other credentials. See Client tokens.

Console

The Polymorfa web app where you manage teams, projects, Numbers, credentials, webhooks and billing. See Use the Console.

Customer

A record for a person or business that owns Numbers in your project. Turn on Customers to give every Number an explicit owner and to send Customer pairing links. See Customers.

Event

A record of something that happened, such as message.received or session.status. Polymorfa delivers events to webhook endpoints and event streams, and keeps a bounded event history. See Events.

Idempotency key

A unique value you send in the Idempotency-Key header so a retried write runs at most once. Some methods accept it and some require it, such as webhook changes. See Idempotent requests.

Inspector

Polymorfa Inspector, the desktop app that opens your real and test Numbers as a WhatsApp client so you can see and act on their conversations. Inspector requires access. See Install Inspector.

Number

One connected WhatsApp account. A Number is either a real number or a test number. The API calls it a session. See Numbers.

Pay-As-You-Go

The paid billing mode for a team. It removes the Free project limit, allows QuickLinks for real numbers and charges credits for each real Number. See Billing.

Polymorfa-Version

The request header that pins the Messaging and Platform API contract date, such as 2026-09-22. Without it, the API uses the current version. See Versioning.

Project

The boundary for Numbers, project tokens, webhook endpoints, campaigns, templates and settings inside a team. See Teams and projects.

Project token

A credential with the prefix pmfa_pt_ that works only inside one project, with the permissions selected when it was created. Created in the Console and shown once. See API keys.

Safe Mode

A BanSafe setting that makes a real Number send the way a person does, with presence, typing indicators, read receipts and pacing. Every setting is off until you turn it on. See Safe Mode.

Session

The API name for a Number. The Number ID is the {session} value in Messaging API paths and the sessionId field in Platform API responses.

Team

Your Polymorfa account. A team owns members, billing, team keys and projects. It is on Free or Pay-As-You-Go. See Teams and projects.

Team key

A credential with the prefix pmfa_ for your servers. Its permissions apply across the team and all of its projects. Created in the Console and shown once. See API keys.

Test number

A simulated Number for development. It messages only other test numbers in the same project and never reaches WhatsApp. Test numbers have testMode: true and require access. See Testing.

Webhook endpoint

An HTTPS URL you register to receive events. Each endpoint has its event types, a format and a signing secret used for the X-Webhook-Signature header. See Webhooks.

See also#