# Get newsletter settings

Read the workspace's saved newsletter sender name and reply address, together with suggested defaults.

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

## Access & visibility

Allow `newsletters.GetNewsletterSettings` on your API key.

**Workspace access by default.** Private member data requires [approved member delegation](https://developer.brigg.app/authentication#member-delegation) through `Brigg-Act-As`; the key supplies permissions while private ownership and project boundaries remain enforced.

[Set up authentication](https://developer.brigg.app/authentication) · [Choose permissions](https://developer.brigg.app/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](https://developer.brigg.app/reference/newsletters/UpdateNewsletterSettings). 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.
| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `sender_name` | string or null | Yes | Saved sender display-name override, or null to use default_sender_name. |
| `reply_to` | string or null | Yes | Saved Reply-To override, or null when unset. The suggested_reply_to value is not automatically applied. |
| `default_sender_name` | string | Yes | Customer-facing workspace name used when no sender-name override is saved. |
| `suggested_reply_to` | string or null | Yes | 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](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. |
| 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

- [Update newsletter settings](https://developer.brigg.app/reference/newsletters/UpdateNewsletterSettings)
- [Send newsletter test email](https://developer.brigg.app/reference/newsletters/SendNewsletterTestEmail)

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

## Examples

### Read settings before saving an override

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


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

#### TypeScript


```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


```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
```

#### Response example


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

### Read configured sender settings

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


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

#### TypeScript


```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


```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
```

#### Response example


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

## JSON schemas


```json-schema-request
{
  "type": "object",
  "properties": {},
  "additionalProperties": false,
  "examples": [
    {}
  ]
}
```


```json-schema-response
{
  "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"
    }
  ]
}
```