Update a group

Update a group

Update an existing group

put

/v1/groups/{groupId}

Authorizations

Path parameters

groupIdstringrequired

Group id

Example: 60af77fd294165466ccdf510

Header parameters

X-Symphony-Hoststring · min: 1required

headers to indentify the originator

Example: localhost.symphony.com

If-Matchstringrequired

ETag of group to be updated

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

Body

typestring · min: 1required

Group type identifier

Example: SDL

ownerTypestring · enumrequired

Owner type. Ony TENANT supported now

Example: TENANT

Options: PLATFORM, TENANT, USER

ownerIdinteger · int64required

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

Example: 100

namestring · min: 1required

Group's name

Example: Test Group

referrerstring

Symphony, referring company name, referring channel partner name

profileobject

The group's profile

visibilityRestrictionobject

Group visibility restriction.

implicitConnectionobject

Group implicit connections.

interactionTransferobject

Group interaction transfer.

subTypestring · enum

The type of the company new groupType

Example: COMMUNITY

Options: COMMUNITY, CHANNEL

membersobject[]

idstring · min: 1

Group's unique identifier

Example: 60af77fd294165466ccdf510

statusstring · enum

Status flag to distinguish between active and deleted objects

Example: ACTIVE

Options: ACTIVE, DELETED

eTagstring · min: 1

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

Responses

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/profile-manager/v1/groups/{groupId}' \
  --header 'Authorization: Bearer JWT' \
  --header 'X-Symphony-Host: localhost.symphony.com' \
  --header 'If-Match: e3a52e72-0854-4401-8c24-e0b17c0ca304' \
  --header 'Content-Type: application/json' \
  --data '{"subType":"COMMUNITY","members":[],"id":"60af77fd294165466ccdf510","status":"ACTIVE","eTag":"e3a52e72-0854-4401-8c24-e0b17c0ca304"}'

200

400

401

403

404

412

429

452

200

{
  "type": "SDL",
  "ownerType": "TENANT",
  "ownerId": 100,
  "name": "Test Group",
  "id": "text",
  "createdDate": "2025-02-21T18:15:56.080Z",
  "createdBy": "text",
  "updatedDate": "2025-02-21T18:15:56.080Z",
  "updatedBy": "text",
  "status": "ACTIVE",
  "eTag": "e3a52e72-0854-4401-8c24-e0b17c0ca304",
  "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": []
  },
  "visibilityRestriction": {
    "restrictedTenantsList": [
      100
    ],
    "restrictedUsersList": [
      12345678900000
    ]
  },
  "implicitConnection": {
    "connectedTenantsList": [
      100
    ],
    "connectedUsersList": [
      12345678900000
    ]
  },
  "interactionTransfer": {
    "restrictedTenantsList": [
      100
    ],
    "restrictedUsersList": [
      12345678900000
    ]
  },
  "members": [
    {
      "memberTenant": 100,
      "memberId": 12345678900000
    },
    {
      "addedDate": "2025-02-21T18:15:56.080Z"
    }
  ]
}

Successful response. Returns the group just updated