/v1/workspaces/{workspace_id}/broadcast-settingsAuthUpdate the broadcast settings
Set the workspace campaign pace (1 to 300 messages per minute; null for the default, 120). It never affects transactional sends, which have their own limit.
Path parameters
workspace_id*string · uuidId of the workspace.
Headers
Idempotency-KeystringOpaque client-generated string (1–256 chars, `[A-Za-z0-9._:-]`) used to deduplicate retries within a 24h window. A retry with the same key and body returns the original response with `Idempotent-Replay: true`.
Request body
rate_per_minute*numberNull restores the default (120 per minute).
Response · 200
rate_per_minute*numberThe workspace campaign pace; null uses the default.
effective_rate_per_minute*numberWhat a broadcast without its own rate is sent at.
Example: 120
default_rate_per_minute*numberDefault sending rate for new broadcasts, in emails per minute.
Example: 120
Example
Request
PUT https://api.mail.productcraft.co/v1/workspaces/{workspace_id}/broadcast-settings
Authorization: Bearer YOUR_TOKEN
Content-Type: application/json
{
"rate_per_minute": 0
}import { Mail } from "@productcraft/mail";
// Reads PRODUCTCRAFT_API_KEY from the environment
const mail = new Mail();
const broadcastSettings = await mail.broadcasts.settings.update({ rate_per_minute: 1 });mail.broadcasts.settings.update(params, options?): Mail.BroadcastSettings
Response
{
"rate_per_minute": 0,
"effective_rate_per_minute": 120,
"default_rate_per_minute": 120
}