Skip to main content
PATCH
Rename 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

Email server sid (em_bx_...).

Required string length: 18
Pattern: ^em_bx_

Body

application/json

Request body of update_email_box.

name
string
required

The new label, 1 to 60 characters.

Required string length: 1 - 60

Response

update success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
update
item
object
required
updated_fields
string[]
required
previous_values
object
required
meta
object
required