Skip to main content
POST
Bulk action on email accounts

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.

Headers

Email-Box-SID
string

Email server (em_bx_...) the call is for, from search_email_boxes. Omitted: the primary server.

Pattern: ^em_bx_[A-Za-z0-9]{12}$

Body

application/json

Request body of bulk_action_email_accounts.

action
enum<string>
required
Available options:
pause,
resume,
update,
disconnect,
delete,
sync
email_account_sids
string[]
required
Required array length: 1 - 500 elements
Required string length: 18
Pattern: ^em_ac_
update
object

Required when action is update; each field sent replaces whole.

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