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

Cloud API

View as Markdown

Embedded signup

POST/messaging/cloud-api/embedded-signupMessaging API
Base URL
https://api.polymorfa.com
Required permission
quicklink:manage

Body

  • quicklinkIdstringrequiredpattern^ql_[a-zA-Z0-9]+$

    Identifier for the quicklink.

  • projectIdstring (uuid)

    Identifier of the Polymorfa project that owns this resource.

  • resultobject

    Specifies result for this native embedded signup request.

    Show 5 child fields

Responses

  • 200Onboarding progress
    • successbooleanrequired

      Whether the request succeeded.

      Allowed valuestrue
    • dataobjectrequired

      Structured data carried by this object.

      Show 1 child field
    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
  • 410Direct session signup was retired; create a QuickLink first
  • 500Internal server error
POST /messaging/cloud-api/embedded-signupcURL
Not available with the Test key. Use a team key or project token.
curl -X POST "https://api.polymorfa.com/messaging/cloud-api/embedded-signup" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Polymorfa-Version: 2026-09-22" \
  -H "Content-Type: application/json" \
  -d '{
  "quicklinkId": "string"
}'
Response
{
  "success": true,
  "data": {
    "stage": "string"
  }
}