Skip to main content
PATCH
Update mailbox warm-up

Authorizations

Authorization
string
header
required

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

Path Parameters

uuid
string<uuid>
required

Mailbox identifier.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$

Body

application/json

Request body schema.

dailyTarget
integer

Warm-up messages per day at full ramp.

Required range: x <= 200
status
enum<string>

Warm-up state to move to, e.g. paused to hold the pool without tearing it down.

Available options:
disabled,
pending,
active,
paused,
failed

Response

Successful response

mailbox
Mailbox · object
required

Mailbox after the warm-up update.