Bulk-delete chat sessions

Starts an asynchronous job that soft-deletes up to 100 chat rooms. The Location resource is polled until completed or failed; a completed job may contain individual failed results, including not_found for a malformed target ID. If the job itself fails, the target it stopped on carries delete_failed and every target behind it carries not_attempted, which means it was left untouched and is safe to resubmit.

Starts an asynchronous job that soft-deletes up to 100 chat rooms. The Location resource is polled until `completed` or `failed`; a completed job may contain individual failed results, including `not_found` for a malformed target ID. If the job itself fails, the target it stopped on carries `delete_failed` and every target behind it carries `not_attempted`, which means it was left untouched and is safe to resubmit.

Authentication

X-API-Keystring

Enter your API key for programmatic access

AuthorizationBearer

Enter your JWT token (without the ‘Bearer ’ prefix)

Request

Bulk chat deletion request

idslist of stringsRequired

Unique target IDs in the order results must be returned.

Response headers

LocationstringOptional

Owner-scoped polling URL for the accepted bulk-deletion job.

Response

Bulk deletion accepted

dataobject

Errors

401

Unauthorized Error

403

Forbidden Error

422

Unprocessable Entity Error

503

Service Unavailable Error

$	curl -X POST https://platform.dev.band.ai/api/v1/me/chats/bulk-delete \
>	-H "X-API-Key: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"ids": [
>	"string"
>	]
>	}'

1	{
2	"data": {
3	"completed_at": "2024-01-15T09:30:00Z",
4	"failed": 1,
5	"force": true,
6	"id": "string",
7	"inserted_at": "2024-01-15T09:30:00Z",
8	"processed": 1,
9	"resource_type": "chat",
10	"results": [
11	{
12	"error": {
13	"code": "not_found",
14	"message": "string"
15	},
16	"id": "string",
17	"status": "pending"
18	}
19	],
20	"started_at": "2024-01-15T09:30:00Z",
21	"status": "queued",
22	"succeeded": 1,
23	"total": 1
24	}
25	}