Update a group

Update a group

Update an existing group

PUT/profile-manager/v1/groups/{groupId}

Path parameters

groupId*string

Group id

Example: "60af77fd294165466ccdf510"

Header parameters

Body

application/json

JSON object containing Group info

type*string

Group type identifier

Example: "SDL"

ownerType*Owner (enum)

Owner type. Ony TENANT supported now

Example: "TENANT"

PLATFORMTENANTUSER

ownerId*integer (int64)

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

Example: 100

name*string

Group's name

Example: "Test Group"

subTypeenum

The type of the company new groupType

Example: "COMMUNITY"

COMMUNITYCHANNEL

referrerstring

Symphony, referring company name, referring channel partner name

membersarray of Member (object)

profileBaseProfile (object)

The group's profile

visibilityRestrictionGroupVisibilityRestriction (object)

Group visibility restriction.

implicitConnectionGroupImplicitConnection (object)

Group implicit connections.

interactionTransferGroupInteractionTransfer (object)

Group interaction transfer.

idstring

Group's unique identifier

Example: "60af77fd294165466ccdf510"

statusStatus (enum)

Status flag to distinguish between active and deleted objects

Example: "ACTIVE"

ACTIVEDELETED

eTagstring

Example: "e3a52e72-0854-4401-8c24-e0b17c0ca304"

Response

200400401403404412429452

Successful response. Returns the group just updated

Headers

Body

application/json

type*string

Group type identifier

Example: "SDL"

ownerType*Owner (enum)

Owner type. Ony TENANT supported now

Example: "TENANT"

PLATFORMTENANTUSER

ownerId*integer (int64)

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

Example: 100

name*string

Group's name

Example: "Test Group"

idstring

Group's unique identifier

createdDatestring (date-time)

createdBystring

updatedDatestring (date-time)

updatedBystring

statusStatus (enum)

Status flag to distinguish between active and deleted objects

Example: "ACTIVE"

ACTIVEDELETED

eTagstring

Example: "e3a52e72-0854-4401-8c24-e0b17c0ca304"

membersarray of ReadMember (all of)

profileProfile (all of)

visibilityRestrictionGroupVisibilityRestriction (object)

Group visibility restriction.

implicitConnectionGroupImplicitConnection (object)

Group implicit connections.

interactionTransferGroupInteractionTransfer (object)

Group interaction transfer.

Request

JavaScriptCurlPython

const response = await fetch('/profile-manager/v1/groups/{groupId}', {
    method: 'PUT',
    headers: {
      "X-Symphony-Host": "localhost.symphony.com",
      "If-Match": "e3a52e72-0854-4401-8c24-e0b17c0ca304",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "type": "SDL",
      "ownerType": "TENANT",
      "ownerId": 100,
      "name": "Test Group"
    }),
});
const data = await response.json();

Response

200400401403404412429452

{
  "type": "SDL",
  "ownerType": "TENANT",
  "ownerId": 100,
  "name": "Test Group",
  "id": "text",
  "createdDate": "2024-11-21T06:29:42.310Z",
  "createdBy": "text",
  "updatedDate": "2024-11-21T06:29:42.310Z",
  "updatedBy": "text",
  "status": "ACTIVE",
  "eTag": "e3a52e72-0854-4401-8c24-e0b17c0ca304",
  "members": [
    {
      "memberTenant": 100,
      "memberId": 12345678900000,
      "addedDate": "2024-11-21T06:29:42.310Z"
    }
  ],
  "profile": {
    "displayName": "Test Group",
    "companyName": "Acme Corporation",
    "email": "[e-mail]",
    "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
    ]
  }
}