Saltar al contenido principal

Suscriptores

Administra tus suscriptores de correo.

Agregar Suscriptor

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

Endpoint

POST /api/v1/join

Autenticación: Clave Pública (pk_...) o Clave Secreta (sdk_...)

Parámetros de Solicitud

CampoTipoRequeridoDescripción
emailstringCorreo del suscriptor.
sendWelcomeEmailbooleanNoEnviar correo de bienvenida automático (por defecto: false).
metadataobjectNoDatos personalizados (origen, nombre, 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@example.com",
"metadata": {
"source": "landing-page",
"stack": "nextjs"
}
}'

Ejemplo de Respuesta (201)

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

Listar Suscriptores

Lista los suscriptores de tu proyecto con paginación.

Endpoint

GET /api/v1/subscribers

Autenticación: Clave Secreta (sdk_...)

Parámetros de Consulta

  • limit (por defecto: 50, máx: 100)
  • offset (por defecto: 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": "user@example.com",
"metadata": { "source": "twitter" },
"createdAt": "2024-01-15T10:30:00Z"
}
],
"pagination": {
"total": 1540,
"limit": 50,
"offset": 0
}
}
}