▣ COMMUNICATIONS · DATA VALIDATION

Temporary and Disposable emails API

What it does

Temporary Email lets you create disposable inboxes, read the messages that arrive there, and delete the mailbox when you are done. Use it when you need an email address for sign-up flows, verification testing, QA environments, or short-lived user journeys.

Send a time value of 10min, 1hour, 1day, or permanent to /create. You can also pass a domain to request a specific domain. The response includes the created email object with its id, domain, address, time_tier, created_at, expires_at, time_remaining, and is_custom_domain, along with the request success flag and response metadata.

To inspect incoming mail, call GET /messages/:id with the mailbox UUID. You can page through results with limit and offset. The response returns the email address, message_count, and a messages array with each message’s id, is_read, is_spam, subject, body_html, body_text, from_name, from_email, and received_at, plus pagination details.

When the mailbox is no longer needed, delete it with DELETE /:id. The delete response includes the user_id, email_id, and deleted_at values in data.meta, so you can confirm cleanup in logs or automated test runs.

▣ ENDPOINT 01 / 03

POST

Create Temporary Email

https://api.eu.apyverse.com/boomlify/create-temporary-email/create

QUICKSTART

GUIDE

Quickstart

Create a temporary email address with the default 10-minute lifetime.

curl -X POST "https://api.eu.apyverse.com/boomlify/create-temporary-email/create?time=10min" \
  -H "apy-token: $APY_TOKEN"

What you'll get back

Returns a JSON object with top-level success and message fields, a meta object with a timestamp, and a data object containing the created email details.

success is a boolean indicating whether the request succeeded.
message is a status string.
meta.timestamp is an ISO 8601 date-time string.
data is an object that includes email, meta, and success.

{
  "success": true,
  "message": "Request processed successfully",
  "meta": {
    "timestamp": "2023-10-27T10:00:00Z"
  },
  "data": {
    "success": true,
    "meta": {
      "tier": "10min",
      "user_id": "user_123",
      "request_time": "2023-10-27T10:00:00Z"
    },
    "email": {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "domain": "example.com",
      "address": "[email protected]",
      "time_tier": "10min",
      "created_at": "2023-10-27T10:00:00Z",
      "expires_at": "2023-10-27T10:10:00Z",
      "time_remaining": {
        "minutes": 10,
        "seconds": 0,
        "total_ms": 600000,
        "human_readable": "10 minutes"
      },
      "is_custom_domain": false
    }
  }
}

TRY ITLIVE · 25 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Creates a temporary email address. You can control the email lifetime with the time query parameter and optionally provide a domain; the response returns the generated email data inside a JSON object.

Query Parameter(s)

Attribute	Type	Mandatory	Description
time	ENUM	No	Lifetime of the temporary email. Allowed values: `10min`, `1hour`, `1day`, `permanent`. Default: `10min`.
domain	String	No	Domain to use for the temporary email address.

Response

Returns a JSON object with top-level data and success fields. The data field is an object containing meta and email objects; success is a boolean indicating whether the request was successful. The schema also defines top-level message and meta fields in the wrapper object.

Parameter	Type	Mandatory	Description
data	Object	No	Response payload object. Contains `meta` and `email` objects.
data.meta	Object	No	Metadata for the created temporary email. Contains `tier`, `user_id`, and `request_time`.
data.meta.tier	String	No	The tier associated with the request.
data.meta.user_id	String	No	The user identifier.
data.meta.request_time	String	No	Request timestamp in date-time format.
data.email	Object	No	Temporary email details. Contains `id`, `domain`, `address`, `time_tier`, `created_at`, `expires_at`, `time_remaining`, and `is_custom_domain`.
data.email.id	String	No	Email identifier in UUID format.
data.email.domain	String	No	Email domain.
data.email.address	String	No	Full email address.
data.email.time_tier	String	No	Time tier used for the email.
data.email.created_at	String	No	Creation timestamp in date-time format.
data.email.expires_at	String	No	Expiration timestamp in date-time format.
data.email.time_remaining	Object	No	Remaining time for the email. Contains `minutes`, `seconds`, `total_ms`, and `human_readable`.
data.email.time_remaining.minutes	Integer	No	Remaining minutes.
data.email.time_remaining.seconds	Integer	No	Remaining seconds.
data.email.time_remaining.total_ms	Integer	No	Remaining time in milliseconds.
data.email.time_remaining.human_readable	String	No	Human-readable remaining time.
data.email.is_custom_domain	Boolean	No	Indicates whether a custom domain was used.
data.success	Boolean	No	Indicates whether the operation succeeded.
meta	Object	No	Additional metadata about the request. Contains `timestamp`.
meta.timestamp	String	No	Request timestamp in date-time format.
message	String	No	Descriptive response message.
success	Boolean	No	Indicates if the request was successful.

Query parameters

Name

Type

Description

timeOPTIONAL

string

10min · 1hour · 1day · permanent

—

DEFAULT 10min

domainOPTIONAL

string

—

▣ ENDPOINT 02 / 03

GET

Retrieve Email Messages

https://api.eu.apyverse.com/boomlify/create-temporary-email/messages/:id

QUICKSTART

GUIDE

Quickstart

Fetch a single message by its UUID.

curl -X GET "https://api.eu.apyverse.com/boomlify/create-temporary-email/messages/:id" \
  -H "apy-token: $APY_TOKEN"

What you'll get back

Returns a JSON object with data, meta, message, and success fields. The data field is an object containing the message response payload, meta.timestamp is a date-time string, message is a status message, and success is a boolean.

{
  "data": {},
  "meta": {
    "timestamp": "2023-10-27T10:00:00Z"
  },
  "message": "Request processed successfully",
  "success": true
}

TRY ITLIVE · 25 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Retrieves email messages for the email address identified by the path id. The response returns a JSON object with a data object containing the email details, messages, and pagination information.

Path Parameter(s)

Attribute	Type	Mandatory	Description
id	String	Yes	Email identifier in UUID format.

Query Parameter(s)

Attribute	Type	Mandatory	Description
limit	Integer	No	Maximum number of messages to return. Default: 25. Minimum: 1. Maximum: 100.
offset	Integer	No	Number of messages to skip before returning results. Default: 0.

Response

Returns a JSON object with top-level data object containing meta, email, success, messages, and pagination fields. It also includes top-level meta (object), message (string), and success (boolean) fields as declared by the schema.

Parameter	Type	Mandatory	Description
data	Object	No	Response payload object. Includes `meta`, `email`, `success`, `messages`, and `pagination`.
meta	Object	No	Additional metadata about the request. Includes `timestamp` in date-time format.
message	String	No	A descriptive message about the response.
success	Boolean	No	Indicates if the request was successful.

Notes

The response schema is composed with allOf, so data, meta, message, and success may appear at the top level, while the detailed payload is also defined under data. The messages array items include id, is_read, is_spam, subject, body_html, body_text, from_name, from_email, and received_at; pagination includes limit, total, offset, and has_more.

Path parameters

Name

Type

Description

idREQUIRED

string

—

Query parameters

Name

Type

Description

limitOPTIONAL

integer

—

DEFAULT 25

offsetOPTIONAL

integer

—

DEFAULT 0

▣ ENDPOINT 03 / 03

DELETE

Delete Temporary Email

https://api.eu.apyverse.com/boomlify/create-temporary-email/:id

QUICKSTART

GUIDE

Quickstart

Delete a temporary email by its UUID id.

curl -X DELETE "https://api.eu.apyverse.com/boomlify/create-temporary-email/:id" \
  -H "apy-token: $APY_TOKEN"

What you'll get back

Returns a JSON object with data, meta, message, and success fields. The data field is an object containing response details such as meta, message, and success.

{
  "data": {
    "meta": {
      "user_id": "user_123",
      "email_id": "550e8400-e29b-41d4-a716-446655440000",
      "deleted_at": "2023-10-27T10:00:00Z"
    },
    "message": "Request processed successfully",
    "success": true
  },
  "meta": {
    "timestamp": "2023-10-27T10:00:00Z"
  },
  "message": "Request processed successfully",
  "success": true
}

TRY ITLIVE · 25 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Deletes a temporary email identified by its UUID path parameter. The response returns a JSON object with a data object, plus top-level message, success, and meta fields.

Path Parameter(s)

Attribute	Type	Mandatory	Description
id	String	Yes	Temporary email identifier in UUID format.

Response

Returns a JSON object with top-level data, meta, message, and success fields. The data field is an object containing meta, message, and success; meta includes user_id, email_id, and deleted_at.

Parameter	Type	Mandatory	Description
data	Object	No	Response data object. Contains `meta`, `message`, and `success`.
data.meta	Object	No	Contains deletion metadata: `user_id`, `email_id`, and `deleted_at`.
data.meta.user_id	String	No	User identifier.
data.meta.email_id	String	No	Deleted email identifier.
data.meta.deleted_at	String	No	Deletion timestamp in date-time format.
data.message	String	No	Response message.
data.success	Boolean	No	Indicates whether the operation was successful.
meta	Object	No	Additional metadata about the request.
meta.timestamp	String	No	Request timestamp in date-time format.
message	String	No	Descriptive response message.
success	Boolean	No	Indicates if the request was successful.

Path parameters

Name

Type

Description

idREQUIRED

string

—

▣ COMMON ERRORS

Errors any endpoint can return

400bad_request

Required parameter missing or malformed body.

401unauthorized

API key missing, revoked, or not authorized for this service.

429rate_limited

Your plan's per-second rate exceeded. Retry with exponential backoff.

503upstream_busy

Backend temporarily unavailable. Try again in a few seconds.