Organizations

Set up email sending domain

Sets up (or replaces) the organization's sending domain and returns the DNS records to publish. Does not start sending — the domain must be verified and enabled first.

put/api/v1/org/{organizationUuid}/email-whitelabel

Request

Base URL
/ (relative, and the document’s source URL is not known)
Auth
none required
TypeScript
https://skmtc.dev/lightdash/apis/lightdash-api/docs/api/v1/org/:organizationUuid/email-whitelabel/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

organizationUuidstring uuid required

Stringified UUIDv4. See RFC 4112

Request body

fromNamestring nullable

fromEmailstring required

domainstring required

Response

status'ok' required

Changes

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