Ir a la documentación
API

Iniciar sesión como una sola dirección

Una contraseña propia permite a alguien iniciar sesión en OpenEmail como una sola dirección, y leer y enviar solo su correo.

GET/domains/{id}/addresses/{addressId}/login

Ejecuta cualquiera de las 3 llamadas en tu espacio de trabajo.

GET /domains/{id}/addresses/{addressId}/login

Una contraseña propia permite a alguien iniciar sesión en OpenEmail como una sola dirección, y leer y enviar solo su correo.

Leer el inicio de sesión

Requiere members:write, igual que configurar una contraseña. login es null cuando la dirección no tiene contraseña.

curl
curl "$OE/domains/b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f/addresses/5f0c2b7e-8d41-4a6f-b913-7e2a0c4d9b18/login" -H "$AUTH"
Respuesta
{  "object": "address_login",  "addressId": "5f0c2b7e-8d41-4a6f-b913-7e2a0c4d9b18",  "address": "[email protected]",  "login": {    "userId": "W2xR8tLq5nYc3vKp9mBd7fHs1aJe4gZu",    "name": "Invoices",    "createdAt": "2026-09-20T09:30:00.000Z",    "createdBy": "Ana Lima",    "passwordSetAt": "2026-09-28T14:05:00.000Z",    "passwordSetBy": "Ana Lima",    "lastSignedInAt": "2026-10-01T07:58:12.000Z"  }}

Una clave limitada a direcciones o dominios concretos se rechaza con 422 capability_unsupported, y una app que actúa por un miembro solo llega al inicio de sesión de una dirección a la que llega ese miembro.

Configurar la contraseña

Requiere members:write. PUT /domains/{id}/addresses/{addressId}/login con { password } da una contraseña a la dirección, o sustituye la que tiene. created indica si el inicio de sesión es nuevo.

curl
curl -X PUT "$OE/domains/b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f/addresses/5f0c2b7e-8d41-4a6f-b913-7e2a0c4d9b18/login" -H "$AUTH" \  -H "Content-Type: application/json" \  -d '{ "password": "'"$INBOX_PASSWORD"'" }'
Respuesta
{  "object": "address_login",  "addressId": "5f0c2b7e-8d41-4a6f-b913-7e2a0c4d9b18",  "address": "[email protected]",  "login": {    "userId": "W2xR8tLq5nYc3vKp9mBd7fHs1aJe4gZu",    "name": "Invoices",    "createdAt": "2026-09-20T09:30:00.000Z",    "createdBy": "Ana Lima",    "passwordSetAt": "2026-09-28T14:05:00.000Z",    "passwordSetBy": "Ana Lima",    "lastSignedInAt": "2026-10-01T07:58:12.000Z"  },  "created": false}

La contraseña necesita al menos 8 caracteres con una minúscula, una mayúscula, un número y un carácter especial, o la llamada es un 422 invalid_parameter en password. OpenEmail no se la envía a nadie, así que entrégala tú.

Sustituir una contraseña cierra la sesión de todos los que iniciaron sesión con la anterior y quita los destinos de reenvío que añadieron.

Una dirección con la que ya inicia sesión una cuenta de OpenEmail se rechaza con 409 account_exists, y una dirección desactivada con 409 address_unavailable. La primera contraseña de un espacio de trabajo cuyo plan no incluye acceso de equipo se rechaza con 403 plan_required.

Una clave o una app tiene que tener cada ámbito que puede usar un inicio de sesión para una sola dirección, o se rechaza con 403 insufficient_authority.

Un token de acceso OAuth necesita un código de verificación para esta llamada. Hasta que la app haya verificado uno en los últimos 60 minutos, la llamada responde 403 step_up_required y no cambia nada. A una clave de API nunca se le pide. La página Autenticación muestra cómo pedir un código y verificarlo.

Eliminar el inicio de sesión

Requiere members:write. DELETE /domains/{id}/addresses/{addressId}/login quita la contraseña y cierra la sesión de todos los que la usaron. La dirección y su correo se quedan.

curl
curl -X DELETE "$OE/domains/b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f/addresses/5f0c2b7e-8d41-4a6f-b913-7e2a0c4d9b18/login" -H "$AUTH"
Respuesta
{  "object": "address_login",  "addressId": "5f0c2b7e-8d41-4a6f-b913-7e2a0c4d9b18",  "address": "[email protected]",  "deleted": true}

Una dirección sin contraseña da 404.

Referencia