Mail API reference

Mail API · Broadcasts

get/v1/workspaces/{workspace_id}/broadcast-settingsAuth

Get the broadcast settings

The messages-per-minute pace broadcasts go out at.

Path parameters

workspace_id*string · uuid

Id of the workspace.

Response · 200

rate_per_minute*number

The workspace campaign pace; null uses the default.

effective_rate_per_minute*number

What a broadcast without its own rate is sent at.

Example: 120

default_rate_per_minute*number

Default sending rate for new broadcasts, in emails per minute.

Example: 120

Example

Request

GET https://api.mail.productcraft.co/v1/workspaces/{workspace_id}/broadcast-settings
Authorization: Bearer YOUR_TOKEN

Response

{
  "rate_per_minute": 0,
  "effective_rate_per_minute": 120,
  "default_rate_per_minute": 120
}