Skip to content
Athena User Guide
Esc
↑↓navigate↵open⌘Jpreview

Issue certificates to the qualifying players

Only the event’s system key, which the Athena organizer panel holds, may call this. An organizer API key is refused with 403; use the panel.

POST/api/admin/certificates/issue
Authorization
AuthorizationBearer token · headerrequired
Request body
requiredapplication/json
regenerateboolean
eventNamestringrequired
min length 1 · max length 200
issuedBystring
min length 1
Responses
200

Response for status 200

issuedintegerrequired
min -9007199254740991 · max 9007199254740991
reissuedintegerrequired
min -9007199254740991 · max 9007199254740991
skippedExistingintegerrequired
min -9007199254740991 · max 9007199254740991
skippedNoTierintegerrequired
min -9007199254740991 · max 9007199254740991
skippedNoTemplateintegerrequired
min -9007199254740991 · max 9007199254740991
byTierobjectrequired
400

Response for status 400

errorstringrequired
401

Unauthorized

errorstringrequired
403

Response for status 403

errorstringrequired
422

Validation failed

typestringrequired
onstringrequired
summarystring
messagestring
foundany
propertystring
expectedstring
500

Unhandled server error

errorstringrequired
Try it
Server
Authorization
Bodyapplication/json
Request
curl -X POST '/api/admin/certificates/issue' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "regenerate": true,
  "eventName": "string",
  "issuedBy": "string"
}'
Response
{
  "issued": -9007199254740991,
  "reissued": -9007199254740991,
  "skippedExisting": -9007199254740991,
  "skippedNoTier": -9007199254740991,
  "skippedNoTemplate": -9007199254740991,
  "byTier": {
    "property1": -9007199254740991,
    "property2": -9007199254740991
  }
}

Was this page helpful?