Revoke Pass Grant

DELETE /v1/nextexams/passes/grants/{id}

Revoke a pass

Revokes the pass; it is kept, with status revoked. An exam the holder has already started can still be finished; no new one can be started. Revoking a revoked pass is not an error. Scope passes:write; the role needs passes.revoke.

Request

DELETE https://your-site.example/api/index.php/v1/nextexams/passes/grants/{id}

Parameters

Name	Type	In	Required	Description
`id`	`integer`	`path`	Yes	The record's id. (min 1)

Responses

`204` — Revoked.

Errors

Status	Code	When
`401`	`INVALID_TOKEN`	No token (`MISSING_TOKEN`), or one that is wrong, expired, revoked, or whose owner can no longer sign in (`INVALID_TOKEN`).
`403`	`MISSING_SCOPE`	The token is valid but this request is not allowed, and `code` says why: `MISSING_SCOPE` (the token lacks the scope), `FORBIDDEN` (the owner's role does not allow it), `ACCESS_DENIED` (the owner cannot manage Next Exams), `API_DISABLED` (the API Tokens app is off), `APP_DISABLED` (the feature's app is off — `meta.app` names it), `ACCOUNT_UNUSABLE` (the owner is blocked or must reset their password), `DEMO_LOCKED` (a demo site).
`404`	`NOT_FOUND`	No record has this id.

Examples

curl

curl -s -X DELETE "https://your-site.example/api/index.php/v1/nextexams/passes/grants/1" \
  -H "Authorization: Bearer $API_TOKEN"

PHP

<?php
$ch = curl_init('https://your-site.example/api/index.php/v1/nextexams/passes/grants/1');

curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST  => 'DELETE',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER     => [
        'Authorization: Bearer ' . getenv('API_TOKEN'),
    ],
]);

$response = json_decode(curl_exec($ch), true);
curl_close($ch);

JavaScript

const API_TOKEN = process.env.API_TOKEN;

const response = await fetch("https://your-site.example/api/index.php/v1/nextexams/passes/grants/1", {
  method: 'DELETE',
  headers: {
    "Authorization": `Bearer ${API_TOKEN}`,
  },
});
const data = await response.json();