Skip to main content

PlayInvalidateRequest

Body for POST /play/{play_id}/invalidate, which discards a play the client could not play (for example the URL would not load or was invalid) so that a replacement can be requested.

client_idstring

The client that owns the play. Required, but may instead arrive as a cid cookie or a client_id query parameter — see Identifying a client. Values longer than 23 characters are silently truncated.

Possible values: <= 23 characters

reasonstring

Free-text explanation of why the play could not be used. Logged for diagnostics; not interpreted by the server.

PlayInvalidateRequest
{
"client_id": "string",
"reason": "string"
}