BTbtcpayserver
Groups

Add children to a group

Changed on

Adds one or more child tracked sources (derivation schemes or other groups) to the specified group.

post/v1/groups/{groupId}/children

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 added to 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 AddGroupChildren was added

    • info

      the response property became required for the status

    • info

      the response property became required for the status

  • cfaf4efd4ea8Revision changes
    • breaking

      the response's property type changed from integer to string for status

    • breaking

      removed the required property from the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status