Saltar al contenido principal
Cada alcance es una puerta en su clave: abra solo lo que su integración necesita — dominio, envío, lectura o cancelación.
Cada alcance desbloquea un tipo de operación de correo electrónico. Use solo lo que su integración necesita.

​
Cómo enviar la clave

Recomendado
Alternativo
Cada clave API pertenece a un espacio de trabajo. No puede acceder a otro espacio de trabajo con la misma clave.

​
Combinaciones comunes

Solo enviar

email:send

Enviar y consultar

email:send, email:read

Con programación

email:send, email:cancel

Setup completo

email:domains:create, email:domains:list, email:send, email:read

Inbox + webhook

email:inbound:read, webhook email.received
Lista de alcances vacía al crear = acceso ADMIN (todo). En producción, restrinja siempre.

​
Alcances disponibles

Enviar correo inmediato o programado. El dominio from debe estar VERIFICADO.
  • Listar correos enviados en el espacio de trabajo
  • Consultar un envío por id
Con domainIds en la clave, la lista se limita a esos dominios.
Cancelar correo en cola o programado. Solo con estado QUEUED o SCHEDULED. Créditos reembolsados.
Listar dominios, ver detalles y verificar estado DNS.
Registrar un nuevo dominio para verificación DNS.
Listar y consultar correos recibidos en GET /v1/email/inbound y GET /v1/email/inbound/:id. Requiere Persistir en el canal. Con domainIds en la clave, mismas reglas que email:read. Webhook email.received en tiempo real.

​
Límite por dominio

Si la clave tiene domainIds configurados:
  • Envío — solo from en esos dominios (403 DOMAIN_NOT_ALLOWED)
  • Lista de enviados (email:read) — solo mensajes de esos dominios
  • Inbound (email:inbound:read) — solo recibidos en esos dominios; domainId inválido → 400; dominio fuera de la clave → 403; detalle de otro dominio → 404
Lista vacía = cualquier dominio VERIFICADO en el workspace.

​
Errores comunes

Verifique Authorization: Bearer sk_... y que la clave no se eliminó en el panel.
Verifique el alcance de la ruta, domainIds en la clave y los créditos (PLAN_LIMIT_CREDITS).
Verifique el dominio from en el panel antes de enviar.

​
Próximos pasos