Add members lists
POST /api/v1/lists/{listId}/members: request fields and declared response contract.
POST/api/v1/lists/{listId}/members
| Permission | list.manage |
|---|---|
| Workspace scope | required |
| Scope target | resource-set |
Parameters
| Field | Type | Required | Nullable | Default |
|---|---|---|---|---|
| listId | string | required | non-null | — |
Query parameters: none.
Request body
| Field | Type | Required | Nullable | Default |
|---|---|---|---|---|
| memberRefs | array | required | non-null | — |
Response
200
| Field | Type | Required | Nullable | Default |
|---|---|---|---|---|
| data | object | required | non-null | — |
| data.added | number | required | non-null | — |
| data.duplicate | number | required | non-null | — |
| data.invalid | array | optional | non-null | — |
Declared failures
| LIST_NOT_FOUND | 404 — 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.
POST /api/v1/lists/{listId}/members HTTP/1.1
Authorization: Bearer <token>
x-merulan-workspace-id: <workspace-id>
Content-Type: application/json
{
"memberRefs": []
}