Buzones
Crear un buzón
POSThttps://api.temporam.com/v3/mailboxes
| Campo | Tipo | Obligatorio | Descripción |
|---|
| domain | string | Sí | Dominio devuelto por el endpoint de dominios |
| local_part | string | No | Parte local; se genera si se omite |
- 1curl -X POST https://api.temporam.com/v3/mailboxes \
- 2 -H "Authorization: Bearer YOUR_API_KEY" \
- 3 -H "Content-Type: application/json" \
- 4 -d '{"domain":"temporam.com","local_part":"demo"}'
| Campo de respuesta | Tipo | Descripción |
|---|
| data.id | string | ID del buzón |
| data.address | string | Dirección completa del buzón |
| data.local_part | string | Parte local de la dirección |
| data.domain | string | Dominio de la dirección |
| data.status | string | Estado del buzón |
| data.created_at | string | Fecha de creación |
| meta.remaining | integer | Cuota relevante restante, cuando esté disponible |
Listar buzones
GEThttps://api.temporam.com/v3/mailboxes
| Parámetro | Ubicación | Tipo | Obligatorio | Predeterminado | Descripción |
|---|
| page | query | integer | No | 1 | Número de página |
| limit | query | integer | No | 20 | Elementos por página |
| Campo de respuesta | Tipo | Descripción |
|---|
| data | array | Buzones con los campos indicados arriba |
| meta.total | integer | Total de buzones |
| meta.page | integer | Página actual |
| meta.limit | integer | Elementos por página |
| meta.remaining | integer | Cuota relevante restante, cuando esté disponible |
Consultar un buzón
GEThttps://api.temporam.com/v3/mailboxes/{id}
| Parámetro | Ubicación | Tipo | Obligatorio | Descripción |
|---|
| id | path | string | Sí | ID del buzón |
| Campo de respuesta | Tipo | Descripción |
|---|
| data | object | Detalles del buzón con los campos indicados arriba |
| meta.remaining | integer | Cuota relevante restante, cuando esté disponible |
Eliminar un buzón
DELETEhttps://api.temporam.com/v3/mailboxes/{id}
| Parámetro | Ubicación | Tipo | Obligatorio | Descripción |
|---|
| id | path | string | Sí | ID del buzón |
| Campo de respuesta | Tipo | Descripción |
|---|
| data.deleted | boolean | Siempre true cuando se elimina correctamente |
| meta.remaining | integer | Cuota relevante restante, cuando esté disponible |