Skip to main content
POST
Buy email server

Authorizations

Authorization
string
header
required

Access token issued by gtm.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.

Team-SID
string
header
required

Team scope for tokens that do not carry one. Ignored when the token already names a team.

Body

application/json

Request body of create_email_box.

name
string
required

The server's label, 1 to 60 characters.

Required string length: 1 - 60
plan
enum<string>
required

Mailboxes per plan: starter 100, growth 500, agency 2000, dedicated 10000.

Available options:
starter,
growth,
agency,
dedicated
location
enum<string>
required

hel1 Helsinki, fsn1 Falkenstein, nbg1 Nuremberg.

Available options:
hel1,
fsn1,
nbg1
copy_settings_from
string | null

A serving server of this workspace whose settings and stop-list the new one starts with. Omitted: the stop-list comes from the oldest active server.

Required string length: 18
Pattern: ^em_bx_

Response

create success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
create
item
object | null
required
already_exists
boolean
required
meta
object
required
checkout
object | null
required

Set instead of item when the workspace has no subscription: the purchase finishes in the app.