Skip to main content
PUT
/
newsletter
/
settings
Update Newsletter Settings
curl --request PUT \
  --url https://api.getmaito.com/v1/newsletter/settings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "newsletterName": "Maito Weekly",
  "senderName": "Maito"
}
'
{
  "data": {
    "accountSetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "workspaceId": "<string>",
    "newsletterName": "<string>",
    "contentTags": [
      "<string>"
    ],
    "senderName": "<string>",
    "senderEmail": "jsmith@example.com",
    "publicNewsletterId": "<string>",
    "publicSubscribeSlug": "<string>",
    "physicalAddress": "<string>",
    "senderEmailDnsRecords": [
      {
        "name": "<string>",
        "value": "<string>"
      }
    ],
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "newsletterDescription": "<string>",
    "publicationLogoUrl": "<string>",
    "defaultThumbnailUrl": "<string>",
    "replyToEmail": "jsmith@example.com",
    "publicSubdomain": "<string>",
    "senderEmailVerificationType": "<string>",
    "senderEmailVerificationRequestedAt": "<string>",
    "senderEmailVerificationCheckedAt": "<string>",
    "senderEmailVerifiedAt": "<string>",
    "senderEmailVerificationError": "<string>"
  }
}

Authorizations

Authorization
string
header
default:your-api-key
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Provide at least one newsletter setting.

newsletterName
string
newsletterDescription
string | null
publicationLogoUrl
string<uri> | null
defaultThumbnailUrl
string<uri> | null
contentTags
string[]
Maximum array length: 3
widgetThemeColor
enum<string>
Available options:
black,
blue,
green,
fuchsia,
orange,
red
senderName
string
senderEmail
string<email>
replyToEmail
string<email> | null
publicSubscribeSlug
string
Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$
publicSubdomain
string | null
Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$
physicalAddress
string

Response

Successful response.

ok
enum<boolean>
required
Available options:
true
data
object
required