Branding
You can change the look and feel of The Bridge by changing your app’s branding. The Bridge supports:
- Custom email templates for emails sent to your users
- Custom CSS for hosted views (login, user management portal)
- Custom translations for hosted views
Set Custom Email Template
Section titled “Set Custom Email Template”Override one of the predefined templates. When you override a template, The Bridge will use this content for all languages.
Available Templates
Section titled “Available Templates”| Template | Description |
|----------|-------------|
| RESET-PASSWORD | Sent when user requests a new password |
| SIGNUP | Sent when a user signs up for a new tenant |
| INVITE_NEW | Sent when a new user is invited to a tenant |
| INVITE_EXISTING | Sent when an existing user is invited to another tenant |
| PAYMENT_FAILURE | Sent to the tenant owner on subscription payment failures |
| BASE | Used for transactional emails sent through the API |
Template Variables
Section titled “Template Variables”| Variable | Example | Description |
|----------|---------|-------------|
| appName | My app | Your app name |
| appLogo | https://url-to-logo.png | Your app logo URL |
| appUrl | https://url-to-app.com | URL to your app frontend |
| emailTitle | Reset your password | Email title from standard texts |
| emailBody | To reset your password… | Email content from standard texts |
| ctaTitle | Reset password | Call-to-action button title |
| ctaUrl | https://unique-link… | Unique CTA link for this email |
| currentYear | 2025 | Current year |
HTTP Request
Section titled “HTTP Request”PUT https://api.thebridge.dev/communication/email/template/:templateName
Body Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
type | string | Required | Any of the available template names listed above |
testRecipient | string | Optional | If provided, a test email will be sent with the updated template |
content | string | Required | The template content in HTML |
Response HTTP 200
Section titled “Response HTTP 200”HTTP 200: Template updated.
Request example
curl --request PUT 'https://api.thebridge.dev/communication/email/template/SIGNUP' \
--header 'x-api-key: YOUR_APP_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
"type": "SIGNUP",
"testRecipient": "john@doe.com",
"content": "<h1>Signup</h1><a href=\"{{ctaUrl}}\">Click here</a>"
}'PUT Try it out
https://api.thebridge.dev/communication/email/template/SIGNUPGet Custom Email Template
Section titled “Get Custom Email Template”HTTP Request
Section titled “HTTP Request”GET https://api.thebridge.dev/communication/email/template/:templateName
Response HTTP 200
Section titled “Response HTTP 200”HTTP 200: Returns the template object.
Request example
curl --request GET 'https://api.thebridge.dev/communication/email/template/SIGNUP' \
--header 'x-api-key: YOUR_APP_API_KEY'Response example:
{
"type": "SIGNUP",
"content": "<h1>Signup</h1><a href=\"{{ctaUrl}}\">Click here</a>"
}
GET Try it out
https://api.thebridge.dev/communication/email/template/:templateNameDelete Custom Email Template
Section titled “Delete Custom Email Template”Deleting a custom template will restore The Bridge default template.
HTTP Request
Section titled “HTTP Request”DELETE https://api.thebridge.dev/communication/email/template/:templateName
curl --request DELETE 'https://api.thebridge.dev/communication/email/template/SIGNUP' \
--header 'x-api-key: YOUR_APP_API_KEY'Response HTTP 200
Section titled “Response HTTP 200”Set Custom CSS
Section titled “Set Custom CSS”The CSS is used by The Bridge cloud views, like Login and User Management Portal.
HTTP Request
Section titled “HTTP Request”POST https://api.thebridge.dev/admin/brand/css
curl --request POST 'https://api.thebridge.dev/admin/brand/css' \
--header 'x-api-key: YOUR_APP_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
"content": "html,body { background-color: red; }"
}'Body Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
content | string | Required | The CSS content |
Response HTTP 201
Section titled “Response HTTP 201”POST Try it out
https://api.thebridge.dev/admin/brand/cssGet Custom CSS
Section titled “Get Custom CSS”HTTP Request
Section titled “HTTP Request”GET https://api.thebridge.dev/admin/brand/css
Response HTTP 200
Section titled “Response HTTP 200”{
"content": "html,body { background-color: red; }"
}
GET Try it out
https://api.thebridge.dev/admin/brand/cssDelete Custom CSS
Section titled “Delete Custom CSS”Deleting custom CSS will restore The Bridge default styling.
HTTP Request
Section titled “HTTP Request”DELETE https://api.thebridge.dev/admin/brand/css
Response HTTP 200
Section titled “Response HTTP 200”Set Custom Translations
Section titled “Set Custom Translations”The translations are used by The Bridge cloud views, like Login and User Management Portal.
HTTP Request
Section titled “HTTP Request”POST https://api.thebridge.dev/cloud-views/brand/translations
curl --request POST 'https://api.thebridge.dev/cloud-views/brand/translations' \
--header 'x-api-key: YOUR_APP_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
"Login": "Log in",
"Email address": "Email"
}'Response HTTP 200
Section titled “Response HTTP 200”POST Try it out
https://api.thebridge.dev/cloud-views/brand/translationsGet Custom Translations
Section titled “Get Custom Translations”HTTP Request
Section titled “HTTP Request”GET https://api.thebridge.dev/cloud-views/brand/translations
Response HTTP 200
Section titled “Response HTTP 200”{
"Login": "Log in",
"Email address": "Email"
}
GET Try it out
https://api.thebridge.dev/cloud-views/brand/translations