nylas
    Preparing search index...

    Interface Domain

    Interface representing a registered email domain.

    Every field is optional: the API only emits fields it has populated.

    interface Domain {
        branded?: boolean;
        createdAt?: number;
        dkimPublicKey?: string;
        dkimSubmittedAt?: number;
        domainAddress?: string;
        id?: string;
        name?: string;
        organizationId?: string;
        region?: string;
        tenantKey?: string;
        updatedAt?: number;
        verifiedArc?: boolean;
        verifiedDkim?: boolean;
        verifiedDmarc?: boolean;
        verifiedFeedback?: boolean;
        verifiedMx?: boolean;
        verifiedOwnership?: boolean;
        verifiedSpf?: boolean;
    }
    Index

    Properties

    branded? createdAt? dkimPublicKey? dkimSubmittedAt? domainAddress? id? name? organizationId? region? tenantKey? updatedAt? verifiedArc? verifiedDkim? verifiedDmarc? verifiedFeedback? verifiedMx? verifiedOwnership? verifiedSpf?

    Properties

    branded?: boolean

    Whether the domain is a subdomain of a Nylas branded domain. Server-determined at create.

    createdAt?: number

    Unix timestamp when the domain was created.

    dkimPublicKey?: string

    BYODKIM public key.

    dkimSubmittedAt?: number

    Unix timestamp when the DKIM key was submitted to the provider.

    Not returned by Get or List; only populated in the Create response during branded provisioning. Treat as optional and do not depend on it from Get/List.

    domainAddress?: string

    The registered domain (for example, mail.example.com). Stored lowercased.

    id?: string

    Server-generated domain ID.

    name?: string

    Human-readable label.

    organizationId?: string

    The ID of the organization that owns the domain. Derived from auth, never client-set.

    region?: string

    Cluster region. Server-set from config at create.

    tenantKey?: string

    SES tenant key. Set during provisioning.

    updatedAt?: number

    Unix timestamp when the domain was last updated.

    verifiedArc?: boolean

    ARC verification flag.

    verifiedDkim?: boolean

    DKIM verification flag.

    verifiedDmarc?: boolean

    DMARC verification flag.

    verifiedFeedback?: boolean

    Feedback MX verification flag.

    verifiedMx?: boolean

    MX verification flag.

    verifiedOwnership?: boolean

    Ownership (TXT) verification flag.

    verifiedSpf?: boolean

    SPF verification flag.

    Settings

    Member Visibility

    On This Page

    Properties