POST/v1/definitions/{key}/groups/rows/remove

Take records out of their groups

Takes the records named in ids out of EVERY group on this page in one transaction — 'in no group' said once, instead of reading the group list and calling remove per group. A record in three groups leaves all three and files one timeline line per membership actually ended; a record in no group at all is a no-op. At most 100 ids. It names no group, which is why this path has no groupId.

Access class: def:read.

Send request

Use the documented inputs to call this endpoint directly.

API serverbase URL

Bearer tokensessionoptional

Stored only in this browser for the session security scheme and reused on every API page in this group.

Parameters

Values are applied to the request and the example on the right.

keypath · stringrequired

Request body

application/jsonrequired

bodyoptional

paramsoptional

queryobjectoptional

Responses

201application/json

the action's answer

{
  "data": {
    "changed": 1,
    "failed": 1,
    "requested": 1,
    "results": [
      {
        "changed": "string",
        "error": "string",
        "ok": "string",
        "rowId": ""
      }
    ],
    "succeeded": 1
  }
}

dataoptional

defaultapplication/json

a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.

{
  "error": "string"
}

errorstringrequired