---
title: "Join Member to Group"
method: POST
path: "/v2/userGroup2/join?id={id/externalId/primaryUserId}"
---

# Join Member to Group

`POST /v2/userGroup2/join?id={id/externalId/primaryUserId}`

This API allows you to add a member to a group.

## Path parameters

- `id` integer, required
- `externalId` string, required
- `primaryUserId` integer, required

## Request body

- object
  - `userId` integer, required — Unique ID of the customer to be added to the group.
  - `primaryMember` boolean — Pass false for secondary members.
  - `permissions` string[] — The permissions/restrictions for the customer. Valus: block_points_redemption - This disables redeeming points.

## Response `200`

200

- object
  - `response` object[]
    - `entityId` object
      - `userId` integer
      - `groupId` integer
      - `permissions` string[]
      - `defaultGroup` boolean
      - `active` boolean
      - `primaryMember` boolean
    - `result` object
      - `userId` integer
      - `groupId` integer
      - `permissions` string[]
      - `defaultGroup` boolean
      - `active` boolean
      - `primaryMember` boolean
    - `warnings` unknown[]
      - unknown
  - `totalCount` integer
  - `failureCount` integer

## Other responses

- `400` — 400

---

[API](https://skmtc.net/capillarytech/apis/sample-api.md) · [All operations](https://skmtc.net/capillarytech/apis/sample-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/capillarytech/sample-api/revisions/de241f2ed9b3/schema)