Emails::Settings
Update Email Settings
Update a workspace's email/marketing settings. Most importantly, this sets the marketing (business) address, which is the workspace-wide gate for sending email broadcasts: broadcasts cannot be sent until the address is complete. When an address is supplied it is validated for completeness, so a 422 here means the address is still incomplete and broadcasts remain blocked.
put/workspaces/{workspace_id}/emails/settings
Path parameters
workspace_idinteger required
Request body
Example request
{
"marketing_setting": {
"marketing_setting": {
"name": "Acme Inc.",
"address": {
"address_one": "123 Main St",
"city": "San Francisco",
"postal_code": "94105",
"country_code": "US",
"region": "CA"
}
}
}
}Response
OK
Example response
{
"workspace_id": 42000,
"system_emails_from_address": {
"email_address": "system@example.com",
"name": "System Notifications"
},
"system_emails_reply_to_address": {
"email_address": "support@example.com",
"name": "Support"
},
"marketing_emails_from_address": {
"email_address": "marketing@example.com",
"name": "Marketing Team"
},
"marketing_emails_reply_to_address": null,
"address": {
"address_one": "123 Main St",
"address_two": null,
"city": "San Francisco",
"postal_code": "94105",
"region_name": "California",
"region": "CA",
"country": "US"
},
"address_complete": true
}