Get Email Settings
Changed onRetrieve email settings for a workspace. A workspace that has never configured its email settings has no persisted record yet; this returns 200 with the empty settings shape (address: null, address_complete: false) rather than a 404, signalling "not set up yet - PUT to configure". Check address_complete here before sending marketing email: see the Business mailing address prerequisite in the Emails Skill.
Request
- Base URLhttps://myworkspace.myclickfunnels.com/api/v2
- Auth
- HTTP bearer
- or OAuth 2Authorization codehttps://accounts.myclickfunnels.com/oauth/authorizeToken URLhttps://accounts.myclickfunnels.com/oauth/token
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
Response
OK
Example response
{
"workspace_id": 42000,
"name": "Acme Inc.",
"hide_branding": false,
"unsubscribe_footer": null,
"footer_alignment": "center",
"address_single_line": false,
"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
}Changes
- info
for the
pathrequest parameterworkspace_id, the type was generalized fromintegertostring - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status
- info