Email

Create an email inbox

Creates the address local_part@domain in Bavimail and starts warming it up. Takes one inbox seat of the plan; campaigns send cold email from it as the warm-up allows.

POST
/mail/inboxes

Authorizations

Authorizationstringheaderrequired

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

Body

application/json
domain_idstringrequired

Id of the sending domain to create the inbox on.

local_partstringrequired

Part of the address before the @: letters and numbers joined by single dots, hyphens or underscores, up to 64 characters, lowercased.

signaturestring | null

Plain-text signature appended to every email, up to 1000 characters; null or absent for none.

warmup_speedenum<string>

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. Absent means slow.

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.