> ## Documentation Index > Fetch the complete documentation index at: https://docs.lightdash.com/llms.txt > Use this file to discover all available pages before exploring further. # Enable or disable email sending domain > Enables or disables sending from the verified domain. Can only be enabled once both DKIM and return-path are verified. ## OpenAPI ````yaml https://raw.githubusercontent.com/lightdash/lightdash/refs/heads/main/packages/backend/src/generated/swagger.json patch /api/v1/org/{organizationUuid}/email-whitelabel openapi: 3.0.0 info: title: Lightdash API version: 0.3355.0 description: > Open API documentation for all public Lightdash API endpoints. # Authentication Before you get started, you might need to create a Personal Access Token to authenticate via the API. You can create a token by following this guide: https://docs.lightdash.com/references/personal_tokens license: name: MIT contact: name: Lightdash Support email: support@lightdash.com url: https://docs.lightdash.com/help-and-contact/contact/contact_info/ servers: - url: / security: [] tags: - name: My Account description: These routes allow users to manage their own user account. - name: Organizations description: >- Each user is a member of a single organization. These routes allow users to manage their organization. Most actions are only available to admin users. - name: Projects description: >- Projects belong to a single organization. These routes allow users to manage their projects, browse content, and execute queries. Users inside an organization might have access to a project from an organization-level role or they might be granted access to a project directly. - name: Spaces description: >- Spaces allow you to organize charts and dashboards within a project. They also allow granular access to content by allowing you to create private spaces, which are only accessible to the creator and admins. - name: Roles & Permissions description: >- These routes allow users to manage roles and permissions for their organization. externalDocs: url: https://docs.lightdash.com/references/roles - name: Query description: >- These routes allow users to execute and manage queries against their data warehouse. This includes metric queries, SQL queries, and retrieving query results. paths: /api/v1/org/{organizationUuid}/email-whitelabel: patch: tags: - Organizations summary: Enable or disable email sending domain description: >- Enables or disables sending from the verified domain. Can only be enabled once both DKIM and return-path are verified. operationId: UpdateEmailWhitelabel parameters: - in: path name: organizationUuid required: true schema: $ref: '#/components/schemas/UUID' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateEmailWhitelabel' responses: '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/ApiEmailWhitelabelResponse' default: description: Error content: application/json: schema: $ref: '#/components/schemas/ApiErrorPayload' security: [] components: schemas: UUID: type: string format: uuid description: |- Stringified UUIDv4. See [RFC 4112](https://tools.ietf.org/html/rfc4122) pattern: >- [0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12} UpdateEmailWhitelabel: properties: isEnabled: type: boolean required: - isEnabled type: object description: Toggle sending on/off. Can only be enabled once fully verified. ApiEmailWhitelabelResponse: properties: results: allOf: - $ref: '#/components/schemas/OrganizationEmailWhitelabel' nullable: true status: type: string enum: - ok nullable: false required: - results - status type: object ApiErrorPayload: properties: error: properties: data: $ref: '#/components/schemas/AnyType' description: Optional data containing details of the error message: type: string description: A friendly message summarising the error name: type: string description: Unique name for the type of error statusCode: type: number format: integer description: HTTP status code required: - name - statusCode type: object status: type: string enum: - error nullable: false required: - error - status type: object description: |- The Error object is returned from the api any time there is an error. The message contains OrganizationEmailWhitelabel: properties: createdAt: type: string format: date-time lastCheckedAt: type: string format: date-time nullable: true description: Last time the provider was polled for verification, null if never. dnsRecords: items: $ref: '#/components/schemas/EmailDnsRecord' type: array isEnabled: type: boolean isVerified: type: boolean description: Both DKIM and return-path verified — required before enabling. returnPathVerified: type: boolean dkimVerified: type: boolean status: $ref: '#/components/schemas/EmailWhitelabelStatus' fromName: type: string nullable: true description: >- Display name shown in the From header, or null to use the Lightdash default. fromEmail: type: string description: The address emails are sent from, e.g. `reports@customer.com`. domain: type: string description: >- Domain (or subdomain) emails are sent from, e.g. `reports.customer.com`. organizationUuid: type: string required: - createdAt - lastCheckedAt - dnsRecords - isEnabled - isVerified - returnPathVerified - dkimVerified - status - fromName - fromEmail - domain - organizationUuid type: object description: >- The full sender-identity configuration for an organization, as returned to the setup UI. `null` from the API means the org has not started setup. AnyType: description: |- This AnyType is an alias for any The goal is to make it easier to identify any type in the codebase without having to eslint-disable all the time These are only used on legacy `any` types, don't use it for new types. This is added on a separate file to avoid circular dependencies. EmailDnsRecord: properties: verified: type: boolean value: type: string description: The value the record must resolve to (right-hand side). name: type: string description: The host / name of the record (left-hand side). type: type: string enum: - TXT - CNAME purpose: type: string enum: - dkim - return-path required: - verified - value - name - type - purpose type: object description: >- A single DNS record the customer must add at their DNS provider. Values are always the real, per-domain values returned by the provider — never a templated example. EmailWhitelabelStatus: type: string enum: - pending - verified - enabled - failed description: >- Lifecycle of an organization's sending domain. - `pending` — records handed over, waiting on DNS to propagate & verify. - `verified` — both DKIM and return-path verified, ready to enable. - `enabled` — verified and turned on; report emails send from this domain. - `failed` — verification did not complete within the timeout window; the admin can re-check to restart. ````