Training Modules

Withdraw or block a qualification

Takes a qualification away from one or more people, with a reason. withdraw lets them earn it back by passing again; block bars them from earning it again, and no later pass or sign-off lifts it. Recorded as a row rather than a delete, so the record keeps showing that the person was qualified and who took it away.

Scope: modules:write

Role permission: canLock (OAuth only — API keys carry full workspace permissions)

post/v1/modules/planner/qualification

Request

  • Base URL: https://api.vidocu.ai
  • URL: https://api.vidocu.ai/v1/modules/planner/qualification
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://vidocu.ai/oauth/authorize, token URL https://api.vidocu.ai/oauth/token)

Request body

moduleIdstring required
emailsstring[] required
action'withdraw' | 'block' required
reasonstring required

Response

Success

Changes

No recorded changes to this operation across all 1 revision of this API.