Propose deleting groups

[Admin Only] Creates a proposal to delete groups from the organization. Only admin API members can make requests to this endpoint.

POST /groups/proposals/delete

cURL

cURL

curl --request POST \
  --url https://api.onchainden.com/api/v1/groups/proposals/delete \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency-Key: <x-idempotency-key>' \
  --data '
{
  "items": [
    {
      "id": "grp_456"
    }
  ]
}
'

200

Example

{
  "data": {
    "id": "prop_grp_delete_123",
    "resourceType": "groups",
    "action": "delete",
    "signatureStatus": "approvalReady",
    "executionStatus": "completed",
    "threshold": 2,
    "approvals": [],
    "rejections": [],
    "createdAt": "2026-01-18T00:00:00.000Z",
    "expiresAt": "2026-01-25T00:00:00.000Z",
    "data": {
      "items": [
        {
          "id": "grp_456",
          "name": "Finance Team",
          "members": [],
          "createdAt": "2026-01-01T00:00:00.000Z",
          "updatedAt": "2026-01-02T00:00:00.000Z"
        }
      ]
    },
    "result": {
      "resolution": "approved",
      "resources": [
        {
          "type": "group",
          "id": "grp_456"
        }
      ]
    }
  }
}

Authorizations

Authorization · string · header · required

API key authentication. Include your API key in the Authorization header.

Headers

X-Idempotency-Key · string<uuid> · required

Idempotency key for safely retrying mutation requests.

Body

application/json

items · object[] · required

List of groups to delete

Show child attributes

Response

200

application/json

Group deletion proposal created

data · object · required

Show child attributes

Example:

{
  "id": "prop_grp_delete_123",
  "resourceType": "groups",
  "action": "delete",
  "signatureStatus": "approvalReady",
  "executionStatus": "completed",
  "threshold": 2,
  "approvals": [],
  "rejections": [],
  "createdAt": "2026-01-18T00:00:00.000Z",
  "expiresAt": "2026-01-25T00:00:00.000Z",
  "data": {
    "items": [
      {
        "id": "grp_456",
        "name": "Finance Team",
        "members": [],
        "createdAt": "2026-01-01T00:00:00.000Z",
        "updatedAt": "2026-01-02T00:00:00.000Z"
      }
    ]
  },
  "result": {
    "resolution": "approved",
    "resources": [{ "type": "group", "id": "grp_456" }]
  }
}