Skip to main content

Update terms and conditions consent

MethodPath
POST/v1/slim/user/terms-and-conditions-consent

Authentication · Access policies

Accepts or withdraws the terms and conditions for the signed-in practitioner. Other consents are not changed.

Auth: Bearer token for a practitioner session (the profile must be a Practitioner). The caller's access policy must grant Consent:read, Consent:search, Consent:create and Consent:update (project admins skip this check). Scope: The caller's practitioner profile in the caller's project (from the token).

Behaviour​

  • true records acceptance of the currently published terms version. false withdraws it.
  • The acceptance is also kept as a legal Consent in your project: accepting creates or re-activates it with a link to the terms page of your project's practitioner app; withdrawing revokes it with reason withdrawn.
  • Repeating the same value writes nothing. The call is idempotent.
  • The consent answers of /v1/me/consent/* are refreshed right away.
  • Returns the resulting termsAndConditionsConsent.

Example​

curl -X POST 'https://api.sandbox.ovok.com/v1/slim/user/terms-and-conditions-consent' \
-H "Authorization: Bearer ${OVOK_TOKEN}" \
-H 'Content-Type: application/json' \
-d '{ "termsAndConditionsConsent": true }'

Successful response​

201 — Terms and conditions consent updated successfully.

Errors​

StatusMeaning
400Medplum refused the consent write.
401The bearer token is missing or invalid.
403The session is not a practitioner session, has no project, or its access policy lacks one of the Consent interactions.
409The consent write lost a conflict with a concurrent write. Retry.
422The body fails validation, for example termsAndConditionsConsent is missing or not a boolean.