Skip to content

Remove an upload's unused codes​

DELETE
/sponsors/{key}/manage/online-codes/batches/{batchId}

Codes already handed out stay, with their upload, as the record of their uses. The owner and admins.

Authorizations​

BearerAuth

In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.

Type
HTTP (bearer)

Parameters​

Path Parameters

key*
Type
string
Required
batchId*
Type
string
Required
Format
"uuid"

Responses​

Removed

application/json
JSON
{
"data": {
"removed": 0,
"batchKept": true
}
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI

Built with VitePress