Skip to main content

Toggle a project setting

PUT /v1/project/settings/{key}
devhttps://api.sandbox.ovok.com

Flip a single boolean setting on the caller's current project. Some keys (CONTENT_ENABLED, MAILING_ENABLED) are paid-tier add-ons and return 402 on Free; flipping them OFF is always allowed so a tier downgrade doesn't strand a project. Admin only.

Body

{ "enabled": true | false }

Example

curl -X PUT '<APP_BASE_URL>/v1/project/settings/WEARABLE_STRAVA_ENABLED' \
-H 'Authorization: Bearer <admin-token>' \
-H 'Content-Type: application/json' \
-d '{ "enabled": true }'

Returns the full updated settings map.

Parameters

NameInTypeRequiredDescription
keypathstringyes

Request body

Content-Type: application/json

  • enabled: boolean (required)

Responses

CodeDescription
200Success.
400The request could not be operated by the server.
401The resource owner or authorization server denied the request.
404The requested resource could not be found.
422The request could not be validated by the server.
500The server encountered an unexpected condition. Please try again later.

200ProjectSettingsResponseDto (application/json)

Boolean toggle state for every known project setting

  • projectId: string (required)
  • settings: object (required)

Example

{
"projectId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"settings": {
"CONTENT_ENABLED": false,
"PATIENT_INVITATION_ENABLED": true,
"PATIENT_REGISTRATION_ENABLED": true,
"PATIENT_LOGIN_ENABLED": true,
"PRACTITIONER_INVITATION_ENABLED": true,
"PRACTITIONER_REGISTRATION_ENABLED": false,
"PRACTITIONER_LOGIN_ENABLED": true
}
}