Skip to main content
POST
/
v1
/
automations
/
audience-runs
/
{audienceRunId}
/
control
Pause, resume, or cancel a manual-audience run
curl --request POST \
  --url https://brew.new/api/v1/automations/audience-runs/{audienceRunId}/control \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "action": "pause"
}
'
import requests

url = "https://brew.new/api/v1/automations/audience-runs/{audienceRunId}/control"

payload = { "action": "pause" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({action: 'pause'})
};

fetch('https://brew.new/api/v1/automations/audience-runs/{audienceRunId}/control', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://brew.new/api/v1/automations/audience-runs/{audienceRunId}/control",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'action' => 'pause'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://brew.new/api/v1/automations/audience-runs/{audienceRunId}/control"

payload := strings.NewReader("{\n \"action\": \"pause\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://brew.new/api/v1/automations/audience-runs/{audienceRunId}/control")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"action\": \"pause\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://brew.new/api/v1/automations/audience-runs/{audienceRunId}/control")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"action\": \"pause\"\n}"

response = http.request(request)
puts response.read_body
{
  "audienceRunId": "arun_01HZ",
  "status": "paused"
}
{
"error": {
"code": "INVALID_API_KEY",
"type": "authentication_error",
"message": "The provided API key is invalid.",
"suggestion": "Check the API key format and retry with a valid active key.",
"docs": "https://docs.brew.new/api-reference/api/authentication"
}
}
{
"error": {
"code": "INSUFFICIENT_PERMISSIONS",
"type": "authorization_error",
"message": "The caller does not have the required permission.",
"suggestion": "Use an API key or session with the required permission.",
"docs": "https://docs.brew.new/api-reference/api/authentication",
"param": "automations"
}
}
{
"error": {
"code": "NOT_FOUND",
"type": "not_found",
"message": "Audience run 'arun_xxx' was not found.",
"suggestion": "List runs with GET /v1/automations/audience-runs.",
"docs": "https://docs.brew.new/api-reference/api/errors",
"param": "audienceRunId"
}
}
{
"error": {
"code": "RUN_NOT_PAUSABLE",
"type": "conflict",
"message": "This run is already sent and can’t be paused.",
"suggestion": "Only a running run can be paused.",
"docs": "https://docs.brew.new/api-reference/api/errors"
}
}
{
"error": {
"code": "RATE_LIMITED",
"type": "rate_limit",
"message": "Too many requests.",
"suggestion": "Wait for the retry window before sending another request.",
"docs": "https://docs.brew.new/api-reference/api/rate-limits",
"retryAfter": 42
}
}
{
"error": {
"code": "INTERNAL_ERROR",
"type": "internal_error",
"message": "An unexpected error occurred.",
"suggestion": "Retry the request. If it keeps failing, contact support.",
"docs": "https://docs.brew.new/api-reference/api/errors"
}
}

Authorizations

Authorization
string
header
default:Bearer brew_your_api_key
required

Send your Brew API key as Authorization: Bearer brew_xxx.

Path Parameters

audienceRunId
string
required

The audience run id (from POST /v1/automations/{automationId}/run or GET /v1/automations/audience-runs).

Required string length: 1 - 64
Example:

"arun_01HZ"

Body

application/json
action
enum<string>
required
Available options:
pause,
resume,
cancel

Response

The run's new status after the control action.

audienceRunId
string
required
status
enum<string>
required
Available options:
paused,
running,
canceled