Referência da APISignup Links

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.
namestringRequired>=1 character
Display name for the signup link
slugstringOptionalformat: "^[a-z0-9-]+$"

URL-friendly identifier for the link. Auto-generated from name if not provided

maxUsagesintegerOptional<=9007199254740991
Maximum number of times this link can be used. Unlimited if not set
expiresAtdatetimeOptional
ISO 8601 datetime after which the link becomes inactive
customMessagestringOptional

Custom message displayed to end-users on the signup page

redirectUrlstringOptionalformat: "uri"

URL to redirect end-users to after completing the signup flow

Response

Default Response
idstring
Unique identifier of the signup link
slugstring

URL-friendly slug used in the public link URL

namestring
Display name of the signup link
urlstring
Full public URL for the signup link
activeboolean
Whether the signup link is currently active and accepting signups
usageCountdouble
Number of times this link has been used
maxUsagesdouble or null
Maximum allowed usages, or null for unlimited
expiresAtstring or null
Expiration datetime in ISO 8601 format, or null if no expiration
customMessagestring or null

Custom message shown to end-users, or null if not set

redirectUrlstring or null
Redirect URL after signup completion, or null if not set
createdAtstring
ISO 8601 datetime when the signup link was created
updatedAtstring
ISO 8601 datetime when the signup link was last updated

Errors

400
Bad Request Error
401
Unauthorized Error
409
Conflict Error