MYmyclickfunnels
Emails::Address

Create Email Address

Changed on

Create a sender ("from") email address. Provide username and name (the from-name shown on emails). By default, the address is created on ClickFunnels' shared sending domain. To use a custom domain, first provision it with POST /workspaces/{workspace_id}/emails/domains, add the returned DNS records, and have the customer connect that same root domain to this workspace as a website/hosting domain in the ClickFunnels app. Both halves are required and no API call can do the second one, so DNS records alone never make a domain ready. Re-check with POST /emails/domains/{id}/verify until ready_for_sending is true, then pass the domain's numeric id as emails_domain_id. An address created before the domain is ready is allowed; it simply reports usable_as_sender: false until then. See Addresses (pick a usable sender) in the Emails Skill.

post/workspaces/{workspace_id}/emails/addresses

Request

Path parameters

workspace_idstring required

Request body

Example request

{
  "emails_address": {
    "emails_address": {
      "username": "hello",
      "name": "Acme Support"
    }
  }
}

Response

Created

idinteger

Address ID

public_idstring nullable

Address public ID

workspace_idinteger

Workspace ID

email_addressstring

Email address

namestring nullable

Display name associated with this email address

is_workspace_defaultboolean

Whether this address is on the shared ClickFunnels sending domain (the workspace default). A workspace-default address is usable as a sender only as a fallback: once the workspace has a usable custom sender of its own, its workspace-default address reports usable_as_sender: false. So is_workspace_default: true together with usable_as_sender: false is expected whenever the workspace already has a usable custom sender.

usable_as_senderboolean

Whether this address is eligible to be used as the from sender of an email broadcast. A custom-domain address is usable once its sending domain is verified (DKIM/SPF/DMARC or a verified SMTP setting) and the workspace owns that domain. A workspace-default (shared-domain) address is usable only as a fallback - it is true when the workspace has no usable custom sender of its own and flips to false once one exists. Filter broadcast senders to addresses where this is true to avoid a broadcast failing validation at send time. See Addresses (pick a usable sender) in the Emails Skill.

created_atstring date-time nullable

Created at datetime

updated_atstring date-time nullable

Updated at datetime

Example response

{
  "id": 1,
  "public_id": "AbCdEf",
  "workspace_id": 42000,
  "email_address": "marketing@example.com",
  "name": "Marketing Team",
  "is_workspace_default": false,
  "usable_as_sender": true,
  "emails_domain": {
    "name": "example.com",
    "verified": true,
    "dkim_verified": true,
    "spf_verified": true,
    "dmarc_verified": true,
    "smtp_verified": false
  },
  "created_at": "2025-01-01T00:00:00.000Z",
  "updated_at": "2025-01-01T00:00:00.000Z"
}

Changes

  • 511d88b30aeaRevision changes
    • breaking

      the request property became required

    • breaking

      the request property / became required

    • breaking

      the request property / became required

    • breaking

      the / request property type changed from string to integer

    • info

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

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status