# Update newsletter schedule

Update a newsletter series using schedule_id, or pause future preparation. Public callers can select manual approval; automatic delivery must be configured in Brigg. Changing a schedule does not resend an existing issue.

POST https://api.brigg.app/v1/operations/newsletters.UpdateNewsletterSchedule

## Access & visibility

Allow `newsletters.UpdateNewsletterSchedule` on your API key.

**Acting member required.** Send `Brigg-Act-As` with an [approved member account ID](https://developer.brigg.app/authentication#member-delegation). The key supplies permissions; the member selects whose data is used.

The selected member must be active and approved by the credential. This selects whose private data is used; the credential supplies permissions. Private ownership and project boundaries still apply.

[Set up authentication](https://developer.brigg.app/authentication) · [Choose permissions](https://developer.brigg.app/permissions)

## Request fields

Send a JSON object with the following fields. Required fields must be included; omit optional fields you do not need.
| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `schedule_id` | string | Yes | Use schedule_id from the schedule listing. A schedule can produce multiple issues. [newsletters.ListNewsletterSchedules](https://developer.brigg.app/reference/newsletters/ListNewsletterSchedules). At least 1 character. |
| `name` | string | No | Display name. At least 1 character. At most 120 characters. |
| `frequency` | string | No | How often the schedule prepares a newsletter issue. Allowed: `"weekly"`, `"biweekly"`, `"monthly"`. |
| `start_at` | integer | No | Epoch ms of the first issue, wall-clock in `timezone`. Greater than 0. |
| `timezone` | string | No | IANA time zone, for example Europe/Oslo. At least 1 character. At most 64 characters. |
| `audience` | [object](#request-audience) | No | Selected recipients or audience definition for this newsletter. |
| `sources` | [object](#request-sources) | No | Sources used to prepare the newsletter's content. |
| `instructions_md` | string or null | No | Editorial instructions in Markdown for preparing the newsletter. |
| `template_id` | string or null | No | Select an existing newsletter and use its content_id as the schedule template. A Word or meeting template cannot be used here. [workspace.ListBundles](https://developer.brigg.app/reference/workspace/ListBundles). |
| `approval` | string | No | Each issue is prepared for a person to review and send in Brigg. Automatic sending must be configured in Brigg. Always `"manual"`. |
| `paused` | boolean | No | Pause (true) or resume (false) the series. |

### request.audience

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `mode` | string | Yes | all selects all contacts; tags selects contacts carrying at least one selected tag; manual uses only the supplied email addresses. Allowed: `"all"`, `"tags"`, `"manual"`. |
| `tags` | array of string | Yes | Stable contact tag keys. Used only in tags mode. |
| `extra` | array of string | Yes | Explicit additional email addresses. In manual mode these are the entire audience. |

### request.sources

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `website` | [object](#request-sources-website) | Yes | Company website URL, including https://. |
| `blog` | [object](#request-sources-blog) | Yes | Blog content source configured for this newsletter. |
| `web_search` | boolean | Yes | Research relevant public web sources. |
| `meetings` | boolean | Yes | Use information from shared workspace meetings. |
| `new_clients` | boolean | Yes | Use recently added CRM companies. |
| `instructions` | string | Yes | Additional instructions for preparing each issue. |

### request.sources.website

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `enabled` | boolean | Yes | Whether this feature is enabled. |
| `url` | string | Yes | Absolute URL, including its scheme. |

### request.sources.blog

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `enabled` | boolean | Yes | Whether this feature is enabled. |
| `url` | string | Yes | Absolute URL, including its scheme. |

## Preparation, review and sending are separate

A schedule produces issues. An issue has its own `issue_id`; its generated content has a separate `newsletter_id`. Read [Get newsletter issue](https://developer.brigg.app/reference/newsletters/GetNewsletterIssue) until that content and its `review_url` are available. A schedule start or run response does not mean preparation has finished.

Public callers use manual approval. A person reviews and sends the issue in Brigg; preparing content or saving a draft does not send it to the audience. [Send newsletter test email](https://developer.brigg.app/reference/newsletters/SendNewsletterTestEmail) sends a test to the acting member, not the subscriber list.

A schedule's `start_at` is Unix milliseconds and its `timezone` is an IANA zone used for recurrence. `run_now` creates an extra first issue without consuming the first scheduled slot. Pause a schedule with `paused: true` when you want to stop future preparation while retaining the schedule.

## Response

Returns **200 OK** with a JSON body.
| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `ok` | boolean | Yes | Whether the action completed successfully. |
| `next_run_at` | number or null | Yes | Epoch ms of the next issue; null while the series is paused. |

## Errors & retries

Set `BRIGG_REQUEST_ID` once for each logical action. The samples send it as `Idempotency-Key`. Reuse the same value and body on retries, including after a timeout; a missing response does not prove the action failed.

For rate limits, follow the server’s retry guidance and back off. See [HTTP errors](https://developer.brigg.app/http#errors) and [safe retries and limits](https://developer.brigg.app/reliability).

| HTTP status | Code | What to do |
| --- | --- | --- |
| 400 | `invalid_json` | Send a JSON object with Content-Type: application/json. |
| 400 | `invalid_input` | Check the request fields and types. Supply a stable Idempotency-Key containing 1–200 characters. |
| 401 | `invalid_key` | The workspace API key is missing, invalid or revoked. |
| 403 | `forbidden` | Check the key’s operation and resource grants. Supply Brigg-Act-As with a member authorized by the key’s delegation grant. The selected member must be active and approved by the credential. This selects whose private data is used; the credential supplies permissions. Private ownership and project boundaries still apply. |
| 404 | `not_found` | The requested operation or resource is not available to this credential. |
| 429 | `rate_limited` | Wait for Retry-After before retrying. Reuse the original Idempotency-Key. |

## Next steps

- [List newsletter schedules](https://developer.brigg.app/reference/newsletters/ListNewsletterSchedules)
- [List newsletter issues](https://developer.brigg.app/reference/newsletters/ListNewsletterIssues)
- [Get newsletter issue](https://developer.brigg.app/reference/newsletters/GetNewsletterIssue)
- [List bundles](https://developer.brigg.app/reference/workspace/ListBundles)

[Download OpenAPI](https://developer.brigg.app/openapi.json) · [Versioning & retirement](https://developer.brigg.app/versioning)

## Examples

### Example request

Fictional values. Replace IDs and business details with values from your workspace.
#### cURL


```sh
curl 'https://api.brigg.app/v1/operations/newsletters.UpdateNewsletterSchedule' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Brigg-Act-As: $BRIGG_ACT_AS" \
  -H "Idempotency-Key: $BRIGG_REQUEST_ID" \
  --data-raw '{
  "schedule_id": "e_example"
}'
```

#### TypeScript


```typescript
const actAs = process.env.BRIGG_ACT_AS;
if (!actAs) throw new Error("Set BRIGG_ACT_AS to an approved member account ID.");

const requestId = process.env.BRIGG_REQUEST_ID;
if (!requestId) throw new Error("Set BRIGG_REQUEST_ID once per action and reuse it on retries.");

const response = await fetch("https://api.brigg.app/v1/operations/newsletters.UpdateNewsletterSchedule", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
    "Brigg-Act-As": actAs,
    "Idempotency-Key": requestId, // Create once per action; reuse on retries.
  },
  body: JSON.stringify({
    "schedule_id": "e_example"
  }),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);
```

#### Python


```python
import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

request_id = os.environ["BRIGG_REQUEST_ID"]  # Reuse for retries of this action.
payload = {
  "schedule_id": "e_example"
}
request = Request(
    "https://api.brigg.app/v1/operations/newsletters.UpdateNewsletterSchedule",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
        "Brigg-Act-As": os.environ["BRIGG_ACT_AS"],
        "Idempotency-Key": request_id,  # Create once per action; reuse on retries.
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise
```

#### Response example


```json
{
  "ok": true,
  "next_run_at": null
}
```

## JSON schemas


```json-schema-request
{
  "type": "object",
  "properties": {
    "schedule_id": {
      "type": "string",
      "minLength": 1,
      "description": "Use schedule_id from the schedule listing. A schedule can produce multiple issues. [newsletters.ListNewsletterSchedules](https://developer.brigg.app/reference/newsletters/ListNewsletterSchedules)."
    },
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 120,
      "description": "Display name."
    },
    "frequency": {
      "type": "string",
      "enum": [
        "weekly",
        "biweekly",
        "monthly"
      ],
      "description": "How often the schedule prepares a newsletter issue."
    },
    "start_at": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "description": "Epoch ms of the first issue, wall-clock in `timezone`."
    },
    "timezone": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64,
      "description": "IANA time zone, for example Europe/Oslo."
    },
    "audience": {
      "type": "object",
      "properties": {
        "mode": {
          "type": "string",
          "enum": [
            "all",
            "tags",
            "manual"
          ],
          "description": "all selects all contacts; tags selects contacts carrying at least one selected tag; manual uses only the supplied email addresses."
        },
        "tags": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Stable contact tag keys. Used only in tags mode."
        },
        "extra": {
          "type": "array",
          "items": {
            "type": "string",
            "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$"
          },
          "description": "Explicit additional email addresses. In manual mode these are the entire audience."
        }
      },
      "required": [
        "mode",
        "tags",
        "extra"
      ],
      "additionalProperties": false,
      "$schema": "http://json-schema.org/draft-07/schema#",
      "description": "Selected recipients or audience definition for this newsletter."
    },
    "sources": {
      "type": "object",
      "properties": {
        "website": {
          "type": "object",
          "properties": {
            "enabled": {
              "type": "boolean",
              "description": "Whether this feature is enabled."
            },
            "url": {
              "type": "string",
              "description": "Absolute URL, including its scheme."
            }
          },
          "required": [
            "enabled",
            "url"
          ],
          "additionalProperties": false,
          "description": "Company website URL, including https://."
        },
        "blog": {
          "type": "object",
          "properties": {
            "enabled": {
              "type": "boolean",
              "description": "Whether this feature is enabled."
            },
            "url": {
              "type": "string",
              "description": "Absolute URL, including its scheme."
            }
          },
          "required": [
            "enabled",
            "url"
          ],
          "additionalProperties": false,
          "description": "Blog content source configured for this newsletter."
        },
        "web_search": {
          "type": "boolean",
          "description": "Research relevant public web sources."
        },
        "meetings": {
          "type": "boolean",
          "description": "Use information from shared workspace meetings."
        },
        "new_clients": {
          "type": "boolean",
          "description": "Use recently added CRM companies."
        },
        "instructions": {
          "type": "string",
          "description": "Additional instructions for preparing each issue."
        }
      },
      "required": [
        "website",
        "blog",
        "web_search",
        "meetings",
        "new_clients",
        "instructions"
      ],
      "additionalProperties": false,
      "$schema": "http://json-schema.org/draft-07/schema#",
      "description": "Sources used to prepare the newsletter's content."
    },
    "instructions_md": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 4000
        },
        {
          "type": "null"
        }
      ],
      "description": "Editorial instructions in Markdown for preparing the newsletter."
    },
    "template_id": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 80
        },
        {
          "type": "null"
        }
      ],
      "description": "Select an existing newsletter and use its content_id as the schedule template. A Word or meeting template cannot be used here. [workspace.ListBundles](https://developer.brigg.app/reference/workspace/ListBundles)."
    },
    "approval": {
      "type": "string",
      "const": "manual",
      "description": "Each issue is prepared for a person to review and send in Brigg. Automatic sending must be configured in Brigg."
    },
    "paused": {
      "type": "boolean",
      "description": "Pause (true) or resume (false) the series."
    }
  },
  "required": [
    "schedule_id"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "schedule_id": "e_example"
    }
  ]
}
```


```json-schema-response
{
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Whether the action completed successfully."
    },
    "next_run_at": {
      "type": [
        "number",
        "null"
      ],
      "description": "Epoch ms of the next issue; null while the series is paused."
    }
  },
  "required": [
    "ok",
    "next_run_at"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "ok": true,
      "next_run_at": null
    }
  ]
}
```