Create a sandbox inbox

Request body

• namestringrequired

Request

curl -X POST 'https://app.mailyte.com/api/v1/sandbox/inboxes' \
  -H 'Authorization: Bearer mk_live_YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "<string>"
  }'

const response = await fetch('https://app.mailyte.com/api/v1/sandbox/inboxes', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer mk_live_YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "name": "<string>"
  }),
});
const { data } = await response.json();

import requests
response = requests.post(
    "https://app.mailyte.com/api/v1/sandbox/inboxes",
    headers={"Authorization": "Bearer mk_live_YOUR_API_KEY"},
    json={
      "name": "<string>"
    },
)
data = response.json()["data"]

<?php

$response = Http::withToken('mk_live_YOUR_API_KEY')
    ->post('https://app.mailyte.com/api/v1/sandbox/inboxes', [
    'name' => '<string>',
]);

$data = $response->json('data');

require "net/http"
require "json"
uri = URI("https://app.mailyte.com/api/v1/sandbox/inboxes")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer mk_live_YOUR_API_KEY"
request["Content-Type"] = "application/json"
request.body = {
  "name": "<string>"
}.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

Response

Success.

• dataobject
  • idstring

    ULID, issued by the mail server (uppercase).

  • organization_idstring
  • namestring

    Your label, e.g. "Staging" or "CI".

  • usernamestring

    The SMTP username for this inbox (`sbx_…`). Authenticate with it on `smtp_host`.

  • smtp_hoststring

    The sandbox SMTP host, `sandbox.smtp.mailyte.com`.

  • smtp_portsarray<integer>

    2525 (STARTTLS) and 2465 (implicit TLS). The production ports 587/465 do not accept sandbox credentials.

  • max_messagesinteger

    How many messages the inbox keeps. The oldest is deleted when a new one would exceed it.

  • retention_daysinteger

    Messages older than this are deleted.

  • inbound_addressstring

    An address anyone can send to from anywhere (no SMTP login), which lands in this inbox: point a third-party service's notification address at it. Null when this deployment has no inbound sandbox domain.

  • is_defaultboolean

    Test-mode API sends land in the default inbox. The first inbox you create is the default.

  • message_countinteger
  • unread_countinteger
  • last_message_atstring

    When the newest message arrived. Null means the inbox has never received one.

  • created_atstring

    When the inbox was created.

  • secretstring

    The SMTP password (`mlt_sbx_…`), on the call that creates the inbox only. Read it again any time with `GET /sandbox/inboxes/{id}/credentials`.

{
  "name": "Staging"
}

Returned inside the standard envelope.

Errors

Every status, with what causes it and what to do, is on the error reference.