Skip to main content
POST
Move mailboxes into 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.

Path Parameters

sid
string
required

The server that receives the mailboxes (em_bx_...).

Required string length: 18
Pattern: ^em_bx_

Body

application/json

Request body of move_in_email_box_mailboxes.

from_email_box_sid
string
required

The server that holds them now (em_bx_...).

Required string length: 18
Pattern: ^em_bx_
email_account_sids
string[]
required

The mailboxes to move (em_ac_...), 1 to 100, no repeats.

Required array length: 1 - 100 elements
Required string length: 18
Pattern: ^em_ac_

Response

action success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
action
action
string
required

kebab-case verb; matches the route segment.

item
any
required
result
object
required
meta
object
required