Mailing Settings
Mailing settings hold the footer name and address for your messages, the workspace timezone chosen for your account, and whether a hosted list signup requires confirmation.
Overview
There is one set of settings for your account. Get Mailing Settings reads them. Update Mailing Settings changes only the fields you send.
Endpoints
| Method | Endpoint | Description |
|---|---|---|
| GET | /settings | Get mailing settings |
| PATCH | /settings | Update mailing settings |
Mailing Settings Object
| Field | Type | Description |
|---|---|---|
name | string|null | Name printed in the message footer. null when unset. |
address | string|null | Postal address printed in the message footer. null when unset. |
timezone | object|null | Workspace timezone chosen for your account, or null when none is set. See Workspace timezone. |
requires_double_opt_in | boolean | Whether a hosted list signup requires confirmation. See Double opt-in. |
Workspace timezone
timezone is the workspace timezone chosen for your account. It is null until you set one.
The object has the same fields as a Timezone Object. iana is the name, such as America/New_York. uuid is the value you send as timezone_uuid.
Take that UUID from List Timezones. Choosing one here leaves the timezone on each contact unchanged.
Double opt-in
requires_double_opt_in is false until you set it to true.
When it is false, a signup on a hosted list page subscribes immediately. When it is true, that signup sends a confirmation link and does not subscribe until the link is confirmed.
Contacts already on a list stay as they are. Create Contact does not use this flag, and neither do Add Contact to List or Remove Contact from List.