Rename a mailbox, or change who reads a shared one and where it routes

Before you call

Credential

Authorization: Bearer $KEY

Scope

inbox:write

Graphql

Mutation.inboxMailboxUpdate

Sdk

inbox.mailbox.update

Cli

inbox mailbox update

Parameters

• idstring (uuid)required
  In the path

Request bodyapplication/json, required

• namestring
  At most 120 characters.
• memberslist of string
• routeTostring or null

Responses

• 200application/json
  Success

  object

• 400application/json
  The request was malformed
  • errorstringrequired
  • messagestring
• 401application/json
  No valid credential
  • errorstringrequired
  • messagestring
• 403application/json
  The credential lacks the scope, origin or address
  • errorstringrequired
  • messagestring
• 429application/json
  Over the key's rate limit; see Retry-After
  • errorstringrequired
  • messagestring