Skip to main content
The district endpoint gives you access to your district’s configuration — name, accent color, supported languages, and the full settings object.

Get district

Returns your district’s configuration and settings. Example:
Response:

Update district

Requires the Settings permission (s: 1). Update your district’s name, accent color, supported languages, or settings blob. Request body:
object
Multilingual district name: { "en": "My District" }
string
Hex color code for the district accent (e.g., "#6e5dec")
array
Array of BCP 47 language codes supported by the district (e.g., ["en", "es"])
object
Partial settings object. Merged with existing settings — only keys you include are updated.
Example — update district name and accent:
Response:

Settings structure

The settings object contains all district configuration. Key top-level keys:
The settings structure uses short keys for storage efficiency. Refer to the app’s Settings UI for a human-readable view of what each key controls.