Skip to content
RallyHere Docs
GitHub

Queue Person For Purge

POST
/users/v1/person/{person_id}/purge

Queue a person for purging. This can occur up to a configured amount of time in the future or can occur immediately depending on suggested_purge_time. Requires permission: purge:person:admin

Authorizations

  • HTTPBearerHeadersOrCookie

Parameters

Path Parameters

person_id
required
string format: uuid

Request Body required

Purge request to purge a person from the system. This will remove all data about that player from the system.

object
suggested_purge_time

Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone

string format: date-time

Responses

202

Successful Response

Purge response from a purge request

object
person_id
required

Person ID that will be purged

string format: uuid
purge_on
required

Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone

string format: date-time
created_on
required

Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone

string format: date-time
last_modified_on
required

Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone

string format: date-time
status
required

Status of the purge request

string

403

Forbidden

Message only response

object
message
required

Message

string

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string

500

Internal Server Error

Message only response

object
message
required

Message

string