Skip to main content
POST
Preview Email Settings

Authorizations

Authorization
string
header
required

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

Path Parameters

workspace_id
string<uuid>
required

Body

application/json

Current (possibly unsaved) form values plus the preview language.

sender_name
string | null
Maximum string length: 120
sender_email
string | null
reply_to
string | null
invitation_message
string | null
Maximum string length: 4000
salutation
string | null
senders
SenderAddressBody · object[]
Maximum array length: 20
logo_url
string | null
Maximum string length: 1000
privacy_note_enabled
boolean
default:true
primary_color
string | null
Maximum string length: 9
Pattern: ^#?[0-9a-fA-F]{3,8}$
default_sender
string | null
language
string | null

Response

Successful Response

html
string
required