Update an email inbox

PATCH

/mail/inboxes/{id}

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

idstringrequired

Id of the email inbox.

Body

application/json

signaturestring | null

New plain-text signature, up to 1000 characters; null removes it, absent keeps it.

warmup_speedenum<string>

New warm-up speed: slow, medium or fast. The share of the warm-up already done carries over; absent keeps the speed.

Available options: slow, medium, fast

Response

application/json

Success

idstringrequired

addressstringrequired

The inbox's full email address.

domain_idstringrequired

Id of the sending domain the inbox is on.

signaturestring | nullrequired

Plain-text signature appended to every email; null when the inbox has none.

warmupenum<string>required

Warm-up state: starting while warm-up connects, warming, paused, failed when warm-up could not connect, or off when no warm-up runs.

Available options: starting, warming, paused, failed, off

warmup_speedenum<string>required

How fast warm-up climbs and cold sending starts: 30 cold emails a day after 78 days on slow, 40 on medium or 27 on fast.

Available options: slow, medium, fast

warmup_daily_volumeintegerrequired

Today's warm-up volume, in emails.

daily_limitintegerrequired

Cold emails campaigns may send from the inbox today; 0 until cold sending starts during warm-up.

ready_atstringrequired

When the inbox reaches its full 30 cold emails a day, as an ISO 8601 timestamp.

created_atstringrequired

When the inbox was created, as an ISO 8601 timestamp.

Update an email inbox

curl --request PATCH \
  --url https://api.bavlio.com/mail/inboxes/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "signature": "<string>",
  "warmup_speed": "slow"
}
'

curl --request PATCH \  --url https://api.bavlio.com/mail/inboxes/{id} \  --header 'Authorization: Bearer <token>' \  --header 'Content-Type: application/json' \  --data '{  "signature": "<string>",  "warmup_speed": "slow"}'

{
  "id": "<string>",
  "address": "<string>",
  "domain_id": "<string>",
  "signature": "<string>",
  "warmup": "starting",
  "warmup_speed": "slow",
  "warmup_daily_volume": 123,
  "daily_limit": 123,
  "ready_at": "<string>",
  "created_at": "<string>"
}

{  "id": "<string>",  "address": "<string>",  "domain_id": "<string>",  "signature": "<string>",  "warmup": "starting",  "warmup_speed": "slow",  "warmup_daily_volume": 123,  "daily_limit": 123,  "ready_at": "<string>",  "created_at": "<string>"}