Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.humanly.io/llms.txt

Use this file to discover all available pages before exploring further.

Overview

Branding settings control the visual appearance and branding of interview invites and the candidate experience.

Get Branding

Get organization/team branding settings. Endpoint: GET /qsi/gather/branding
{
  "data": {
    "organizationId": "uuid",
    "logoUrl": "https://...",
    "primaryColor": "#3B82F6",
    "secondaryColor": "#2563EB",
    "customDomain": "interviews.yourcompany.com",
    "emailBranding": {
      "fromName": "Your Company",
      "fromEmail": "noreply@yourcompany.com"
    }
  },
  "meta": {
    "requestId": "uuid",
    "timestamp": "2024-01-01T00:00:00Z"
  }
}

Update Branding

Update branding settings. Endpoint: PATCH /qsi/gather/branding
Branding updates are a lower priority feature. Contact support if you need to modify branding settings.

Branding Elements

Your organization logo appears on interview invites and the candidate experience page.

Colors

Primary and secondary colors are used throughout the candidate experience to match your brand.

Custom Domain

Use a custom domain for interview links (e.g., interviews.yourcompany.com).

Email Branding

Customize the “from” name and email address for interview invite emails.
Branding customization requires proper domain verification and configuration. Contact support for assistance.

Message Groups

Learn about message groups and templates

Interviews

Learn about creating interviews