Criar um link de cadastro
Cria uma URL pública compartilhável que direciona usuários finais pelo fluxo de Embedded Signup do WhatsApp. Quando completado, o número do usuário é automaticamente conectado à sua conta.
Authentication
AuthorizationBearer
API Key in the format mk_live_<43-chars>. Obtain from the Dashboard or POST /auth/api-keys.
Request
This endpoint expects an object.
name
Display name for the signup link
slug
URL-friendly identifier for the link. Auto-generated from name if not provided
maxUsages
Maximum number of times this link can be used. Unlimited if not set
expiresAt
ISO 8601 datetime after which the link becomes inactive
customMessage
Custom message displayed to end-users on the signup page
redirectUrl
URL to redirect end-users to after completing the signup flow
Response
Default Response
id
Unique identifier of the signup link
slug
URL-friendly slug used in the public link URL
name
Display name of the signup link
url
Full public URL for the signup link
active
Whether the signup link is currently active and accepting signups
usageCount
Number of times this link has been used
maxUsages
Maximum allowed usages, or null for unlimited
expiresAt
Expiration datetime in ISO 8601 format, or null if no expiration
customMessage
Custom message shown to end-users, or null if not set
redirectUrl
Redirect URL after signup completion, or null if not set
createdAt
ISO 8601 datetime when the signup link was created
updatedAt
ISO 8601 datetime when the signup link was last updated
Errors
400
Bad Request Error
401
Unauthorized Error
409
Conflict Error