Saltar al contenido principal

Suscriptores

Gestiona tus suscriptores de email.

Añadir Suscriptor

Agrega un usuario a tu audiencia. Opcionalmente envíales un correo de bienvenida automáticamente.

Endpoint

POST /api/v1/join

Autenticación: Public Key (pk_...) o Secret Key (sdk_...)

Parámetros de Petición

CampoTipoRequeridoDescripción
emailstringCorreo del suscriptor.
sendWelcomeEmailbooleanNoEnviar email de bienvenida automático (default: false).
metadataobjectNoDatos personalizados (source, name, etc.).

Ejemplos de Código

curl -X POST https://senddock.dev/api/v1/join \
-H "Authorization: Bearer sdk_..." \
-H "Content-Type: application/json" \
-d '{
"email": "dev@ejemplo.com",
"metadata": {
"source": "landing-page",
"stack": "nextjs"
}
}'

Ejemplo de Respuesta (201)

{
"success": true,
"data": {
"email": "dev@ejemplo.com",
"message": "Successfully subscribed"
}
}

Listar Suscriptores

Lista los suscriptores de tu proyecto con paginación.

Endpoint

GET /api/v1/subscribers

Autenticación: Secret Key (sdk_...)

Parámetros de Consulta

  • limit (default: 50, max: 100)
  • offset (default: 0)

Ejemplos de Código

curl -X GET 'https://senddock.dev/api/v1/subscribers?limit=50&offset=0' \
-H "Authorization: Bearer sdk_..."

Ejemplo de Respuesta (200)

{
"success": true,
"data": {
"subscribers": [
{
"email": "usuario@ejemplo.com",
"metadata": { "source": "twitter" },
"createdAt": "2024-01-15T10:30:00Z"
}
],
"pagination": {
"total": 1540,
"limit": 50,
"offset": 0
}
}
}