Create a magic link
Creates a new magic link that can be sent to an end user. The request body is discriminated by the flow field: each flow defines its own config payload (e.g. m2m accepts pre-filled user data; smart is minimal). The shared envelope (referenceId, expiration, theme, language) is common to all flows. Returns the full widget URL and authentication token.
Authorizations
Your partner API key. Use raas_sandbox_* keys for the sandbox environment and raas_live_* keys for production.
Body
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
Your unique identifier for the end user in your system. Used to correlate users with your records and to detect returning users.
"user-12345"
Flow discriminator. Must be "m2m" for this variant.
m2m "m2m"
Your tracing ID for this link/intent (order id, ticket, invoice, etc.). Copied onto the operation when the transfer is created so you can search operations by this value. Distinct from referenceId (which identifies the user).
128"ORD-2026-001"
Link time-to-live in minutes. The link becomes inaccessible after expiration. Minimum: 5 minutes. Maximum: 10,080 minutes (7 days). Defaults to the partner-level configuration (usually 60 minutes).
5 <= x <= 10080120
Arbitrary key-value metadata to attach to the link. Useful for storing internal references, campaign IDs, etc. Returned in link detail and webhook payloads.
Theme configuration object for the widget. The schema is owned by the flow frontend and is stored as-is. Overrides the partner-level theme.
Language code for the widget UI (ISO 639-1). Overrides browser detection.
en, es "es"
URL to receive callback notifications for this specific link. Overrides the partner-level webhook URL for link-specific events.
"https://api.example.com/callbacks/m2m"
Brand name shown in the widget header for this link. When omitted, the widget falls back to the partner display name.
80"Lola Send"
Kentucky CIP template ID to use when provisioning the CIP ticket for this link. Overrides the partner-level setting and the global default.
120"raas-v1"
Link-scoped presentation flags (splash / agreement) common to every flow. Returned to the widget inside the claim config block.
M2M-specific configuration: pre-filled user data, transfer flavor, theme mode.