import Mobilerun from '@mobilerun/sdk';
const client = new Mobilerun({
apiKey: process.env['MOBILERUN_CLOUD_API_KEY'], // This is the default and can be omitted
});
const mailbox = await client.mailboxes.create({ clientRequestId: 'x' });
console.log(mailbox.data);import os
from mobilerun_sdk import Mobilerun
client = Mobilerun(
api_key=os.environ.get("MOBILERUN_CLOUD_API_KEY"), # This is the default and can be omitted
)
mailbox = client.mailboxes.create(
client_request_id="x",
)
print(mailbox.data)curl --request POST \
--url https://api.mobilerun.ai/mailboxes \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"clientRequestId": "<string>",
"label": "<string>",
"localPart": "jane-doe"
}
'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.mobilerun.ai/mailboxes",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'clientRequestId' => '<string>',
'label' => '<string>',
'localPart' => 'jane-doe'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.mobilerun.ai/mailboxes"
payload := strings.NewReader("{\n \"clientRequestId\": \"<string>\",\n \"label\": \"<string>\",\n \"localPart\": \"jane-doe\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.mobilerun.ai/mailboxes")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"clientRequestId\": \"<string>\",\n \"label\": \"<string>\",\n \"localPart\": \"jane-doe\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.mobilerun.ai/mailboxes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"clientRequestId\": \"<string>\",\n \"label\": \"<string>\",\n \"localPart\": \"jane-doe\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"address": "mx_7k3q9p2m4v8d@inbox.example",
"billingMode": "rent",
"cancelAtPeriodEnd": true,
"checkoutExpiresAt": "2023-11-07T05:31:56Z",
"checkoutUrl": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"currentPeriodEnd": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"inboundMessages": {
"exhausted": true,
"included": 1,
"resetsAt": "2023-11-07T05:31:56Z",
"used": 1
},
"label": "<string>",
"status": "provisioning"
}
}{
"data": {
"address": "mx_7k3q9p2m4v8d@inbox.example",
"billingMode": "rent",
"cancelAtPeriodEnd": true,
"checkoutExpiresAt": "2023-11-07T05:31:56Z",
"checkoutUrl": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"currentPeriodEnd": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"inboundMessages": {
"exhausted": true,
"included": 1,
"resetsAt": "2023-11-07T05:31:56Z",
"used": 1
},
"label": "<string>",
"status": "provisioning"
}
}{
"data": {
"address": "mx_7k3q9p2m4v8d@inbox.example",
"billingMode": "rent",
"cancelAtPeriodEnd": true,
"checkoutExpiresAt": "2023-11-07T05:31:56Z",
"checkoutUrl": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"currentPeriodEnd": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"inboundMessages": {
"exhausted": true,
"included": 1,
"resetsAt": "2023-11-07T05:31:56Z",
"used": 1
},
"label": "<string>",
"status": "provisioning"
}
}{
"error": "<string>"
}{
"error": "<string>"
}Claim or rent a mailbox
Reserves a permanently-allocated, individually-rented mailbox and starts an Autumn rental checkout. An optional localPart selects the full address local part; omitting it keeps the default random, non-guessable mx_-prefixed address. The address is withheld until the first payment is confirmed. Idempotent on (owner, clientRequestId): same key + payload replays (200); a conflicting or already-held local part returns 409. 201 when the checkout URL is already persisted, otherwise 202 (poll GET for the URL).
import Mobilerun from '@mobilerun/sdk';
const client = new Mobilerun({
apiKey: process.env['MOBILERUN_CLOUD_API_KEY'], // This is the default and can be omitted
});
const mailbox = await client.mailboxes.create({ clientRequestId: 'x' });
console.log(mailbox.data);import os
from mobilerun_sdk import Mobilerun
client = Mobilerun(
api_key=os.environ.get("MOBILERUN_CLOUD_API_KEY"), # This is the default and can be omitted
)
mailbox = client.mailboxes.create(
client_request_id="x",
)
print(mailbox.data)curl --request POST \
--url https://api.mobilerun.ai/mailboxes \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"clientRequestId": "<string>",
"label": "<string>",
"localPart": "jane-doe"
}
'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.mobilerun.ai/mailboxes",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'clientRequestId' => '<string>',
'label' => '<string>',
'localPart' => 'jane-doe'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.mobilerun.ai/mailboxes"
payload := strings.NewReader("{\n \"clientRequestId\": \"<string>\",\n \"label\": \"<string>\",\n \"localPart\": \"jane-doe\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.mobilerun.ai/mailboxes")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"clientRequestId\": \"<string>\",\n \"label\": \"<string>\",\n \"localPart\": \"jane-doe\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.mobilerun.ai/mailboxes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"clientRequestId\": \"<string>\",\n \"label\": \"<string>\",\n \"localPart\": \"jane-doe\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"address": "mx_7k3q9p2m4v8d@inbox.example",
"billingMode": "rent",
"cancelAtPeriodEnd": true,
"checkoutExpiresAt": "2023-11-07T05:31:56Z",
"checkoutUrl": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"currentPeriodEnd": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"inboundMessages": {
"exhausted": true,
"included": 1,
"resetsAt": "2023-11-07T05:31:56Z",
"used": 1
},
"label": "<string>",
"status": "provisioning"
}
}{
"data": {
"address": "mx_7k3q9p2m4v8d@inbox.example",
"billingMode": "rent",
"cancelAtPeriodEnd": true,
"checkoutExpiresAt": "2023-11-07T05:31:56Z",
"checkoutUrl": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"currentPeriodEnd": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"inboundMessages": {
"exhausted": true,
"included": 1,
"resetsAt": "2023-11-07T05:31:56Z",
"used": 1
},
"label": "<string>",
"status": "provisioning"
}
}{
"data": {
"address": "mx_7k3q9p2m4v8d@inbox.example",
"billingMode": "rent",
"cancelAtPeriodEnd": true,
"checkoutExpiresAt": "2023-11-07T05:31:56Z",
"checkoutUrl": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"currentPeriodEnd": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"inboundMessages": {
"exhausted": true,
"included": 1,
"resetsAt": "2023-11-07T05:31:56Z",
"used": 1
},
"label": "<string>",
"status": "provisioning"
}
}{
"error": "<string>"
}{
"error": "<string>"
}Authorizations
Bearer token via Authorization header
Body
1 - 128Funding preference. Omit or use included for included-first activation; rent always preserves package capacity and starts paid checkout.
included, rent 100Optional full mailbox local part (the address before "@"). Trimmed and lowercased before validation. Omit for a random, non-guessable mx_-prefixed address.
1 - 64^[A-Za-z0-9](?:[A-Za-z0-9._-]{0,62}[A-Za-z0-9])?$"jane-doe"
Response
Existing mailbox returned (idempotent replay)
Show child attributes
Show child attributes
Was this page helpful?