Sign in
Email Domains

Add workspace domain

Add a new email domain for a specific workspace. This initiates the domain verification process. After creation, you must:

  1. Add a TXT record to your DNS with the verification token
  2. Call POST /workspace/{workspace_id}/domains/{id}/verify-ownership to verify domain ownership
  3. Call POST /workspace/{workspace_id}/domains/{id}/finalize to register with email provider
  4. Add the returned DNS records (SPF, DKIM, etc.)
  5. Call POST /workspace/{workspace_id}/domains/{id}/verify-dns to complete verification
post/workspace/{workspace_id}/domains

Path parameters

workspace_idstring uuid required

Workspace ID

Request body

domainstring required

Domain name to add (e.g., 'example.com'). Must be a valid domain format.

Example request

{
  "domain": "sales.acme.com"
}

Response

Domain created successfully. Add the verification TXT record to your DNS.

Example response

{
  "verification_instructions": {
    "record_type": "TXT",
    "record_name": "_firma-verification.acme.com",
    "record_value": "firma-verify=abc123xyz",
    "next_step": "Add this TXT record to your DNS, then call POST /company/domains/{id}/verify-ownership"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.