/api/admin/settingsAdminChange the deployment settings
Changes the given deployment settings; omitted settings keep their values. default_time_zone sets the IANA time zone the admin pages show times in and email traffic is grouped by (null = each viewer's browser time zone); it must be known to both the runtime and the database.
updateDeploymentSettingsAdmin: SettingsAuthentication & permissionsAdmin
Platform administrators only
- Accepted credentials
- Access token (Bearer)
Authorization: Bearer <JWT> - Access token (cookie)
cookie "access_token_schemavaults-mail"
- Access token (Bearer)
- Who may call
- Platform administrators only
Request body
Required
| Property | Type | Description |
|---|---|---|
| default_time_zone | string | null | null | IANA time zone for the admin pages' times and email traffic grouping, e.g. maxLength: 64 |
Responses
| Property | Type | Description |
|---|---|---|
| success* | true | |
| data* | DeploymentSettings | Deployment-wide settings managed at /admin/settings. |
| default_time_zone* | string | null | null | IANA time zone the admin pages show times in and group email traffic by (e.g. maxLength: 64 |
| updated_at* | number | null | null | Unix epoch milliseconds when an admin last changed the settings, or null if they never have. minimum: 0 |
| message* | string |
Example request
curl -X PATCH 'https://mail.schemavaults.com/api/admin/settings' \
-H 'Authorization: Bearer <access_token>' \
-H 'Content-Type: application/json' \
-d '{
"default_time_zone": "America/New_York"
}'