BTbtcpayserver
Groups

Remove children from a group

Changed on

Removes one or more child tracked sources from the specified group.

post/v1/groups/{groupId}/children/delete

Request

Path parameters

groupIdstring required

The unique identifier for the group.

Request body

trackedSourcestring required

The tracked source identifier, which can be a group or a derivation scheme.

cryptoCodestring

The cryptocurrency code associated with the tracked source (if applicable).

Example request

[
  {
    "trackedSource": "DERIVATIONSCHEME:tpubD6NzVbkrYhZ4W...",
    "cryptoCode": "BTC"
  }
]

Response

Children removed from group successfully.

trackedSourcestring required

The tracked source identifier for the group, formatted as 'GROUP:{groupId}'. Used to reference the group within NBXplorer.

groupIdstring required

The unique identifier of the group.

Example response

{
  "trackedSource": "GROUP:6N23bHztah546P6xQT",
  "groupId": "6N23bHztah546P6xQT",
  "children": [
    {
      "trackedSource": "DERIVATIONSCHEME:tpubDC6xFicnheK85vUNGjegu4HuJGg8nPi...",
      "cryptoCode": "BTC"
    }
  ]
}

Changes

  • 52231f42c765Revision changes
    • info

      api operation id DeleteGroupChildrenLegacy was added

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

  • f08b9069e804Revision changes
    • info

      endpoint added