Sign in
Groups

Create or overwrite a group

Creates a new group with the specified groupId. If a group with the same groupId already exists, it will be overwritten.

post/v1/groups/{groupId}

Path parameters

groupIdstring required

The unique identifier for the group.

Request body

childrenstring[]

An array of tracked sources (derivation schemes or other groups) to be included in the group.

Response

Group created or overwritten 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

Changed in 4 of the 40 revisions of this API.35

  • cfaf4efd4ea823See the full diff
    • ▲

      the code response's property type/format changed from integer/ to string/ for status 400

      response-property-type-changed

    • ▲

      removed the required property error from the response with the 400 status

      response-required-property-removed

    • ○

      added the optional property httpCode to the response with the 400 status

      response-optional-property-added

    • ○

      added the optional property message to the response with the 400 status

      response-optional-property-added

    • ○

      added the optional property reason to the response with the 400 status

      response-optional-property-added

  • de4c3fa163841See the full diff
    • ○

      api operation id Create was added

      api-operation-id-added

  • 72a2dfa269761See the full diff
    • ○

      endpoint added

      endpoint-added

  • b5092f2045991See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 14 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog