QuickLinks
Saved QuickLink settings for one scope. logoUrl is a short-lived read URL for the saved logo.
The QuickLink object
Attributes
idstringrequiredStable QuickLink identifier, prefixed
ql_.urlstringrequiredHosted connection URL. Share it only with the person holding the phone.
sessionstringrequiredSession name that receives the connected number.
expiresAtstringrequirednullableNull for new persistent QuickLinks. Legacy links retain their ISO-8601 expiry.
{
"id": "string",
"url": "string",
"session": "string",
"expiresAt": "string"
}The QuickLink state object
Attributes
testingobjectrequirednullableStructured testing values for this native quick link state.
Show 5 child fields
historyConfigurationobjectrequirednullableStructured history configuration values for this native quick link state.
Show 2 child fields
historyConsentstringrequirednullableSpecifies history consent for this native quick link state.
Allowed valuespendingaccepteddeclinedidstringrequiredIdentifier for this resource.
statusstringrequiredCurrent status of this resource or operation.
Allowed valuespendingopenedlinkedconnectedfailedcancelledexpiresAtstringrequirednullableISO 8601 timestamp when this resource expires.
redirectUrlstring (uri)nullableSnapshotted failure callback for a failed link. Omitted for non-failed states.
connectionsarray of stringrequiredConnections associated with this native quick link state.
Allowed valuescloudlinkedselectedConnectionstringrequirednullableSpecifies selected connection for this native quick link state.
Allowed valuescloudlinkedconnectionPreferencestringrequiredSpecifies connection preference for this native quick link state.
Allowed valuescloudlinkedbothconnectionEnforcementstringrequiredSpecifies connection enforcement for this native quick link state.
Allowed valuespreferforcecloudobjectrequirednullableStructured cloud values for this native quick link state.
Show 2 child fields
onboardingobjectrequirednullableStructured onboarding values for this native quick link state.
Show 8 child fields
methodsarray of stringrequiredConnection methods enabled for the widget.
Allowed valuesqrpairingdefaultMethodstringrequirednullableSpecifies default method for this native quick link state.
Allowed valuesqrpairingbusinessNamestringrequiredBusiness name shown to the customer.
headlinestringrequirednullableSpecifies headline for this native quick link state.
descriptionstringrequirednullableHuman-readable description of this resource.
successMessagestringrequirednullableSpecifies success message for this native quick link state.
supportUrlstringrequirednullableURL for the support.
privacyUrlstringrequirednullableURL for the privacy.
termsUrlstringrequirednullableURL for the terms.
themestringrequiredVisual theme used by the widget.
Allowed valueslightdarksystemaccentstringrequirednullableSpecifies accent for this native quick link state.
shapestringrequirednullableSpecifies shape for this native quick link state.
Allowed valuessquareroundedpillradiusPxnumberrequirednullableSpecifies radius px for this native quick link state.
logoUrlstringrequirednullableURL for the logo.
hideWatermarkbooleanrequiredWhether hide watermark.
historySyncstringrequiredHistory synchronization behavior for newly connected sessions.
Allowed valuesaskforce_onforce_offphoneStepobjectrequiredStructured phone step values for this native quick link state.
Show 4 child fields
prefillPhonestringrequirednullableSpecifies prefill phone for this native quick link state.
phoneIdentityobjectrequirednullableStructured phone identity values for this native quick link state.
Show 6 child fields
customerbooleanrequiredTrue when the link assigns the number to a Customer.
sessionobjectrequiredIdentifier of the connected Polymorfa session.
Show 2 child fields
qrSvgstringrequirednullableInline SVG of the current WhatsApp QR code, when the QR method is offered and the number is not linked yet.
passkeyAvailablebooleanWhether passkey pairing is available. State reads and cancellation remain available when false.
passkeyConfirmationobjectnullableStructured passkey confirmation values for this native quick link state.
Show 5 child fields
passkeyobjectnullablePending passkey challenge ticket for WebAuthn authentication.
Show 6 child fields
tunnelAvailablebooleanWhether a new secure pairing channel may currently be admitted for this link.
errorCodestringrequirednullableMachine-readable error code for this native quick link state.
{
"testing": {
"country": "string",
"configuration": {
"profile": {
"name": "string",
"status": "string"
},
"accountType": "whatsapp_app",
"primaryPlatform": "android",
"replyBehavior": "off",
"failureScenario": "none",
"historyFixtureId": "00000000-0000-4000-8000-000000000000"
},
"editable": [
"profile.name"
],
"state": "pending",
"phone": "string"
},
"historyConfiguration": {
"mode": "metadata_only",
"requestFull": true
},
"historyConsent": "pending",
"id": "string",
"status": "pending",
"expiresAt": "string",
"redirectUrl": "https://example.com",
"connections": [
"cloud"
],
"selectedConnection": "cloud",
"connectionPreference": "cloud",
"connectionEnforcement": "prefer",
"cloud": {
"appId": "string",
"configId": "string"
},
"onboarding": {
"stage": "string",
"connection": "string",
"coexistence": true,
"contactsSync": "string",
"historySync": "string",
"historyProgress": 0,
"errorCode": "string",
"sync": {
"contacts": {
"request": "not_applicable",
"receiptRecorded": true
},
"history": {
"request": "not_applicable",
"receiptRecorded": true,
"delivery": "not_applicable"
}
}
},
"methods": [
"qr"
],
"defaultMethod": "qr",
"businessName": "string",
"headline": "string",
"description": "string",
"successMessage": "string",
"supportUrl": "string",
"privacyUrl": "string",
"termsUrl": "string",
"theme": "light",
"accent": "string",
"shape": "square",
"radiusPx": 0,
"logoUrl": "string",
"hideWatermark": true,
"historySync": "ask",
"phoneStep": {
"confirmed": true,
"allowChange": true,
"noNumber": true,
"allowNoNumber": true
},
"prefillPhone": "string",
"phoneIdentity": {
"registered": true,
"phone": "string",
"whatsappPhone": "string",
"accountType": "whatsapp",
"pushName": "string",
"pictureUrl": "https://example.com"
},
"customer": true,
"session": {
"status": "string",
"phone": "string"
},
"qrSvg": "string",
"passkeyAvailable": true,
"passkeyConfirmation": {
"status": "none",
"ticketId": "string",
"code": "string",
"skipHandoffUX": true,
"error": "string"
},
"passkey": {
"ticket": "string",
"challengeB64Url": "string",
"rpId": "string",
"userVerification": "preferred",
"expiresAt": "string",
"timeoutMs": 0
},
"tunnelAvailable": true,
"errorCode": "string"
}The QuickLink settings object
Attributes
idstring (uuid)requiredIdentifier for this resource.
projectIdstring (uuid)requirednullableIdentifier of the Polymorfa project that owns this resource.
enabledbooleanrequiredWhether this feature is enabled.
successCallbackUrlstring (uri)requirednullableProject-owned HTTPS destination after connection confirmation.
failureCallbackUrlstring (uri)requirednullableProject-owned HTTPS destination after cancellation.
businessNamestringrequirednullableBusiness name shown to the customer.
headlinestringrequirednullableSpecifies headline for this management quick link setting.
descriptionstringrequirednullableHuman-readable description of this resource.
successMessagestringrequirednullableSpecifies success message for this management quick link setting.
supportUrlstringrequirednullableURL for the support.
privacyUrlstringrequirednullableURL for the privacy.
termsUrlstringrequirednullableURL for the terms.
accentstringrequirednullableSpecifies accent for this management quick link setting.
themestringrequiredVisual theme used by the widget.
Allowed valueslightdarksystemhideWatermarkbooleanrequiredSaved preference to hide Powered by Polymorfa. QuickLink pages hide it only while the team is active and has a Branded QuickLink add-on.
allowPhoneChangebooleanrequiredAllow recipients to change a prefilled phone number. Defaults to false.
shapestringrequirednullableSpecifies shape for this management quick link setting.
Allowed valuessquareroundedpillradiusPxnumberrequirednullableSpecifies radius px for this management quick link setting.
logoModestringrequiredBehavior selected for logo.
Allowed valuesnonecustomteamprojectlogoStorageIdstringrequirednullableIdentifier for the logo storage.
logoSourceStorageIdstringrequirednullableIdentifier for the logo source storage.
logoUrlstringrequirednullableURL for the logo.
historySyncstringrequiredHistory synchronization behavior for newly connected sessions.
Allowed valuesaskforce_onforce_offmethodsarray of stringrequirednullableConnection methods enabled for the widget.
Allowed valuesqrpairingdefaultMethodstringrequirednullableSpecifies default method for this management quick link setting.
Allowed valuesqrpairingcreatedAtintegerrequiredUnix timestamp in milliseconds when this resource was created.
updatedAtintegerrequiredUnix timestamp in milliseconds when this resource was last updated.
{
"id": "00000000-0000-4000-8000-000000000000",
"projectId": "00000000-0000-4000-8000-000000000000",
"enabled": true,
"successCallbackUrl": "https://example.com",
"failureCallbackUrl": "https://example.com",
"businessName": "string",
"headline": "string",
"description": "string",
"successMessage": "string",
"supportUrl": "string",
"privacyUrl": "string",
"termsUrl": "string",
"accent": "string",
"theme": "light",
"hideWatermark": true,
"allowPhoneChange": true,
"shape": "square",
"radiusPx": 0,
"logoMode": "none",
"logoStorageId": "string",
"logoSourceStorageId": "string",
"logoUrl": "string",
"historySync": "ask",
"methods": [
"qr"
],
"defaultMethod": "qr",
"createdAt": 0,
"updatedAt": 0
}Create quick link
- Base URL
https://api.polymorfa.com- Required permission
quicklink:manage
Creates a persistent hosted link that connects one WhatsApp number to a new session in the project.
Body
signalModestringSignal key custody for a new Number. Inherits Customer then Project default; cannot change an existing Number. Customer-owned custody requires beta admission and real Linked Devices.
Allowed valuesstandardzero_knowledgeprojectIdstring (uuid)Project that receives the connected number. Required for team keys with more than one project.
customerIdstring (uuid)Customer that owns the connected number when Customers is enabled for the project.
billingControlsobjectInitial monthly spending limit and funding priority for a real Number. Requires a team key with billing:manage or a live team owner/admin on Pay-As-You-Go. Applied atomically before pairing admission.
Show 2 child fields
externalIdstringlength1–256pattern^[^\x00-\x1f\x7f]+$Integrator correlation copied to the resulting session. May repeat across invitations; does not grant access.
configurationobjectSpecifies configuration for this native create quick link request.
Show 10 child fields
Responses
201QuickLink created
successbooleanrequiredWhether the request succeeded.
Allowed valuestruedataobjectrequiredStructured data carried by this object.
Show 4 child fields
Show 3 headers
400Bad request — request body or params failed validation
401Missing or invalid authentication token
403Authenticated but not permitted (missing scope or rule violation)
404Resource not found
500Internal server error
curl -X POST "https://api.polymorfa.com/messaging/quicklinks" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22" \
-H "Content-Type: application/json" \
-d '{
"signalMode": "standard",
"projectId": "00000000-0000-4000-8000-000000000000",
"customerId": "00000000-0000-4000-8000-000000000000",
"billingControls": {
"limitCredits": 0,
"priority": 0
},
"externalId": "string",
"configuration": {
"testing": {
"country": "string",
"configuration": {
"profile": {
"name": "string",
"status": "string"
},
"accountType": "whatsapp_app",
"primaryPlatform": "android",
"replyBehavior": "off",
"failureScenario": "none",
"historyFixtureId": "00000000-0000-4000-8000-000000000000"
},
"editable": [
"profile.name"
]
},
"prefillPhone": "string",
"connectionPreference": "cloud",
"connectionEnforcement": "prefer",
"methods": [
"qr"
],
"defaultMethod": "qr",
"allowPhoneChange": true,
"historySync": {
"mode": "metadata_only",
"requestFull": true,
"delivery": "descriptor",
"consent": "ask"
},
"hms": {
"enabled": false
},
"observation": {
"presenceMode": "off",
"typingMode": "off",
"labelMode": "off",
"quickReplyMode": "off"
}
}
}'{
"success": true,
"data": {
"id": "string",
"url": "string",
"session": "string",
"expiresAt": "string"
}
}Start quick link testing
- Base URL
https://api.polymorfa.com
Path parameters
tokenstringrequiredOpaque token required by the target operation.
Responses
200Current test connection state
dataobjectrequiredStructured data carried by this object.
Show 40 child fields
400QuickLink request failed
403QuickLink request failed
404QuickLink request failed
409QuickLink request failed
422QuickLink request failed
429QuickLink request failed
500QuickLink request failed
503QuickLink request failed
curl -X POST "https://api.polymorfa.com/quicklink/<token>/testing/start" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22"{
"data": {
"testing": {
"country": "string",
"configuration": {
"profile": {
"name": "string",
"status": "string"
},
"accountType": "whatsapp_app",
"primaryPlatform": "android",
"replyBehavior": "off",
"failureScenario": "none",
"historyFixtureId": "00000000-0000-4000-8000-000000000000"
},
"editable": [
"profile.name"
],
"state": "pending",
"phone": "string"
},
"historyConfiguration": {
"mode": "metadata_only",
"requestFull": true
},
"historyConsent": "pending",
"id": "string",
"status": "pending",
"expiresAt": "string",
"connections": [
"cloud"
],
"selectedConnection": "cloud",
"connectionPreference": "cloud",
"connectionEnforcement": "prefer",
"cloud": {
"appId": "string",
"configId": "string"
},
"onboarding": {
"stage": "string",
"connection": "string",
"coexistence": true,
"contactsSync": "string",
"historySync": "string",
"historyProgress": 0,
"errorCode": "string",
"sync": {
"contacts": {
"request": "not_applicable",
"receiptRecorded": true
},
"history": {
"request": "not_applicable",
"receiptRecorded": true,
"delivery": "not_applicable"
}
}
},
"methods": [
"qr"
],
"defaultMethod": "qr",
"businessName": "string",
"headline": "string",
"description": "string",
"successMessage": "string",
"supportUrl": "string",
"privacyUrl": "string",
"termsUrl": "string",
"theme": "light",
"accent": "string",
"shape": "square",
"radiusPx": 0,
"logoUrl": "string",
"hideWatermark": true,
"historySync": "ask",
"phoneStep": {
"confirmed": true,
"allowChange": true,
"noNumber": true,
"allowNoNumber": true
},
"prefillPhone": "string",
"phoneIdentity": {
"registered": true,
"phone": "string",
"whatsappPhone": "string",
"accountType": "whatsapp",
"pushName": "string",
"pictureUrl": "https://example.com"
},
"customer": true,
"session": {
"status": "string",
"phone": "string"
},
"qrSvg": "string",
"errorCode": "string"
}
}Get quick link
- Base URL
https://api.polymorfa.com- Required permission
quicklink:manage
Path parameters
idstringrequiredIdentifier for this resource.
Responses
200Current QuickLink status
successbooleanrequiredWhether the request succeeded.
Allowed valuestruedataobjectrequiredStructured data carried by this object.
Show 9 child fields
Show 3 headers
400Bad request — request body or params failed validation
401Missing or invalid authentication token
403Authenticated but not permitted (missing scope or rule violation)
404Resource not found
500Internal server error
curl "https://api.polymorfa.com/messaging/quicklinks/<id>" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22"{
"success": true,
"data": {
"id": "string",
"status": "pending",
"session": "string",
"expiresAt": "string",
"openedAt": "string",
"connectedAt": "string",
"phone": "string",
"errorCode": "string"
}
}Get quick link state
- Base URL
https://api.polymorfa.com
Returns the hosted page state for a QuickLink. Public; the token in the URL is the credential. Starts linked-device pairing after an allowed connection type has been selected.
Path parameters
tokenstringrequiredOpaque token required by the target operation.
Headers
X-Polymorfa-Passkey-Contextstringpattern^[A-Za-z0-9_-]{43}$Specifies x polymorfa passkey context for this header parameter.
Responses
200Current QuickLink state
dataobjectrequiredStructured data carried by this object.
Show 40 child fields
400QuickLink request failed
403QuickLink request failed
404QuickLink request failed
409QuickLink request failed
422QuickLink request failed
429QuickLink request failed
500QuickLink request failed
503QuickLink request failed
curl "https://api.polymorfa.com/quicklink/<token>" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22"{
"data": {
"testing": {
"country": "string",
"configuration": {
"profile": {
"name": "string",
"status": "string"
},
"accountType": "whatsapp_app",
"primaryPlatform": "android",
"replyBehavior": "off",
"failureScenario": "none",
"historyFixtureId": "00000000-0000-4000-8000-000000000000"
},
"editable": [
"profile.name"
],
"state": "pending",
"phone": "string"
},
"historyConfiguration": {
"mode": "metadata_only",
"requestFull": true
},
"historyConsent": "pending",
"id": "string",
"status": "pending",
"expiresAt": "string",
"connections": [
"cloud"
],
"selectedConnection": "cloud",
"connectionPreference": "cloud",
"connectionEnforcement": "prefer",
"cloud": {
"appId": "string",
"configId": "string"
},
"onboarding": {
"stage": "string",
"connection": "string",
"coexistence": true,
"contactsSync": "string",
"historySync": "string",
"historyProgress": 0,
"errorCode": "string",
"sync": {
"contacts": {
"request": "not_applicable",
"receiptRecorded": true
},
"history": {
"request": "not_applicable",
"receiptRecorded": true,
"delivery": "not_applicable"
}
}
},
"methods": [
"qr"
],
"defaultMethod": "qr",
"businessName": "string",
"headline": "string",
"description": "string",
"successMessage": "string",
"supportUrl": "string",
"privacyUrl": "string",
"termsUrl": "string",
"theme": "light",
"accent": "string",
"shape": "square",
"radiusPx": 0,
"logoUrl": "string",
"hideWatermark": true,
"historySync": "ask",
"phoneStep": {
"confirmed": true,
"allowChange": true,
"noNumber": true,
"allowNoNumber": true
},
"prefillPhone": "string",
"phoneIdentity": {
"registered": true,
"phone": "string",
"whatsappPhone": "string",
"accountType": "whatsapp",
"pushName": "string",
"pictureUrl": "https://example.com"
},
"customer": true,
"session": {
"status": "string",
"phone": "string"
},
"qrSvg": "string",
"errorCode": "string"
}
}Get quick link logo
- Base URL
https://api.polymorfa.com
Returns the saved logo image for the page. Public; the token in the URL is the credential.
Path parameters
tokenstringrequiredOpaque token required by the target operation.
Responses
200Logo image
Content type
image/png400QuickLink request failed
403QuickLink request failed
404QuickLink request failed
409QuickLink request failed
422QuickLink request failed
429QuickLink request failed
500QuickLink request failed
503QuickLink request failed
curl "https://api.polymorfa.com/quicklink/<token>/logo" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22"Content type image/png
No example for this content type
Get quick link settings
- Base URL
https://api.polymorfa.com- Required permission
quicklink:manage
Returns the saved QuickLink settings for the authenticated team or one project, or null when nothing has been saved for that scope. There is no separate read permission: reading and updating both require quicklink:manage, because the settings include the redirect allowlist and branding that only a QuickLink manager should see.
Requires quicklink:manage. Project tokens only access resources in their own project.
Query parameters
projectIdstringIdentifier of the Polymorfa project that owns this resource.
Responses
200Success
dataobjectrequirednullableStructured data carried by this object.
Show 27 child fields
Show 3 headers
401Missing/invalid credential for this audience.
403Authenticated but lacks the required scope/role/audience.
curl "https://api.polymorfa.com/platform/quicklink" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22"{
"data": {
"id": "00000000-0000-4000-8000-000000000000",
"projectId": "00000000-0000-4000-8000-000000000000",
"enabled": true,
"successCallbackUrl": "https://example.com",
"failureCallbackUrl": "https://example.com",
"businessName": "string",
"headline": "string",
"description": "string",
"successMessage": "string",
"supportUrl": "string",
"privacyUrl": "string",
"termsUrl": "string",
"accent": "string",
"theme": "light",
"hideWatermark": true,
"allowPhoneChange": true,
"shape": "square",
"radiusPx": 0,
"logoMode": "none",
"logoStorageId": "string",
"logoSourceStorageId": "string",
"logoUrl": "string",
"historySync": "ask",
"methods": [
"qr"
],
"defaultMethod": "qr",
"createdAt": 0,
"updatedAt": 0
}
}Update quick link settings
- Base URL
https://api.polymorfa.com- Required permission
quicklink:manage
Updates the saved QuickLink settings for the authenticated team or project and returns the saved record. Privacy and terms links are optional and shown when supplied. Setting hideWatermark to true without an active Branded QuickLink add-on returns 402 with code addon_required.
Requires quicklink:manage. Project tokens only access resources in their own project.
Body
projectIdstring (uuid)Identifier of the Polymorfa project that owns this resource.
enabledbooleanAllows QuickLinks to be created for the scope.
successCallbackUrlstring (uri)nullablemax length2048pattern^[Hh][Tt][Tt][Pp][Ss]://Project-only destination after connection confirmation. Snapshotted when issuing a link.
failureCallbackUrlstring (uri)nullablemax length2048pattern^[Hh][Tt][Tt][Pp][Ss]://Project-only destination after cancellation. Snapshotted when issuing a link.
businessNamestringnullablemax length120Business name shown to the customer.
headlinestringnullablemax length80Page title shown above the pairing flow. Defaults to “Connect WhatsApp”.
descriptionstringnullablemax length280Intro sentence shown under the headline.
successMessagestringnullablemax length280Message shown after the number connects.
supportUrlstring (uri)nullablemax length2048pattern^[Hh][Tt][Tt][Pp][Ss]://Help link shown on the page.
privacyUrlstring (uri)nullablemax length2048pattern^[Hh][Tt][Tt][Pp][Ss]://Optional privacy notice link, shown on the consent step when supplied. Set null to clear it. Team-wide settings cannot hold it.
termsUrlstring (uri)nullablemax length2048pattern^[Hh][Tt][Tt][Pp][Ss]://Terms link shown on the consent step.
accentstringnullablepattern^#[0-9A-Fa-f]{6}$Specifies accent for this management update quick link settings request.
themestringVisual theme used by the widget.
Allowed valueslightdarksystemhideWatermarkbooleanHide Powered by Polymorfa. Setting
truerequires an active team with a Branded QuickLink add-on; otherwise the request returns402with codeaddon_required.allowPhoneChangebooleanAllow recipients to change a prefilled phone number. Defaults to false.
shapestringnullableSpecifies shape for this management update quick link settings request.
Allowed valuessquareroundedpillradiusPxnumbernullablerange0–999Specifies radius px for this management update quick link settings request.
logoModestringBehavior selected for logo.
Allowed valuesnonecustomteamprojectlogoStorageIdstringnullableIdentifier for the logo storage.
logoSourceStorageIdstringnullableIdentifier for the logo source storage.
historySyncstringHistory synchronization behavior for newly connected sessions.
Allowed valuesaskforce_onforce_offmethodsarray of stringnullableitems1–2unique itemsConnection methods offered on hosted QuickLink pages.
Allowed valuesqrpairingdefaultMethodstringnullableMethod the page opens first. Unset lets the page choose by device.
Allowed valuesqrpairing
Responses
200Success
dataobjectrequiredStructured data carried by this object.
Show 27 child fields
Show 3 headers
400A path, query, or request-body value did not pass validation.
401Missing/invalid credential for this audience.
402`addon_required`: the request uses a benefit of an add-on that your team does not have active.
403Authenticated but lacks the required scope/role/audience.
curl -X PUT "https://api.polymorfa.com/platform/quicklink" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22" \
-H "Content-Type: application/json" \
-d '{
"projectId": "00000000-0000-4000-8000-000000000000",
"enabled": true,
"successCallbackUrl": "https://example.com",
"failureCallbackUrl": "https://example.com",
"businessName": "string",
"headline": "string",
"description": "string",
"successMessage": "string",
"supportUrl": "https://example.com",
"privacyUrl": "https://example.com",
"termsUrl": "https://example.com",
"accent": "string",
"theme": "light",
"hideWatermark": true,
"allowPhoneChange": true,
"shape": "square",
"radiusPx": 0,
"logoMode": "none",
"logoStorageId": "string",
"logoSourceStorageId": "string",
"historySync": "ask",
"methods": [
"qr"
],
"defaultMethod": "qr"
}'{
"data": {
"id": "00000000-0000-4000-8000-000000000000",
"projectId": "00000000-0000-4000-8000-000000000000",
"enabled": true,
"successCallbackUrl": "https://example.com",
"failureCallbackUrl": "https://example.com",
"businessName": "string",
"headline": "string",
"description": "string",
"successMessage": "string",
"supportUrl": "string",
"privacyUrl": "string",
"termsUrl": "string",
"accent": "string",
"theme": "light",
"hideWatermark": true,
"allowPhoneChange": true,
"shape": "square",
"radiusPx": 0,
"logoMode": "none",
"logoStorageId": "string",
"logoSourceStorageId": "string",
"logoUrl": "string",
"historySync": "ask",
"methods": [
"qr"
],
"defaultMethod": "qr",
"createdAt": 0,
"updatedAt": 0
}
}Exchange customer pairing link
- Base URL
https://api.polymorfa.com
Exchanges the invitation token in the request body for a hosted QuickLink URL. The invitation token is the credential; no API key is required. This request creates or resumes pairing and can affect the invitation's attempt limits. Open the returned URL to continue setup. The response is JSON, not an HTTP redirect. A lost response or a temporary error can follow pairing effects. Do not automatically replay this POST; Idempotency-Key is not supported. The returned expiry describes the QuickLink, not the Customer invitation. A missing business privacy link does not block the exchange.
Body
tokenstringrequiredpattern^[A-Za-z0-9_-]{43}$The 43-character base64url token from the Customer invitation. Keep it private.
Responses
200Hosted QuickLink URL for this invitation
dataobjectrequiredStructured data carried by this object.
Show 2 child fields
Show 2 headers
410`pairing_link_unavailable`: malformed, unknown, expired, revoked or unusable invitation. No replacement token or invitation details are disclosed.
429`pairing_rate_limited`: a source or invitation abuse limit rejected the request; or `pairing_link_attempts_exhausted`: the invitation reached its attempt limit. No Retry-After value is supplied by this operation.
503`pairing_temporarily_unavailable`: pairing could not complete. Effects can already have occurred; do not assume the request was unconsumed or automatically replay it.
curl -X POST "https://api.polymorfa.com/messaging/customer-pairing/exchange" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22" \
-H "Content-Type: application/json" \
-d '{
"token": "string"
}'{
"data": {
"url": "string",
"expiresAt": "string"
}
}Cancel quick link
- Base URL
https://api.polymorfa.com- Required permission
quicklink:manage
Cancels pending onboarding. Initial Number cleanup is accepted asynchronously and completes only after runtime teardown. Supplementary and reauthorization links cancel only their pending attempts; the existing Number remains. Accepted provider work must finish before cancellation.
Path parameters
idstringrequiredIdentifier for this resource.
Responses
200Cancelled
successbooleanrequiredWhether the request succeeded.
Allowed valuestruemessagestringrequiredHuman-readable message associated with this result.
Show 3 headers
202QuickLink invalidated; Number cleanup pending
400Bad request — request body or params failed validation
401Missing or invalid authentication token
403Authenticated but not permitted (missing scope or rule violation)
404Resource not found
500Internal server error
curl -X DELETE "https://api.polymorfa.com/messaging/quicklinks/<id>" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22"{
"success": true,
"message": "string"
}Confirm quick link phone
- Base URL
https://api.polymorfa.com
Path parameters
tokenstringrequiredOpaque token required by the target operation.
Body
phonestringmax length32Phone number in international format.
noNumberbooleanWhether no number.
Allowed valuestruewhatsappPhonestringmax length32Specifies whatsapp phone for this schema.
Responses
200Phone confirmed
dataobjectrequiredStructured data carried by this object.
Show 1 child field
400QuickLink request failed
403QuickLink request failed
404QuickLink request failed
409QuickLink request failed
422QuickLink request failed
429QuickLink request failed
500QuickLink request failed
503QuickLink request failed
curl -X POST "https://api.polymorfa.com/quicklink/<token>/phone" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22" \
-H "Content-Type: application/json" \
-d '{
"phone": "string",
"noNumber": true,
"whatsappPhone": "string"
}'{
"data": {
"confirmed": true
}
}Reset quick link phone
- Base URL
https://api.polymorfa.com
Path parameters
tokenstringrequiredOpaque token required by the target operation.
Responses
200Phone entry restored
dataobjectrequiredStructured data carried by this object.
Show 1 child field
400QuickLink request failed
403QuickLink request failed
404QuickLink request failed
409QuickLink request failed
422QuickLink request failed
429QuickLink request failed
500QuickLink request failed
503QuickLink request failed
curl -X POST "https://api.polymorfa.com/quicklink/<token>/phone/reset" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22"{
"data": {
"confirmed": true
}
}Select quick link connection
- Base URL
https://api.polymorfa.com
Path parameters
tokenstringrequiredOpaque token required by the target operation.
Body
connectionstringrequiredSpecifies connection for this schema.
Allowed valuescloudlinked
Responses
200Selected
dataobjectrequiredStructured data carried by this object.
Show 1 child field
400QuickLink request failed
403QuickLink request failed
404QuickLink request failed
409QuickLink request failed
422QuickLink request failed
429QuickLink request failed
500QuickLink request failed
503QuickLink request failed
curl -X POST "https://api.polymorfa.com/quicklink/<token>/connection" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22" \
-H "Content-Type: application/json" \
-d '{
"connection": "cloud"
}'{
"data": {
"connection": "cloud"
}
}Complete quick link cloud signup
- Base URL
https://api.polymorfa.com
Path parameters
tokenstringrequiredOpaque token required by the target operation.
Body
resultobjectSpecifies result for this schema.
Show 5 child fields
Responses
200Onboarding progress
dataobjectrequiredStructured data carried by this object.
Show 1 child field
400QuickLink request failed
403QuickLink request failed
404QuickLink request failed
409QuickLink request failed
422QuickLink request failed
429QuickLink request failed
500QuickLink request failed
503QuickLink request failed
curl -X POST "https://api.polymorfa.com/quicklink/<token>/cloud" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22" \
-H "Content-Type: application/json" \
-d '{
"result": {
"code": "string",
"wabaId": "string",
"phoneNumberId": "string"
}
}'{
"data": {
"stage": "string"
}
}Choose quick link history
- Base URL
https://api.polymorfa.com
Path parameters
tokenstringrequiredOpaque token required by the target operation.
Body
historySyncbooleanrequiredHistory synchronization behavior for newly connected sessions.
Responses
200History choice recorded
dataobjectrequiredStructured data carried by this object.
Show 40 child fields
400QuickLink request failed
403QuickLink request failed
404QuickLink request failed
409QuickLink request failed
422QuickLink request failed
429QuickLink request failed
500QuickLink request failed
503QuickLink request failed
curl -X POST "https://api.polymorfa.com/quicklink/<token>/history" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22" \
-H "Content-Type: application/json" \
-d '{
"historySync": true
}'{
"data": {
"testing": {
"country": "string",
"configuration": {
"profile": {
"name": "string",
"status": "string"
},
"accountType": "whatsapp_app",
"primaryPlatform": "android",
"replyBehavior": "off",
"failureScenario": "none",
"historyFixtureId": "00000000-0000-4000-8000-000000000000"
},
"editable": [
"profile.name"
],
"state": "pending",
"phone": "string"
},
"historyConfiguration": {
"mode": "metadata_only",
"requestFull": true
},
"historyConsent": "pending",
"id": "string",
"status": "pending",
"expiresAt": "string",
"connections": [
"cloud"
],
"selectedConnection": "cloud",
"connectionPreference": "cloud",
"connectionEnforcement": "prefer",
"cloud": {
"appId": "string",
"configId": "string"
},
"onboarding": {
"stage": "string",
"connection": "string",
"coexistence": true,
"contactsSync": "string",
"historySync": "string",
"historyProgress": 0,
"errorCode": "string",
"sync": {
"contacts": {
"request": "not_applicable",
"receiptRecorded": true
},
"history": {
"request": "not_applicable",
"receiptRecorded": true,
"delivery": "not_applicable"
}
}
},
"methods": [
"qr"
],
"defaultMethod": "qr",
"businessName": "string",
"headline": "string",
"description": "string",
"successMessage": "string",
"supportUrl": "string",
"privacyUrl": "string",
"termsUrl": "string",
"theme": "light",
"accent": "string",
"shape": "square",
"radiusPx": 0,
"logoUrl": "string",
"hideWatermark": true,
"historySync": "ask",
"phoneStep": {
"confirmed": true,
"allowChange": true,
"noNumber": true,
"allowNoNumber": true
},
"prefillPhone": "string",
"phoneIdentity": {
"registered": true,
"phone": "string",
"whatsappPhone": "string",
"accountType": "whatsapp",
"pushName": "string",
"pictureUrl": "https://example.com"
},
"customer": true,
"session": {
"status": "string",
"phone": "string"
},
"qrSvg": "string",
"errorCode": "string"
}
}Customize quick link testing
- Base URL
https://api.polymorfa.com
Path parameters
tokenstringrequiredOpaque token required by the target operation.
Body
profileobjectStructured profile values for this schema.
Show 2 child fields
accountTypestringHow the account uses WhatsApp.
whatsapp_app- WhatsApp app, connected as a linked device.
business_app- WhatsApp Business app, connected as a linked device.
meta_cloud- Meta Cloud API.
meta_coexistence- Meta Cloud API, with the WhatsApp Business app still active on the phone.
primaryPlatformstringPrimary phone platform the Test number emulates. Defaults to
android. Not accepted whenaccountTypeismeta_cloud.android- An Android phone.
ios- An iPhone.
replyBehaviorstringSpecifies reply behavior for this schema.
Allowed valuesoffechofailureScenariostringSpecifies failure scenario for this schema.
Allowed valuesnonereject-sendhistoryFixtureIdstring (uuid)Identifier for the history fixture.
Responses
200Test configuration updated
dataobjectrequiredStructured data carried by this object.
Show 40 child fields
400QuickLink request failed
403QuickLink request failed
404QuickLink request failed
409QuickLink request failed
422QuickLink request failed
429QuickLink request failed
500QuickLink request failed
503QuickLink request failed
curl -X PATCH "https://api.polymorfa.com/quicklink/<token>/testing" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22" \
-H "Content-Type: application/json" \
-d '{
"profile": {
"name": "string",
"status": "string"
},
"accountType": "whatsapp_app",
"primaryPlatform": "android",
"replyBehavior": "off",
"failureScenario": "none",
"historyFixtureId": "00000000-0000-4000-8000-000000000000"
}'{
"data": {
"testing": {
"country": "string",
"configuration": {
"profile": {
"name": "string",
"status": "string"
},
"accountType": "whatsapp_app",
"primaryPlatform": "android",
"replyBehavior": "off",
"failureScenario": "none",
"historyFixtureId": "00000000-0000-4000-8000-000000000000"
},
"editable": [
"profile.name"
],
"state": "pending",
"phone": "string"
},
"historyConfiguration": {
"mode": "metadata_only",
"requestFull": true
},
"historyConsent": "pending",
"id": "string",
"status": "pending",
"expiresAt": "string",
"connections": [
"cloud"
],
"selectedConnection": "cloud",
"connectionPreference": "cloud",
"connectionEnforcement": "prefer",
"cloud": {
"appId": "string",
"configId": "string"
},
"onboarding": {
"stage": "string",
"connection": "string",
"coexistence": true,
"contactsSync": "string",
"historySync": "string",
"historyProgress": 0,
"errorCode": "string",
"sync": {
"contacts": {
"request": "not_applicable",
"receiptRecorded": true
},
"history": {
"request": "not_applicable",
"receiptRecorded": true,
"delivery": "not_applicable"
}
}
},
"methods": [
"qr"
],
"defaultMethod": "qr",
"businessName": "string",
"headline": "string",
"description": "string",
"successMessage": "string",
"supportUrl": "string",
"privacyUrl": "string",
"termsUrl": "string",
"theme": "light",
"accent": "string",
"shape": "square",
"radiusPx": 0,
"logoUrl": "string",
"hideWatermark": true,
"historySync": "ask",
"phoneStep": {
"confirmed": true,
"allowChange": true,
"noNumber": true,
"allowNoNumber": true
},
"prefillPhone": "string",
"phoneIdentity": {
"registered": true,
"phone": "string",
"whatsappPhone": "string",
"accountType": "whatsapp",
"pushName": "string",
"pictureUrl": "https://example.com"
},
"customer": true,
"session": {
"status": "string",
"phone": "string"
},
"qrSvg": "string",
"errorCode": "string"
}
}Request quick link code
- Base URL
https://api.polymorfa.com
Path parameters
tokenstringrequiredOpaque token required by the target operation.
Body
phonestringrequiredlength6–20Phone number in international format.
Responses
200Pairing code issued
dataobjectrequiredStructured data carried by this object.
Show 2 child fields
400QuickLink request failed
402The team cannot fund pairing
403QuickLink request failed
404QuickLink request failed
409QuickLink request failed
422QuickLink request failed
429QuickLink request failed
500QuickLink request failed
503QuickLink request failed
curl -X POST "https://api.polymorfa.com/quicklink/<token>/code" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22" \
-H "Content-Type: application/json" \
-d '{
"phone": "string"
}'{
"data": {
"code": "string",
"phone": "string"
}
}Confirm quick link
- Base URL
https://api.polymorfa.com
Records consent, applies the chat-history choice, assigns Customer ownership when applicable, and returns the redirect target.
Path parameters
tokenstringrequiredOpaque token required by the target operation.
Body
historySyncbooleanHistory synchronization behavior for newly connected sessions.
Responses
200Connected
dataobjectrequiredStructured data carried by this object.
Show 4 child fields
400QuickLink request failed
403QuickLink request failed
404QuickLink request failed
409QuickLink request failed
422QuickLink request failed
429QuickLink request failed
500QuickLink request failed
503QuickLink request failed
curl -X POST "https://api.polymorfa.com/quicklink/<token>/confirm" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22" \
-H "Content-Type: application/json" \
-d '{
"historySync": true
}'{
"data": {
"status": "connected",
"phone": "string",
"historySync": true,
"redirectUrl": "string"
}
}Cancel quick link by token
- Base URL
https://api.polymorfa.com
Path parameters
tokenstringrequiredOpaque token required by the target operation.
Responses
200Cancelled
dataobjectrequiredStructured data carried by this object.
Show 2 child fields
202QuickLink invalidated; Number cleanup pending
400QuickLink request failed
403QuickLink request failed
404QuickLink request failed
409QuickLink request failed
422QuickLink request failed
429QuickLink request failed
500QuickLink request failed
503QuickLink request failed
curl -X POST "https://api.polymorfa.com/quicklink/<token>/cancel" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22"{
"data": {
"status": "cancelled",
"redirectUrl": "string"
}
}Confirm quick link passkey
- Base URL
https://api.polymorfa.com
The complete HTTP body is limited to 1048576 UTF-8 bytes before JSON parsing.
Path parameters
tokenstringrequiredOpaque token required by the target operation.
Body
ticketIdstringrequiredmin length1Identifier for the ticket.
codestringpattern^[A-Z0-9]{4}-[A-Z0-9]{4}$Stable machine-readable code for this result.
browserContextstringrequiredpattern^[A-Za-z0-9_-]{43}$The same in-memory browser context used to submit this assertion. Required even for skip-handoff and completed retries.
Responses
200Current passkey state; pairing may still be pending
dataobjectrequiredStructured data carried by this object.
Show 5 child fields
400QuickLink request failed
403QuickLink request failed
404QuickLink request failed
409Confirmation is unavailable for this attempt
- 413Passkey request body exceeds 1048576 bytes
422QuickLink request failed
429QuickLink request failed
500QuickLink request failed
503Confirmation is temporarily unavailable or its request deadline was exhausted
curl -X POST "https://api.polymorfa.com/quicklink/<token>/passkey/confirmation" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22" \
-H "Content-Type: application/json" \
-d '{
"ticketId": "string",
"browserContext": "string"
}'{
"data": {
"status": "none"
}
}Submit quick link passkey
- Base URL
https://api.polymorfa.com
The complete HTTP body is limited to 1048576 UTF-8 bytes before JSON parsing. Credential IDs allow at most 1023 decoded bytes; user handles allow 64. Opaque assertion fields share the body budget without independent small caps. Redeems a pending passkey ceremony challenge for the session bound to this QuickLink.
Path parameters
tokenstringrequiredOpaque token required by the target operation.
Body
ticketIdstringrequiredmin length1Identifier for the ticket.
browserContextstringrequiredpattern^[A-Za-z0-9_-]{43}$32 cryptographically random bytes, encoded as unpadded base64url. Create once per browser attempt and keep only in memory; reuse for retries, private polling and confirmation.
assertionobjectrequiredSpecifies assertion for this native quick link passkey submit request.
Show 3 child fields
Responses
200Passkey assertion accepted
dataobjectrequiredStructured data carried by this object.
Show 1 child field
400QuickLink request failed
403QuickLink request failed
404QuickLink request failed
409An assertion is already being forwarded for this ticket
410Passkey ticket expired
413Passkey assertion body exceeds 1048576 UTF-8 bytes before JSON parsing.
422Assertion validation or ticket binding failed
429QuickLink request failed
500QuickLink request failed
502Session runner rejected the assertion
503Assertion forwarding is temporarily unavailable or its request deadline was exhausted
curl -X POST "https://api.polymorfa.com/quicklink/<token>/passkey" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22" \
-H "Content-Type: application/json" \
-d '{
"ticketId": "string",
"browserContext": "string",
"assertion": {
"id": "string",
"rawIdB64Url": "string",
"response": {
"authenticatorDataB64": "string",
"clientDataJSONB64": "string",
"signatureB64": "string"
}
}
}'{
"data": {
"status": "submitted"
}
}