Skip to content

Remove members lists

DELETE /api/v1/lists/{listId}/members: request fields and declared response contract.

DELETE/api/v1/lists/{listId}/members

Authorization
Permissionlist.manage
Workspace scoperequired
Scope targetresource-set

Parameters

Path parameters
FieldTypeRequiredNullableDefault
listIdstringrequirednon-null—
Query parameters
FieldTypeRequiredNullableDefault
memberRefsarrayrequirednon-null—

Response

200

Response fields
FieldTypeRequiredNullableDefault
dataobjectrequirednon-null—
data.removednumberrequirednon-null—

Declared failures

Declared failures
LIST_MEMBER_REFS_MIXED400 — not retryable
LIST_NOT_FOUND404 — not retryable

Readback

Read the result back with:

  • lists.get

Request example

Schematic only. Replace placeholders with real values and include all required nested fields.

DELETE /api/v1/lists/{listId}/members?memberRefs= HTTP/1.1
Authorization: Bearer <token>
x-merulan-workspace-id: <workspace-id>