Enlaces de suscripción (In-App Signup)

Referencia de 4 endpoints generados desde mosend-wb-backend/src/modules/whatsapp-signups/whatsapp-signups.controller.ts.

Base path: /·4 endpoints·Source: mosend-wb-backend/src/modules/whatsapp-signups/whatsapp-signups.controller.ts

GET/organizations/:orgId/signup-links

bearer

Lista los enlaces de suscripción (opt-in) de la organización, con sus deep links wa.me por número.

Path params

orgIdstringrequerido

Query params

wabaIdstringrequerido

Respuestas

curl -X GET 'https://api.mosend.dev/organizations/a1b2c3d4-1234-5678-9abc-def012345678/signup-links' \
  -H 'X-Api-Key: mk_live_<prefix>.<secret>'

Response · 200

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "createdAt": "2026-05-01T03:42:18.123Z"
    }
  ],
  "timestamp": "2026-05-01T03:42:18.123Z"
}

POST/organizations/:orgId/signup-links

bearer

Crea un enlace de suscripción con opt-in verificado por Meta (In-App Signup).

Path params

orgIdstringrequerido

Body (JSON)

wabaIdstring · uuidrequerido
signupMessagestringrequerido
Texto de la pantalla de consentimiento que Meta muestra al abrir el link.
confirmationMessagestringrequerido
Mensaje que recibe el usuario al aceptar. Admite {{promo_code}}.
privacyPolicyUrlstring · urirequerido
websiteUrlstring · uri
promoCodestring
displayNamestring
Apodo interno; no lo ven los usuarios de WhatsApp.

Respuestas

curl -X POST 'https://api.mosend.dev/organizations/a1b2c3d4-1234-5678-9abc-def012345678/signup-links' \
  -H 'X-Api-Key: mk_live_<prefix>.<secret>' \
  -H 'Content-Type: application/json' \
  -d '{"wabaId": "00000000-0000-0000-0000-000000000000","signupMessage": "<signupMessage>","confirmationMessage": "<confirmationMessage>","privacyPolicyUrl": "https://tu-app.com/endpoint","websiteUrl": "https://tu-app.com/endpoint","promoCode": "<promoCode>","displayName": "<displayName>"}'

Response · 200

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "string",
    "description": "string"
  },
  "timestamp": "2026-05-01T03:42:18.123Z"
}

GET/organizations/:orgId/signup-links/:id

bearer

Detalle de un enlace de suscripción; reconcilia el estado en vivo con Meta.

Path params

orgIdstringrequerido
idstringrequerido

Respuestas

curl -X GET 'https://api.mosend.dev/organizations/a1b2c3d4-1234-5678-9abc-def012345678/signup-links/00000000-0000-0000-0000-000000000000' \
  -H 'X-Api-Key: mk_live_<prefix>.<secret>'

Response · 200

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "createdAt": "2026-05-01T03:42:18.123Z"
  },
  "timestamp": "2026-05-01T03:42:18.123Z"
}

PATCH/organizations/:orgId/signup-links/:id

bearer

Actualiza mensajes/promo o activa/desactiva (status ACTIVE|DISABLED). privacyPolicyUrl es inmutable.

Path params

orgIdstringrequerido
idstringrequerido

Body (JSON)

statusstring
ACTIVEDISABLED
signupMessagestring
confirmationMessagestring
promoCodestring
displayNamestring
websiteUrlstring · uri

Respuestas

curl -X PATCH 'https://api.mosend.dev/organizations/a1b2c3d4-1234-5678-9abc-def012345678/signup-links/00000000-0000-0000-0000-000000000000' \
  -H 'X-Api-Key: mk_live_<prefix>.<secret>' \
  -H 'Content-Type: application/json' \
  -d '{"status": "ACTIVE","signupMessage": "<signupMessage>","confirmationMessage": "<confirmationMessage>","promoCode": "<promoCode>","displayName": "<displayName>","websiteUrl": "https://tu-app.com/endpoint"}'

Response · 200

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "string",
    "description": "string"
  },
  "timestamp": "2026-05-01T03:42:18.123Z"
}