MYmyclickfunnels
Emails::Settings

Update Email Settings

Changed on

Update a workspace's email/marketing settings. Most importantly, this sets the marketing (business) address, which is the workspace-wide prerequisite for creating broadcasts and workflow send-email steps, and for sending broadcasts. When an address is supplied it is validated for completeness, so a 422 here means marketing-email creation and sending remain blocked. A workspace that has never configured its email settings has no persisted record yet; the first PUT builds and persists it, so it succeeds rather than returning a 404. See the Business mailing address prerequisite in the Emails Skill for the exact body to send.

put/workspaces/{workspace_id}/emails/settings

Request

Path parameters

workspace_idstring 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

workspace_idinteger

Workspace ID

namestring nullable

Business/sender name shown on email broadcasts

hide_brandingboolean

Whether ClickFunnels branding is hidden in the email footer

unsubscribe_footerstring nullable

Custom unsubscribe footer text

footer_alignment'left' | 'center' | 'right'

Alignment of the email footer

address_single_lineboolean

Whether the marketing address renders on a single line

address_completeboolean

True once the marketing address satisfies the email broadcast gate. See the Business mailing address prerequisite in the Emails Skill.

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

  • 511d88b30aeaRevision changes
    • breaking

      request property / was restricted to a list of enum values

    • info

      for the path request parameter workspace_id, the type was generalized from integer to string

    • info

      added the new center enum value to the request property /

    • info

      added the new left enum value to the request property /

    • info

      added the new right enum value to the request property /

    • 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

      added the optional property to the response with the status