Customize the Style of Nylas Hosted Authentication

Nylas provides options to fully customize the look and feel of the Hosted Authentication page, so that it matches your brand and provides a seamless experience for your end-users.

You can control both Branding details (such as your app name, logo, and description) and Interface design (such as background, colors, and text alignment). These settings are updated via the Applications API.

You can customize these settings by sending a PATCH request to the /v3/applications endpoint. 

For reference, see the Nylas Admin API documentation.

Branding Options

These values define how your application’s identity is displayed during authentication.

Update these fields inside the "branding" object of your API payload:

• Name – The display name of your application.

  "name": "MyApp"

• Icon – A URL to your app’s logo/icon.

  "icon_url": "https://example.com/logo.png"

• URL – A link to your website.

  "website_url": "https://example.com"

• Description – A short description of your application.

  "description": "The best productivity app"

Interface Options

These values define how the Hosted Authentication page is styled.

Update these fields inside the "hosted_authentication" object of your API payload:

• Alignment – Alignment of text and UI components (e.g., left, center, right).

  "alignment": "center"

• Background Color – A HEX color value for the page background.

  "background_color": "#f5f5f5"

• Background Image – A URL to a background image.

  "background_image_url": "https://example.com/bg.png"

• Primary Color – HEX color for primary UI elements (e.g., buttons).

  "color_primary": "#0055ff"

• Secondary Color – HEX color for secondary elements (e.g., links).

  "color_secondary": "#ff6600"

• Spacing – Amount of padding/spacing around UI components (integer).

  "spacing": 24

• Title – A custom title shown at the top of the auth page.

  "title": "Welcome to MyApp"

• Subtitle – A smaller subtitle shown below the title.

  "subtitle": "Connect your email securely"

Notes

• All fields are optional; you can update only the ones you want to customize in a request.

• You don't need to include your application_id and organization_id in the request.

• Colors should be provided in HEX format (e.g., #000000).

• Image URLs must be accessible via HTTPS.

Updated September 23, 2025 16:49