API Reference

Bans

Look up and manage ban records for integrations and moderation tooling.

Lists visible bans for an administrator-linked key, lists public bans for legacy read keys, or looks up public bans by Discord ID, Fluxer ID, username, or display name.

Authentication

API key. Session-based admin browsing is available with admin=true outside the public integration flow.

Modes: API key

API key: bans:read

Permissions or Scopes

bans:read

Request Headers

Header	Value	Description
Authorization	Bearer prapi_your_key	Use this header for API-key authentication.
x-api-key	prapi_your_key	Alternative API-key header.
x-api-token	prapi_your_key	Legacy API-key header.

Parameters

Name	In	Required	Description
lookupType	query	Yes	One of fluxerId, discordId, username, or displayName. field is also accepted as an alias.
lookup	query	Yes	Identity value to search for. search is also accepted as an alias.
page	query	No	Page number. Defaults to 1.
limit	query	No	Results per page. Defaults to 48 and is capped at 100.

Validation

Validated by the server route before side effects. Invalid requests return 400 with an error message.

Errors

400 Invalid or missing lookup fields.

401 Missing, invalid, or expired API key.

403 API key is not allowed from the current IP address or is missing bans:read.

403 Administrator-linked API key is missing permission to view scoped ban records.

Rate Limits

No route-specific rate limit is documented. Global abuse protection and upstream proxy limits may still apply.

Examples and Try It

Request examples, sample output, and the live tester below apply only to this endpoint.

cURL

curl -H "Authorization: Bearer prapi_your_key" "https://playroom.date/api/bans?lookupType=discordId&lookup=123456789012345678"

JavaScript / TypeScript

const response = await fetch('https://playroom.date/api/bans?lookupType=discordId&lookup=123456789012345678', {
  method: 'GET',
  headers: {
    "Authorization": "Bearer prapi_your_key"
  },
});
const data = await response.json();

Python

import requests

headers = {"Authorization": "Bearer prapi_your_key"}
response = requests.get('https://playroom.date/api/bans?lookupType=discordId&lookup=123456789012345678', headers=headers)
print(response.json())

Example Output

{
  "success": true,
  "data": {
    "bans": [
      {
        "id": "ban_id",
        "user": {
          "username": "example",
          "displayName": "Example"
        },
        "providerIds": {
          "discordId": "123456789012345678",
          "fluxerId": null
        },
        "reason": "Rule violation",
        "community": null,
        "timestamps": {
          "createdAt": "2026-05-17T00:00:00.000Z",
          "updatedAt": "2026-05-17T00:00:00.000Z",
          "expiresAt": null
        },
        "status": {
          "active": true,
          "expired": false,
          "temporary": false,
          "public": true,
          "publicAfterExpiry": false
        }
      }
    ],
    "total": 1,
    "pages": 1,
    "currentPage": 1,
    "pagination": {
      "total": 1,
      "pages": 1,
      "currentPage": 1,
      "pageSize": 48
    },
    "lookupType": "discordId"
  },
  "error": null
}

Try It

Checking sign-in state...

Auth: No authentication

Lookup Type * (query)One of fluxerId, discordId, username, or displayName. field is also accepted as an alias.Lookup * (query)Identity value to search for. search is also accepted as an alias.Page (query)Page number. Defaults to 1.Limit (query)Results per page. Defaults to 48 and is capped at 100.

Request

GET /api/bans?lookupType=discordId&lookup=123456789012345678&page=1&limit=48

curl Equivalent

curl "https://playroom.date/api/bans?lookupType=discordId&lookup=123456789012345678&page=1&limit=48"

Sample Response

Sample Response Body

{
  "success": true,
  "data": {
    "bans": [
      {
        "id": "ban_id",
        "user": {
          "username": "example",
          "displayName": "Example"
        },
        "providerIds": {
          "discordId": "123456789012345678",
          "fluxerId": null
        },
        "reason": "Rule violation",
        "community": null,
        "timestamps": {
          "createdAt": "2026-05-17T00:00:00.000Z",
          "updatedAt": "2026-05-17T00:00:00.000Z",
          "expiresAt": null
        },
        "status": {
          "active": true,
          "expired": false,
          "temporary": false,
          "public": true,
          "publicAfterExpiry": false
        }
      }
    ],
    "total": 1,
    "pages": 1,
    "currentPage": 1,
    "pagination": {
      "total": 1,
      "pages": 1,
      "currentPage": 1,
      "pageSize": 48
    },
    "lookupType": "discordId"
  },
  "error": null
}

Fetches one ban by ID. API keys must include bans:read and be linked to an administrator with permission to view the ban community.

Authentication

API key or admin session.

Modes: logged-in user, API key

API key: bans:read

Permissions or Scopes

bans:read

Request Headers

Header	Value	Description
Authorization	Bearer prapi_your_key	API-key authentication.
x-api-key	prapi_your_key	Alternative API-key header.

Parameters

Name	In	Required	Description
id	path	Yes	Ban ID.

Validation

Validated by the server route before side effects. Invalid requests return 400 with an error message.

Errors

401 Missing, invalid, or expired API key.

403 Token is missing bans:read or the linked administrator cannot view this ban.

404 Ban not found.

Rate Limits

No route-specific rate limit is documented. Global abuse protection and upstream proxy limits may still apply.

Examples and Try It

Request examples, sample output, and the live tester below apply only to this endpoint.

cURL

curl -H "Authorization: Bearer prapi_your_key" "https://playroom.date/api/bans/resource_id"

JavaScript / TypeScript

const response = await fetch('https://playroom.date/api/bans/resource_id', {
  method: 'GET',
  headers: {
    "Authorization": "Bearer prapi_your_key"
  },
});
const data = await response.json();

Python

import requests

headers = {"Authorization": "Bearer prapi_your_key"}
response = requests.get('https://playroom.date/api/bans/resource_id', headers=headers)
print(response.json())

Example Output

{
  "success": true,
  "data": {
    "ban": {
      "id": "ban_id",
      "providerIds": {
        "discordId": "123456789012345678",
        "fluxerId": null
      },
      "reason": "Rule violation",
      "status": {
        "active": true,
        "expired": false,
        "temporary": false,
        "public": true,
        "publicAfterExpiry": false
      }
    }
  },
  "error": null
}

Try It

Checking sign-in state...

Auth: No authentication

Id * (path)Ban ID.

Request

GET /api/bans/

curl Equivalent

curl "https://playroom.date/api/bans/"

Sample Response

Sample Response Body

{
  "success": true,
  "data": {
    "ban": {
      "id": "ban_id",
      "providerIds": {
        "discordId": "123456789012345678",
        "fluxerId": null
      },
      "reason": "Rule violation",
      "status": {
        "active": true,
        "expired": false,
        "temporary": false,
        "public": true,
        "publicAfterExpiry": false
      }
    }
  },
  "error": null
}

Creates a ban. API keys must include bans:write and be linked to an administrator. The linked administrator must have equivalent create-ban permissions for the target community.

Authentication

API key or admin session + CSRF.

Modes: logged-in user, API key

API key: bans:write

Permissions or Scopes

bans:write

Request Headers

Header	Value	Description
Authorization	Bearer prapi_your_key	API-key authentication.
x-api-key	prapi_your_key	Alternative API-key header.
Content-Type	application/json	Required for JSON request bodies.

Parameters

Name	In	Required	Description
userId	body	No	Website user ID to ban.
discordId	body	No	Legacy Discord ID shortcut. Use accounts for new integrations.
accounts	body	No	Linked Discord/Fluxer accounts. Provide at least one account when userId and discordId are absent.
reason	body	Yes	Reason, 10-500 characters.
description	body	No	Optional staff-facing description, up to 1000 characters.
isPermanent	body	No	Defaults to true. Temporary bans require durationValue and durationUnit.
communityId	body	No	Community scope. Requires create access for that community.

Validation

Validated by the server route before side effects. Invalid requests return 400 with an error message.

Errors

400 Validation error or duplicate active ban.

401 Missing, invalid, or expired API key.

403 Missing bans:write or linked administrator lacks create permission.

Rate Limits

No route-specific rate limit is documented. Global abuse protection and upstream proxy limits may still apply.

Examples and Try It

Request examples, sample output, and the live tester below apply only to this endpoint.

cURL

curl -X POST -H "Authorization: Bearer prapi_your_key" -H "Content-Type: application/json" -d '{"userId":"user_id","discordId":"discord_id","accounts":"example-accounts","reason":"Repeated rule violations","description":"example-description","isPermanent":"example-isPermanent","communityId":"community_id"}' "https://playroom.date/api/bans"

JavaScript / TypeScript

const response = await fetch('https://playroom.date/api/bans', {
  method: 'POST',
  headers: {
    "Authorization": "Bearer prapi_your_key",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "userId": "user_id",
    "discordId": "discord_id",
    "accounts": "example-accounts",
    "reason": "Repeated rule violations",
    "description": "example-description",
    "isPermanent": "example-isPermanent",
    "communityId": "community_id"
  }),
});
const data = await response.json();

Python

import requests

headers = {"Authorization": "Bearer prapi_your_key"}
response = requests.post('https://playroom.date/api/bans', headers=headers, json={"userId": "user_id", "discordId": "discord_id", "accounts": "example-accounts", "reason": "Repeated rule violations", "description": "example-description", "isPermanent": "example-isPermanent", "communityId": "community_id"})
print(response.json())

Example Output

{
  "success": true,
  "data": {
    "ban": {
      "id": "ban_id",
      "providerIds": {
        "discordId": "123456789012345678",
        "fluxerId": null
      },
      "reason": "Rule violation",
      "status": {
        "active": true,
        "expired": false,
        "temporary": false,
        "public": true,
        "publicAfterExpiry": false
      }
    }
  },
  "error": null
}

Try It

Checking sign-in state...

Auth: No authentication

User Id (body)Website user ID to ban.Discord Id (body)Legacy Discord ID shortcut. Use accounts for new integrations.Accounts (body)Linked Discord/Fluxer accounts. Provide at least one account when userId and discordId are absent.Reason * (body)Reason, 10-500 characters.Description (body)Optional staff-facing description, up to 1000 characters.Is Permanent (body)Defaults to true. Temporary bans require durationValue and durationUnit.Community Id (body)Community scope. Requires create access for that community.

Request

POST /api/bans

Request Payload

{
  "reason": "Repeated rule violations"
}

curl Equivalent

curl -X POST -H "Content-Type: application/json" -d '{"reason":"Repeated rule violations"}' "https://playroom.date/api/bans"

I understand this request can change or delete application data.

Sample Response

Sample Response Body

{
  "success": true,
  "data": {
    "ban": {
      "id": "ban_id",
      "providerIds": {
        "discordId": "123456789012345678",
        "fluxerId": null
      },
      "reason": "Rule violation",
      "status": {
        "active": true,
        "expired": false,
        "temporary": false,
        "public": true,
        "publicAfterExpiry": false
      }
    }
  },
  "error": null
}

Updates ban metadata, evidence visibility, duration, linked accounts, or community. API keys must include bans:write and be linked to an administrator with edit permission.

Authentication

API key or admin session + CSRF.

Modes: logged-in user, API key

API key: bans:write

Permissions or Scopes

bans:write

Request Headers

Header	Value	Description
Authorization	Bearer prapi_your_key	API-key authentication.
x-api-key	prapi_your_key	Alternative API-key header.
Content-Type	application/json	Required for JSON request bodies.

Parameters

Name	In	Required	Description
id	path	Yes	Ban ID.
reason	body	No	Updated reason, 10-500 characters.
description	body	No	Updated description, up to 1000 characters.
isPermanent	body	No	When false, durationValue and durationUnit are required.
evidencePublic	body	No	Whether public evidence is visible in API responses.

Validation

Validated by the server route before side effects. Invalid requests return 400 with an error message.

Errors

400 Validation error.

401 Missing, invalid, or expired API key.

403 Missing bans:write or linked administrator lacks edit permission.

404 Ban not found.

Rate Limits

No route-specific rate limit is documented. Global abuse protection and upstream proxy limits may still apply.

Examples and Try It

Request examples, sample output, and the live tester below apply only to this endpoint.

cURL

curl -X PATCH -H "Authorization: Bearer prapi_your_key" -H "Content-Type: application/json" -d '{"reason":"Repeated rule violations","description":"example-description","isPermanent":"example-isPermanent","evidencePublic":"example-evidencePublic"}' "https://playroom.date/api/bans/resource_id"

JavaScript / TypeScript

const response = await fetch('https://playroom.date/api/bans/resource_id', {
  method: 'PATCH',
  headers: {
    "Authorization": "Bearer prapi_your_key",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "reason": "Repeated rule violations",
    "description": "example-description",
    "isPermanent": "example-isPermanent",
    "evidencePublic": "example-evidencePublic"
  }),
});
const data = await response.json();

Python

import requests

headers = {"Authorization": "Bearer prapi_your_key"}
response = requests.patch('https://playroom.date/api/bans/resource_id', headers=headers, json={"reason": "Repeated rule violations", "description": "example-description", "isPermanent": "example-isPermanent", "evidencePublic": "example-evidencePublic"})
print(response.json())

Example Output

{
  "success": true,
  "data": {
    "ban": {
      "id": "ban_id",
      "providerIds": {
        "discordId": "123456789012345678",
        "fluxerId": null
      },
      "reason": "Rule violation",
      "status": {
        "active": true,
        "expired": false,
        "temporary": false,
        "public": true,
        "publicAfterExpiry": false
      }
    }
  },
  "error": null
}

Try It

Checking sign-in state...

Auth: No authentication

Id * (path)Ban ID.Reason (body)Updated reason, 10-500 characters.Description (body)Updated description, up to 1000 characters.Is Permanent (body)When false, durationValue and durationUnit are required.Evidence Public (body)Whether public evidence is visible in API responses.

Request

PATCH /api/bans/

Request Payload

{
  "reason": "Repeated rule violations"
}

curl Equivalent

curl -X PATCH -H "Content-Type: application/json" -d '{"reason":"Repeated rule violations"}' "https://playroom.date/api/bans/"

I understand this request can change or delete application data.

Sample Response

Sample Response Body

{
  "success": true,
  "data": {
    "ban": {
      "id": "ban_id",
      "providerIds": {
        "discordId": "123456789012345678",
        "fluxerId": null
      },
      "reason": "Rule violation",
      "status": {
        "active": true,
        "expired": false,
        "temporary": false,
        "public": true,
        "publicAfterExpiry": false
      }
    }
  },
  "error": null
}

Updates a ban by path ID. This route is kept for clients that use PUT; PATCH /api/bans/{id} is preferred for partial updates.

Authentication

API key or admin session + CSRF.

Modes: logged-in user, API key

API key: bans:write

Permissions or Scopes

bans:write

Request Headers

Header	Value	Description
Authorization	Bearer prapi_your_key	API-key authentication.
x-api-key	prapi_your_key	Alternative API-key header.
Content-Type	application/json	Required for JSON request bodies.

Parameters

Name	In	Required	Description
id	path	Yes	Ban ID.
reason	body	No	Updated reason, 10-500 characters.
description	body	No	Updated description, up to 1000 characters.
isPermanent	body	No	When false, durationValue and durationUnit are required.
evidencePublic	body	No	Whether public evidence is visible in API responses.

Validation

Validated by the server route before side effects. Invalid requests return 400 with an error message.

Errors

400 Validation error.

401 Missing, invalid, or expired API key.

403 Missing bans:write or linked administrator lacks edit permission.

404 Ban not found.

Rate Limits

No route-specific rate limit is documented. Global abuse protection and upstream proxy limits may still apply.

Examples and Try It

Request examples, sample output, and the live tester below apply only to this endpoint.

cURL

curl -X PUT -H "Authorization: Bearer prapi_your_key" -H "Content-Type: application/json" -d '{"reason":"Repeated rule violations","description":"example-description","isPermanent":"example-isPermanent","evidencePublic":"example-evidencePublic"}' "https://playroom.date/api/bans/resource_id"

JavaScript / TypeScript

const response = await fetch('https://playroom.date/api/bans/resource_id', {
  method: 'PUT',
  headers: {
    "Authorization": "Bearer prapi_your_key",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "reason": "Repeated rule violations",
    "description": "example-description",
    "isPermanent": "example-isPermanent",
    "evidencePublic": "example-evidencePublic"
  }),
});
const data = await response.json();

Python

import requests

headers = {"Authorization": "Bearer prapi_your_key"}
response = requests.put('https://playroom.date/api/bans/resource_id', headers=headers, json={"reason": "Repeated rule violations", "description": "example-description", "isPermanent": "example-isPermanent", "evidencePublic": "example-evidencePublic"})
print(response.json())

Example Output

{
  "success": true,
  "data": {
    "ban": {
      "id": "ban_id",
      "providerIds": {
        "discordId": "123456789012345678",
        "fluxerId": null
      },
      "reason": "Rule violation",
      "status": {
        "active": true,
        "expired": false,
        "temporary": false,
        "public": true,
        "publicAfterExpiry": false
      }
    }
  },
  "error": null
}

Try It

Checking sign-in state...

Auth: No authentication

Request

PUT /api/bans/

Request Payload

{
  "reason": "Repeated rule violations"
}

curl Equivalent

curl -X PUT -H "Content-Type: application/json" -d '{"reason":"Repeated rule violations"}' "https://playroom.date/api/bans/"

I understand this request can change or delete application data.

Sample Response

Sample Response Body

{
  "success": true,
  "data": {
    "ban": {
      "id": "ban_id",
      "providerIds": {
        "discordId": "123456789012345678",
        "fluxerId": null
      },
      "reason": "Rule violation",
      "status": {
        "active": true,
        "expired": false,
        "temporary": false,
        "public": true,
        "publicAfterExpiry": false
      }
    }
  },
  "error": null
}

Legacy-compatible update route that accepts banId in the JSON body. Prefer PATCH /api/bans/{id} for new integrations.

Authentication

API key or admin session + CSRF.

Modes: logged-in user, API key

API key: bans:write

Permissions or Scopes

bans:write

Request Headers

Header	Value	Description
Authorization	Bearer prapi_your_key	API-key authentication.
x-api-key	prapi_your_key	Alternative API-key header.
Content-Type	application/json	Required for JSON request bodies.

Parameters

Name	In	Required	Description
banId	body	Yes	Ban ID to update.
reason	body	No	Updated reason, 10-500 characters.
description	body	No	Updated description, up to 1000 characters.

Validation

Validated by the server route before side effects. Invalid requests return 400 with an error message.

Errors

400 Validation error.

401 Missing, invalid, or expired API key.

403 Missing bans:write or linked administrator lacks edit permission.

404 Ban not found.

Rate Limits

No route-specific rate limit is documented. Global abuse protection and upstream proxy limits may still apply.

Examples and Try It

Request examples, sample output, and the live tester below apply only to this endpoint.

cURL

curl -X PUT -H "Authorization: Bearer prapi_your_key" -H "Content-Type: application/json" -d '{"banId":"ban_id","reason":"Repeated rule violations","description":"example-description"}' "https://playroom.date/api/bans"

JavaScript / TypeScript

const response = await fetch('https://playroom.date/api/bans', {
  method: 'PUT',
  headers: {
    "Authorization": "Bearer prapi_your_key",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "banId": "ban_id",
    "reason": "Repeated rule violations",
    "description": "example-description"
  }),
});
const data = await response.json();

Python

import requests

headers = {"Authorization": "Bearer prapi_your_key"}
response = requests.put('https://playroom.date/api/bans', headers=headers, json={"banId": "ban_id", "reason": "Repeated rule violations", "description": "example-description"})
print(response.json())

Example Output

{
  "success": true,
  "data": {
    "ban": {
      "id": "ban_id",
      "providerIds": {
        "discordId": "123456789012345678",
        "fluxerId": null
      },
      "reason": "Rule violation",
      "status": {
        "active": true,
        "expired": false,
        "temporary": false,
        "public": true,
        "publicAfterExpiry": false
      }
    }
  },
  "error": null
}

Try It

Checking sign-in state...

Auth: No authentication

Ban Id * (body)Ban ID to update.Reason (body)Updated reason, 10-500 characters.Description (body)Updated description, up to 1000 characters.

Request

PUT /api/bans

Request Payload

{
  "banId": "",
  "reason": "Repeated rule violations"
}

curl Equivalent

curl -X PUT -H "Content-Type: application/json" -d '{"banId":"","reason":"Repeated rule violations"}' "https://playroom.date/api/bans"

I understand this request can change or delete application data.

Sample Response

Sample Response Body

{
  "success": true,
  "data": {
    "ban": {
      "id": "ban_id",
      "providerIds": {
        "discordId": "123456789012345678",
        "fluxerId": null
      },
      "reason": "Rule violation",
      "status": {
        "active": true,
        "expired": false,
        "temporary": false,
        "public": true,
        "publicAfterExpiry": false
      }
    }
  },
  "error": null
}

Alias for the legacy-compatible update route. Accepts banId in the JSON body. Prefer PATCH /api/bans/{id}.

Authentication

API key or admin session + CSRF.

Modes: logged-in user, API key

API key: bans:write

Permissions or Scopes

bans:write

Request Headers

Header	Value	Description
Authorization	Bearer prapi_your_key	API-key authentication.
x-api-key	prapi_your_key	Alternative API-key header.
Content-Type	application/json	Required for JSON request bodies.

Parameters

Name	In	Required	Description
banId	body	Yes	Ban ID to update.

Validation

Validated by the server route before side effects. Invalid requests return 400 with an error message.

Errors

400 Validation error.

401 Missing, invalid, or expired API key.

403 Missing bans:write or linked administrator lacks edit permission.

Rate Limits

No route-specific rate limit is documented. Global abuse protection and upstream proxy limits may still apply.

Examples and Try It

Request examples, sample output, and the live tester below apply only to this endpoint.

cURL

curl -X PATCH -H "Authorization: Bearer prapi_your_key" -H "Content-Type: application/json" -d '{"banId":"ban_id"}' "https://playroom.date/api/bans"

JavaScript / TypeScript

const response = await fetch('https://playroom.date/api/bans', {
  method: 'PATCH',
  headers: {
    "Authorization": "Bearer prapi_your_key",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "banId": "ban_id"
  }),
});
const data = await response.json();

Python

import requests

headers = {"Authorization": "Bearer prapi_your_key"}
response = requests.patch('https://playroom.date/api/bans', headers=headers, json={"banId": "ban_id"})
print(response.json())

Example Output

{
  "success": true,
  "data": {
    "ban": {
      "id": "ban_id",
      "providerIds": {
        "discordId": "123456789012345678",
        "fluxerId": null
      },
      "reason": "Rule violation",
      "status": {
        "active": true,
        "expired": false,
        "temporary": false,
        "public": true,
        "publicAfterExpiry": false
      }
    }
  },
  "error": null
}

Try It

Checking sign-in state...

Auth: No authentication

Ban Id * (body)Ban ID to update.

Request

PATCH /api/bans

Request Payload

{
  "banId": ""
}

curl Equivalent

curl -X PATCH -H "Content-Type: application/json" -d '{"banId":""}' "https://playroom.date/api/bans"

I understand this request can change or delete application data.

Sample Response

Sample Response Body

{
  "success": true,
  "data": {
    "ban": {
      "id": "ban_id",
      "providerIds": {
        "discordId": "123456789012345678",
        "fluxerId": null
      },
      "reason": "Rule violation",
      "status": {
        "active": true,
        "expired": false,
        "temporary": false,
        "public": true,
        "publicAfterExpiry": false
      }
    }
  },
  "error": null
}

Legacy-compatible delete route that accepts banId as a query parameter. Prefer DELETE /api/bans/{id} for new integrations.

Authentication

API key or admin session + CSRF.

Modes: logged-in user, API key

API key: bans:write

Permissions or Scopes

bans:write

Request Headers

Header	Value	Description
Authorization	Bearer prapi_your_key	API-key authentication.
x-api-key	prapi_your_key	Alternative API-key header.

Parameters

Name	In	Required	Description
banId	query	Yes	Ban ID to remove.

Validation

Validated by the server route before side effects. Invalid requests return 400 with an error message.

Errors

400 Missing banId.

401 Missing, invalid, or expired API key.

403 Missing bans:write or linked administrator lacks delete permission.

Rate Limits

No route-specific rate limit is documented. Global abuse protection and upstream proxy limits may still apply.

Examples and Try It

Request examples, sample output, and the live tester below apply only to this endpoint.

cURL

curl -X DELETE -H "Authorization: Bearer prapi_your_key" "https://playroom.date/api/bans?banId=ban_id"

JavaScript / TypeScript

const response = await fetch('https://playroom.date/api/bans?banId=ban_id', {
  method: 'DELETE',
  headers: {
    "Authorization": "Bearer prapi_your_key"
  },
});
const data = await response.json();

Python

import requests

headers = {"Authorization": "Bearer prapi_your_key"}
response = requests.delete('https://playroom.date/api/bans?banId=ban_id', headers=headers)
print(response.json())

Example Output

{
  "success": true,
  "data": {
    "deleted": true,
    "banId": "ban_id"
  },
  "error": null
}

Try It

Checking sign-in state...

Auth: No authentication

Ban Id * (query)Ban ID to remove.

Request

DELETE /api/bans

curl Equivalent

curl -X DELETE "https://playroom.date/api/bans"

I understand this request can change or delete application data.

Sample Response

Sample Response Body

{
  "success": true,
  "data": {
    "deleted": true,
    "banId": "ban_id"
  },
  "error": null
}

Revokes/removes a ban. API keys must include bans:write and be linked to an administrator with delete permission.

Authentication

API key or admin session + CSRF.

Modes: logged-in user, API key

API key: bans:write

Permissions or Scopes

bans:write

Request Headers

Header	Value	Description
Authorization	Bearer prapi_your_key	API-key authentication.
x-api-key	prapi_your_key	Alternative API-key header.

Parameters

Name	In	Required	Description
id	path	Yes	Ban ID.

Validation

Validated by the server route before side effects. Invalid requests return 400 with an error message.

Errors

401 Missing, invalid, or expired API key.

403 Missing bans:write or linked administrator lacks delete permission.

404 Ban not found.

Rate Limits

No route-specific rate limit is documented. Global abuse protection and upstream proxy limits may still apply.

Examples and Try It

Request examples, sample output, and the live tester below apply only to this endpoint.

cURL

curl -X DELETE -H "Authorization: Bearer prapi_your_key" "https://playroom.date/api/bans/resource_id"

JavaScript / TypeScript

const response = await fetch('https://playroom.date/api/bans/resource_id', {
  method: 'DELETE',
  headers: {
    "Authorization": "Bearer prapi_your_key"
  },
});
const data = await response.json();

Python

import requests

headers = {"Authorization": "Bearer prapi_your_key"}
response = requests.delete('https://playroom.date/api/bans/resource_id', headers=headers)
print(response.json())

Example Output

{
  "success": true,
  "data": {
    "deleted": true,
    "banId": "ban_id"
  },
  "error": null
}

Try It

Checking sign-in state...

Auth: No authentication

Id * (path)Ban ID.

Request

DELETE /api/bans/

curl Equivalent

curl -X DELETE "https://playroom.date/api/bans/"

I understand this request can change or delete application data.

Sample Response

Sample Response Body

{
  "success": true,
  "data": {
    "deleted": true,
    "banId": "ban_id"
  },
  "error": null
}