docs: Add locale overwrite to project documentation

This commit is contained in:
Dries Augustyns
2025-12-25 17:53:58 +01:00
parent 76155232a3
commit 1fc1e23fce
@@ -35,6 +35,46 @@ The `data` field stores custom key-value pairs.
- Store dates as ISO strings: `"2024-03-15T10:30:00Z"`
- Use numbers for numeric values (enables comparisons)
## Localization
The `locale` field in contact data overrides the project-wide language setting for that specific contact.
**Where it's used:**
- Unsubscribe and preference center pages
- Email footer translations
- All contact-facing content
**Example:**
```javascript
// Set a contact's preferred language
POST /contacts
{
"email": "[email protected]",
"data": {
"locale": "de" // German
}
}
```
**Via tracking:**
```javascript
POST /v1/track
{
"event": "signup",
"email": "[email protected]",
"data": {
"locale": "fr" // French
}
}
```
**Behavior:**
- If `locale` is set: uses contact's language
- If not set: uses project's default language
- Falls back to English if neither is set
## Template variables
Use `{{fieldName}}` in emails:
@@ -45,7 +85,7 @@ Use `{{fieldName}}` in emails:
**Fallback:** `{{firstName ?? 'there'}}`
**Reserved:** `{{email}}`, `{{id}}`
**Predefined fields:** `{{email}}`, `{{unsubscribeUrl}}`, `{{subscribeUrl}}`, `{{manageUrl}}`, `{{locale}}`
## Temporary data