BrandSettings

  • company
    Type: string
    required

    Company name shown in branded headers, footers, and signing pages.

  • contactEmail
    Type: stringFormat: email
    required

    Reply-to / support contact email shown to recipients of branded communications.

  • logoFileId
    Type: string
    required

    ID of the logo file. Upload the asset first via POST .../files/upload-url and pass the returned fileId here. Fetch the bytes via the files endpoint when you need to render the logo.

  • senderName
    Type: string
    required

    Display name shown as the sender on outbound emails (e.g. "Acme Corp HR").

  • address
    Type: string

    Optional postal address for the brand. Shown in email footers where required for compliance (e.g. CAN-SPAM).

  • phone
    Type: string

    Optional contact phone number shown alongside contactEmail on branded surfaces.

  • senderEmail
    Type: stringFormat: email

    From-address used on outbound emails. Must be on a verified sending domain — see senderEmailVerified.

  • senderEmailVerified
    Type: boolean
    read-only

    Whether senderEmail has passed domain verification. Response-only — set by the verification flow, not by PATCH. Outbound emails fall back to a default sender when false.