Skip to main content
POST
Set a custom warmup filter tag for selected inboxes in a company.

Authorizations

X-API-Key
string
header
required

Company API key - scoped to a specific company. Generate from the Integrations page in your dashboard.

Body

application/json

Warmup filter tag settings

Request body for setting warmup filter tag

companyId
string
required

Company ID

filterTag
string

Custom filter tag for warmup emails

inboxIds
string[]

List of inbox IDs to update

Response

Filter tag set successfully

Success message response

message
string

Success message

msg
string

Success message (alternate key)