Add a new user to an existing group

Add a new user to a an existing group

Add a new user to a an existing group

POST/profile-manager/v1/groups/{groupId}/member

Path parameters

groupId*string

Group id

Header parameters

Body

application/json

JSON object containing the user member information and the group on which he will be added to

memberMember (object)

A Group member.

Response

201400401403429452

Successful response. Returns the group with the new user as a member

Headers

Body

application/json

type*string

Group type identifier

ownerType*Owner (enum)

Owner type. Ony TENANT supported now

PLATFORMTENANTUSER

ownerId*integer (int64)

Owner id if the owner type is tenant (podId) or user (userId), otherwise null

name*string

Group's name

idstring

Group's unique identifier

createdDatestring (date-time)

createdBystring

updatedDatestring (date-time)

updatedBystring

statusStatus (enum)

Status flag to distinguish between active and deleted objects

ACTIVEDELETED

eTagstring

membersarray of ReadMember (all of)

profileProfile (all of)

visibilityRestrictionGroupVisibilityRestriction (object)

Group visibility restriction.

implicitConnectionGroupImplicitConnection (object)

Group implicit connections.

interactionTransferGroupInteractionTransfer (object)

Group interaction transfer.

Request

JavaScriptCurl

const response = await fetch('/profile-manager/v1/groups/{groupId}/member', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "type": "SDL",
  "ownerType": "TENANT",
  "ownerId": 100,
  "name": "Test Group",
  "id": "text",
  "createdDate": "2024-04-26T12:22:55.521Z",
  "createdBy": "text",
  "updatedDate": "2024-04-26T12:22:55.521Z",
  "updatedBy": "text",
  "status": "ACTIVE",
  "eTag": "e3a52e72-0854-4401-8c24-e0b17c0ca304",
  "members": [
    {
      "memberTenant": 100,
      "memberId": 12345678900000,
      "addedDate": "2024-04-26T12:22:55.521Z"
    }
  ],
  "profile": {
    "displayName": "Test Group",
    "companyName": "Acme Corporation",
    "email": "[email protected]",
    "mobile": "[phone]",
    "jobTitle": "text",
    "jobRole": "Director",
    "jobDepartment": "text",
    "jobDivision": "text",
    "jobPhone": "text",
    "jobCity": "text",
    "industryOfInterest": [
      "Services"
    ],
    "assetClassesOfInterest": [
      "Equities"
    ],
    "marketCoverage": [
      "EMEA"
    ],
    "responsibility": [
      "Escalation"
    ],
    "function": [
      "Collateral"
    ],
    "instrument": [
      "Equities"
    ],
    "id": "text",
    "avatars": [
      {
        "size": "text",
        "url": "text"
      }
    ]
  },
  "visibilityRestriction": {
    "restrictedTenantsList": [
      100
    ],
    "restrictedUsersList": [
      12345678900000
    ]
  },
  "implicitConnection": {
    "connectedTenantsList": [
      100
    ],
    "connectedUsersList": [
      12345678900000
    ]
  },
  "interactionTransfer": {
    "restrictedTenantsList": [
      100
    ],
    "restrictedUsersList": [
      12345678900000
    ]
  }
}