Skip to main content
PATCH
/
workspaces
/
{workspaceID}
/
mailboxes
/
{mailboxID}
Error
A valid request URL is required to generate request examples
{
  "address": "<string>",
  "dailyEmailLimit": 123,
  "disconnectReason": "<string>",
  "firstName": "<string>",
  "id": "<string>",
  "lastName": "<string>",
  "signature": "<string>",
  "trackingDomain": "<string>"
}
{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "sentCount": 123,
      "sequenceId": "<string>",
      "url": "<string>"
    }
  ],
  "message": "<string>"
}
{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "sentCount": 123,
      "sequenceId": "<string>",
      "url": "<string>"
    }
  ],
  "message": "<string>"
}
{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "sentCount": 123,
      "sequenceId": "<string>",
      "url": "<string>"
    }
  ],
  "message": "<string>"
}

Authorizations

​
Authorization
string
header
required

Path Parameters

​
workspaceID
string
required

Workspace ID

​
mailboxID
string
required

Mailbox ID

Body

application/json

Mailbox update request (dailyEmailLimit max: 100)

The body is of type object.

Response

Mailbox

​
address
string
​
dailyEmailLimit
integer
​
disconnectReason
string
​
firstName
string
​
id
string
​
lastName
string
​
mailboxProvider
enum<string>
Available options:
gmail,
outlook,
smtp
​
signature
string
​
status
enum<string>
Available options:
active,
frozen,
access_lost,
deleted,
inactive,
pending,
suspended
​
trackingDomain
string
​
trackingDomainStatus
enum<string>
Available options:
active,
pending