v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Join Member to Group

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

post/v2/userGroup2/join?id={id/externalId/primaryUserId}

Path parameters

idinteger required

Unique ID of the user group.

externalIdstring required

External ID of the user group.

primaryUserIdinteger required

User ID of the primary member of the group.

Request body

userIdinteger required

Unique ID of the customer to be added to the group.

primaryMemberboolean

Pass false for secondary members.

permissionsstring[]

The permissions/restrictions for the customer. Valus: block_points_redemption - This disables redeeming points.

Response

200

totalCountinteger

failureCountinteger

Example response

{
  "response": [
    {
      "entityId": {
        "userId": 416066472,
        "groupId": 2361,
        "permissions": [
          "block_points_redemption"
        ]
      },
      "result": {
        "userId": 416066472,
        "groupId": 2361,
        "permissions": [
          "block_points_redemption"
        ]
      }
    }
  ],
  "totalCount": 1
}