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

Close a report

PATCH/api/admin/reports/{id}
Authorization
AuthorizationBearer token · headerrequired
Path parameters
idstringrequired
min length 1
Request body
requiredapplication/json
closeReasonstringrequired
Allowed:resolvedduplicatespamnot_actionable
adminMessagestring
min length 1 · max length 4000
Responses
200

Success

Any of:
object
entriesobject[]required
Show properties
Array of object
idstringrequired
authorRolestringrequired
Show properties
Any of:
string
string
string
string
authorUserIdstringrequired
kindstringrequired
Show properties
Any of:
string
string
string
string
reasonstring | nullrequired
Show properties
Any of:
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
null
null
bodystring | nullrequired
Show properties
Any of:
string
string
null
null
createdAtstring<date-time>required
idstringrequired
scopestringrequired
Show properties
Any of:
string
string
string
string
serviceIdstring | nullrequired
Show properties
Any of:
string
string
null
null
platformAreastring | nullrequired
Show properties
Any of:
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
null
null
reporterUserIdstringrequired
statusstringrequired
Show properties
Any of:
string
string
string
string
closeReasonstring | nullrequired
Show properties
Any of:
string
string
string
string
string
string
string
string
null
null
createdAtstring<date-time>required
closedAtstring<date-time> | nullrequired
Show properties
Any of:
string<date-time>
string<date-time>
null
null
serviceSlugstring | nullrequired
Show properties
Any of:
string
string
null
null
serviceNamestring | nullrequired
Show properties
Any of:
string
string
null
null
reporterNamestring | nullrequired
Show properties
Any of:
string
string
null
null
reporterUsernamestring | nullrequired
Show properties
Any of:
string
string
null
null
reporterEmailstring | nullrequired
Show properties
Any of:
string
string
null
null
null
null
400

Response for status 400

errorstringrequired
401

Unauthorized

errorstringrequired
404

Response for status 404

errorstringrequired
409

Response for status 409

errorstringrequired
422

Validation failed

typestringrequired
onstringrequired
summarystring
messagestring
foundany
propertystring
expectedstring
500

Unhandled server error

errorstringrequired
Try it
Server
Authorization
Parameters
Bodyapplication/json
Request
curl -X PATCH '/api/admin/reports/string' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "closeReason": "resolved",
  "adminMessage": "string"
}'
Response
{
  "entries": [
    {
      "id": "string",
      "authorRole": "player",
      "authorUserId": "string",
      "kind": "player_update",
      "reason": "other",
      "body": "string",
      "createdAt": "2019-08-24T14:15:22Z"
    }
  ],
  "id": "string",
  "scope": "platform",
  "serviceId": "string",
  "platformArea": "auth",
  "reporterUserId": "string",
  "status": "open",
  "closeReason": "resolved",
  "createdAt": "2019-08-24T14:15:22Z",
  "closedAt": "2019-08-24T14:15:22Z",
  "serviceSlug": "string",
  "serviceName": "string",
  "reporterName": "string",
  "reporterUsername": "string",
  "reporterEmail": "string"
}

Was this page helpful?