Get newsletter settings — Brigg developers

Access & visibility

Allow newsletters.GetNewsletterSettings on your API key.

Workspace access by default. Private member data requires approved member delegation through Brigg-Act-As; the key supplies permissions while private ownership and project boundaries remain enforced.

Set up authentication · Choose permissions

Request

No parameters. Send an empty JSON object ({}).

Saved settings and suggestions are different

These are workspace sender settings. Both reading and changing them require an approved owner or administrator. sender_name and reply_to are the saved overrides; null means no override is saved. default_sender_name is the workspace name used when the sender override is absent.

suggested_reply_to is the acting member’s own email address when available. It is a form suggestion, not an automatically saved setting or proof of the effective Reply-To. To use it for future newsletters, explicitly save it with Update newsletter settings. An unset saved Reply-To uses Brigg’s workspace-mailbox fallback at send time.

These settings do not choose recipients, send a newsletter or change the authenticated sending domain. Send a test email to inspect the actual From and Reply-To before sending a campaign.

Response

Returns 200 OK with a JSON body.

sender_namestring or nullRequired

Saved sender display-name override, or null to use default_sender_name.

reply_tostring or nullRequired

Saved Reply-To override, or null when unset. The suggested_reply_to value is not automatically applied.

default_sender_namestringRequired

Customer-facing workspace name used when no sender-name override is saved.

suggested_reply_tostring or nullRequired

Acting member’s own email address, or null if none is available. A suggestion for an administrator to save, not the effective send-time address.

Errors & retries

This operation reads data. It needs no idempotency key and can be retried after a transient failure.

For rate limits, follow the server’s retry guidance and back off. See HTTP errors and safe retries and limits.

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.
401	`invalid_key`	The workspace API key is missing, invalid or revoked.
403	`forbidden`	Check the key’s operation and resource grants. If Brigg-Act-As is supplied, the key must be authorized to delegate to that member.
404	`not_found`	The requested operation or resource is not available to this credential.
429	`rate_limited`	Wait for Retry-After before retrying.

Next steps

Download OpenAPI · Versioning & retirement

JSON schemas

Use the complete schemas for validation or client generation.

Full request JSON schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false,
  "examples": [
    {}
  ]
}

Full response JSON schema

{
  "type": "object",
  "properties": {
    "sender_name": {
      "type": [
        "string",
        "null"
      ],
      "description": "Saved sender display-name override, or null to use default_sender_name."
    },
    "reply_to": {
      "type": [
        "string",
        "null"
      ],
      "description": "Saved Reply-To override, or null when unset. The suggested_reply_to value is not automatically applied."
    },
    "default_sender_name": {
      "type": "string",
      "description": "Customer-facing workspace name used when no sender-name override is saved."
    },
    "suggested_reply_to": {
      "type": [
        "string",
        "null"
      ],
      "description": "Acting member’s own email address, or null if none is available. A suggestion for an administrator to save, not the effective send-time address."
    }
  },
  "required": [
    "sender_name",
    "reply_to",
    "default_sender_name",
    "suggested_reply_to"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "sender_name": null,
      "reply_to": null,
      "default_sender_name": "Northstar Consulting",
      "suggested_reply_to": "jamie@example.com"
    }
  ]
}

Try the request

Use your API key in a server environment.

Example scenarioAct as a memberRequires administrator-approved delegation.

Jamie’s address is suggested but not yet saved. The workspace name remains the default.

Request

cURL

curl 'https://api.brigg.app/v1/operations/newsletters.GetNewsletterSettings' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  --data-raw '{}'

TypeScript

const response = await fetch("https://api.brigg.app/v1/operations/newsletters.GetNewsletterSettings", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({}),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);

Python

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

payload = {}
request = Request(
    "https://api.brigg.app/v1/operations/newsletters.GetNewsletterSettings",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise

cURL

curl 'https://api.brigg.app/v1/operations/newsletters.GetNewsletterSettings' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Brigg-Act-As: $BRIGG_ACT_AS" \
  --data-raw '{}'

TypeScript

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

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

Python

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

payload = {}
request = Request(
    "https://api.brigg.app/v1/operations/newsletters.GetNewsletterSettings",
    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"],
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise

200 OK Response example

{
  "sender_name": null,
  "reply_to": null,
  "default_sender_name": "Northstar Consulting",
  "suggested_reply_to": "jamie@example.com"
}

Illustrative values, not a live response.

The saved team address applies instead of Jamie’s suggested personal address.

Request

cURL

curl 'https://api.brigg.app/v1/operations/newsletters.GetNewsletterSettings' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  --data-raw '{}'

TypeScript

const response = await fetch("https://api.brigg.app/v1/operations/newsletters.GetNewsletterSettings", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({}),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);

Python

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

payload = {}
request = Request(
    "https://api.brigg.app/v1/operations/newsletters.GetNewsletterSettings",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise

cURL

curl 'https://api.brigg.app/v1/operations/newsletters.GetNewsletterSettings' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Brigg-Act-As: $BRIGG_ACT_AS" \
  --data-raw '{}'

TypeScript

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

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

Python

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

payload = {}
request = Request(
    "https://api.brigg.app/v1/operations/newsletters.GetNewsletterSettings",
    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"],
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise

200 OK Response example

{
  "sender_name": "Northstar team",
  "reply_to": "team@example.com",
  "default_sender_name": "Northstar Consulting",
  "suggested_reply_to": "jamie@example.com"
}

Illustrative values, not a live response.