Update the specified group.
put
/social/api/v1/groups/{groupID}
For IDCS groups, only DisableNotifications and DisableSharing attributes can be modified.
Request
Supported Media Types
- application/json
Path Parameters
-
groupID: integer(int64)
The group ID. The object's unique identifier from a long integer representation.
The request body defines the details of the request.
Root Schema : XV1GroupUpdateInfo
Type:
object
V1 Group Update Information.
Show Source
-
profileUpdater(optional):
object XGroupProfileUpdater
Updater for group profiles.
-
updater(optional):
object XGroupUpdater
Updater for groups.
Nested Schema : XGroupProfileUpdater
Type:
object
Updater for group profiles.
Show Source
-
AddressBuilding(optional):
string
Optional. String for the group's address building.
-
AddressCity(optional):
string
Optional. String for the group's address city.
-
AddressCountry(optional):
string
Optional. String for the group's address country.
-
AddressLine1(optional):
string
Optional. String for the group's address line 1.
-
AddressLine2(optional):
string
Optional. String for the group's address line 2.
-
AddressOffice(optional):
string
Optional. String for the group's address office.
-
AddressState(optional):
string
Optional. String for the group's address state.
-
AddressZipCode(optional):
string
Optional. String for the group's address ZIP Code.
-
Altitude(optional):
string
Optional. Double for the altitude.
-
Biography(optional):
string
Optional. String for the group's biography.
-
Company(optional):
string
Optional. String for the group's company.
-
CustomFields(optional):
string
Optional. Collection of all custom fields.
-
Description(optional):
string
Optional. String for the group's description.
-
EMailAddress(optional):
string
Optional. The group's email address.
-
Expertise(optional):
string
Optional. String for the group's expertise.
-
fMap(optional):
string
The contained Map of Strings to Values.
-
FullName(optional):
string
Optional. The group's full name (for example, 'John's Reports'). This can be used to generate a DisplayName value.
-
Interests(optional):
string
Optional. String for the group's interests.
-
Latitude(optional):
string
Optional. Double for the latitude.
-
Link(optional):
string
Optional. Map of all links with name (string) to link (string).
-
Links(optional):
string
Optional. Collection of XGroupLinkInfo.
-
Location(optional):
string
Optional. String for the group's location.
-
Locations(optional):
string
Optional. Collection of XGroupLocationInfo.
-
Longitude(optional):
string
Optional. Double for the longitude.
-
Manager(optional):
string
Optional. The group's manager.
-
Organization(optional):
string
Optional. String for the group's organization.
-
PhoneNumber(optional):
string
Optional. The phone number for this group. Use this or PHONE_NUMBERS but not both. Replaces all phone numbers. This field sets all phone numbers to one number. PHONE_NUMBERS is preferred over this.
-
PhoneNumbers(optional):
string
Optional. Map of name (string) to number (string) with all phone numbers. Use this or PHONE_NUMBER but not both. Replaces all phone numbers. This is the correct field to use to alter all phone numbers.
-
Status(optional):
string
Optional. String for the group's status.
-
Tags(optional):
string
Optional. Collection containing (string) tags to add.
Nested Schema : XGroupUpdater
Type:
object
Updater for groups.
Show Source
-
Deleted(optional):
string
Optional. String for the deleted status.
-
DisableNotifications(optional):
string
Optional. String for the disableNotifications flag. Note : This attribute can be modified by Group Owner/Managers as well as Admins.
-
DisableSharing(optional):
string
Optional. String for disableSharing flag. NOTE : This attribute can be only modified by Admins.
-
ExternalID(optional):
string
Optional. String for the group external ID.
-
fMap(optional):
string
The contained Map of Strings to Values.
-
GroupType(optional):
string
Optional. String for the group type.
-
IsSystemGroup(optional):
string
Optional. String for system group flag. Note : System groups can only be managed by OCM internal components.
-
Name(optional):
string
Optional. String for the name.
-
Owner(optional):
string
Optional. String for group Owner Name. New owner should be an existing member of the group. If the old owner status is Disabled/Deleted the owner will be removed from the group membership else if status is Active, they will remain Manager of the group. NOTE : This attribute can be only modified by Admins.
Response
Supported Media Types
- application/json
200 Response
Successful operation.
Root Schema : XV1GroupInfo
Type:
object
V1 Group Information DTO.
Show Source
-
addressBuilding(optional):
string
The group's address building.
-
addressCity(optional):
string
The group's address city.
-
addressCountry(optional):
string
The group's address country.
-
addressLine1(optional):
string
The group's address line 1.
-
addressLine2(optional):
string
The group's address line 2.
-
addressOffice(optional):
string
The group's address office.
-
addressState(optional):
string
The group's address state.
-
addressZipCode(optional):
string
The group's address ZIP Code.
-
altitude(optional):
number(double)
The object's altitude.
-
biography(optional):
string
The group's biography.
-
collectionURL(optional):
string(url)
A URL to this object's containing collection.
-
company(optional):
string
The group's company.
-
conversationURL(optional):
string(url)
A URL to this object's containing conversation.
-
createdByID(optional):
An object's unique identifier from a long integer representation.
-
createdByURL(optional):
string(url)
A URL to the user that created this object.
-
createdByUserDisplayName(optional):
string
The display name of the user that created this object.
-
createdByUserName(optional):
string
The name of the user that created this object.
-
createdDate(optional):
string(date)
The date this object was created.
-
createdDateInISO8601Format(optional):
string
The date this object was created, in ISO 8601 format.
-
description(optional):
string
The group description.
-
displayName(optional):
string
The display name of this object.
-
eMailAddress(optional):
string
The group's e-mail address.
-
expertise(optional):
string
The group's expertise.
-
externalID(optional):
string
Group's external ID.
-
fullName(optional):
string
The group's full name.
-
groupID(optional):
string
Group's ID.
-
groupOriginType(optional):
object XV1GroupOriginType
-
groupOwnerID(optional):
string
Group Owner's ID.
-
groupType(optional):
object XV1GroupType
-
id(optional):
An object's unique identifier from a long integer representation.
-
interests(optional):
string
The group's interests.
-
isDeleted(optional):
boolean
True if this group is deleted.
-
isEditable(optional):
boolean
True if this group's realm allows attributes such as name, membership and enabled status to be edited. The group's manageable status specifies whether the current user can edit any of these fields.
-
isInternal(optional):
boolean
True if the group is internal, False if the group is external.
-
isManageable(optional):
boolean
True if the current user has permissions to edit (manage) this group.
-
isNotificationDisabled(optional):
boolean
Group's Notification flag.
-
isRemoved(optional):
boolean
True if this message has been removed.
-
isSharingDisabled(optional):
boolean
Group's Sharing flag.
-
isSystemGroup(optional):
boolean
Flag indicating if group is a system group.
-
latitude(optional):
number(double)
The object's latitude.
-
libraryURL(optional):
string(url)
A URL specifying this group's library.
-
link(optional):
string
A URL if any that the group shows on their wall or profile as their link.
-
longitude(optional):
number(double)
The object's longitude.
-
membershipURL(optional):
string(url)
A URL to the membership of this group.
-
membersURL(optional):
string(url)
A URL to the members of this group.
-
modifiedByID(optional):
An object's unique identifier from a long integer representation.
-
modifiedByURL(optional):
string(url)
A URL to the user that last modified this object.
-
modifiedByUserDisplayName(optional):
string
The display name of the user that last modified this object.
-
modifiedByUserName(optional):
string
The name of the user that last modified this object.
-
modifiedDate(optional):
string(date)
The date this object was last modified.
-
modifiedDateInISO8601Format(optional):
string
The date this object was last modified, in ISO 8601 format.
-
name(optional):
string
The name of this object.
-
objectType(optional):
string
The type of this object.
-
organization(optional):
string
The group's organization.
-
originalPictureURL(optional):
string(url)
The original picture URL.
-
profilePictureURL(optional):
string(url)
The profile picture URL (150 px by 150 px).
-
removedByID(optional):
An object's unique identifier from a long integer representation.
-
removedByURL(optional):
string(url)
A URL to the user that last removed this object.
-
removedByUserDisplayName(optional):
string
The display name of the user that last removed this object.
-
removedByUserName(optional):
string
The name of the user that last removed this object.
-
removedDate(optional):
string(date)
The date this object was removed.
-
removedDateInISO8601Format(optional):
string
The date this object was removed, in ISO 8601 format.
-
scaledPictureURL(optional):
string(url)
The scaled picture URL (44 px by 44 px).
-
socialObjectURL(optional):
string(url)
A URL to this object's containing collaboration object.
-
url(optional):
string(url)
A URL to this object.
-
wallURL(optional):
string(url)
A URL specifying this group's wall.
Nested Schema : XV1GroupOriginType
Type:
Show Source
object
-
field(optional):
string
Allowed Values:
[ "CEC", "IDP" ]
Enum to list the source of origin from where the Groups are originally created.
Nested Schema : XV1GroupType
Type:
Show Source
object
-
field(optional):
string
Allowed Values:
[ "PRIVATE_CLOSED", "PUBLIC_CLOSED", "PUBLIC_OPEN" ]
V1 group types.