DRdroidrun
Mailboxes

Claim or rent a mailbox

Changed on

Creates a mailbox on the default domain or a connected custom domain. An optional localPart selects the address. Replaying the same Idempotency-Key and payload returns the original mailbox. Fresh requests and replays return 202 with the current mailbox state. Poll the mailbox when the response does not yet include a checkout URL.

post/mailboxes

Request

  • Base URL
    https://api.mobilerun.ai
  • URL
    https://api.mobilerun.ai/mailboxes
  • Auth
    HTTP bearer

Headers

idempotency-keystring

Idempotency-Key: 1-255 printable ASCII characters. Same key with a different request body is a 422 idempotency_key_reused. A retryable in-flight duplicate is a 409 with Retry-After and x-should-retry: true; a terminal duplicate is a 409 with x-should-retry: false. A replay returns the current resource state with Idempotent-Replayed: true.

Example:b3f6a9f0-6f1a-4e9a-9e7a-9c9b6b6a5a3f

Request body

labelstring
domainIdstring uuid

Optional active custom mailbox domain owned by the caller. Omit to use the system domain.

localPartstring

Optional mailbox name before the "@". Omit to generate a random address.

billingPreference'included' | 'included_only' | 'rent'

included uses package capacity when available and otherwise starts paid checkout; included_only fails without creating a paid reservation when no included slot remains; rent always starts paid checkout.

Example request

{
  "localPart": "jane-doe"
}

Response

Archived mailbox returned (idempotent replay)

Example response

{
  "data": {
    "address": "mx_7k3q9p2m4v8d@inbox.example"
  }
}

Changes

  • 559a12449213Revision changes
    • warning

      added the new integration_forbidden enum value to the //// response property for the response status

    • warning

      added the new integration_forbidden enum value to the //// response property for the response status

    • warning

      added the new integration_forbidden enum value to the //// response property for the response status

    • warning

      added the new integration_forbidden enum value to the //// response property for the response status

    • warning

      added the new integration_forbidden enum value to the //// response property for the response status

    • warning

      added the new integration_forbidden enum value to the //// response property for the response status

    • warning

      added the new integration_forbidden enum value to the //// response property for the response status

    • warning

      added the new integration_forbidden enum value to the //// response property for the response status

    • warning

      added the new integration_forbidden enum value to the response property for the response status

    • warning

      added the new integration_forbidden enum value to the response property for the response status

    • warning

      added the new provider_error enum value to the //// response property for the response status

    • warning

      added the new provider_error enum value to the //// response property for the response status

    • warning

      added the new provider_error enum value to the //// response property for the response status

    • warning

      added the new provider_error enum value to the //// response property for the response status

    • warning

      added the new provider_error enum value to the //// response property for the response status

    • warning

      added the new provider_error enum value to the //// response property for the response status

    • warning

      added the new provider_error enum value to the //// response property for the response status

    • warning

      added the new provider_error enum value to the //// response property for the response status

    • warning

      added the new provider_error enum value to the response property for the response status

    • warning

      added the new provider_error enum value to the response property for the response status

  • 4ad548c528a8Revision changes
    • info

      endpoint added