Create a new group.
post
/social/api/v1/groups
Request
Supported Media Types
- application/json
The request body defines the details of the request.
Root Schema : XV1GroupCreateInfo
Type:
object
V1 Group Create Information.
Show Source
-
externalID:
string
The Group external ID. Optional.
-
groupType:
object XV1GroupType
-
name:
string
Group name. Required.
Nested Schema : XV1GroupType
Type:
Show Source
object
-
field:
string
Allowed Values:
[ "PRIVATE_CLOSED", "PUBLIC_CLOSED", "PUBLIC_OPEN" ]
V1 group types.
Response
Supported Media Types
- application/json
200 Response
Successful operation.
V1 Group Information DTO.
Root Schema : XV1GroupInfo
Type:
object
V1 Group Information DTO.
Show Source
-
addressBuilding:
string
The Group's address.
-
addressCity:
string
The Group's address.
-
addressCountry:
string
The Group's address.
-
addressLine1:
string
The Group's address.
-
addressLine2:
string
The Group's address.
-
addressOffice:
string
The Group's address.
-
addressState:
string
The Group's address.
-
addressZipCode:
string
The Group's address ZIP Code.
-
altitude:
number(double)
The object's altitude.
-
biography:
string
The Group's biography.
-
collectionURL:
string(url)
A URL to this object's containing collection.
-
company:
string
The Group's company.
-
conversationURL:
string(url)
A URL to this object's containing conversation.
-
createdByID:
An object's unique identifier from a long integer representation.
-
createdByURL:
string(url)
A URL to the user that created this object.
-
createdByUserDisplayName:
string
The display name of the user that created this object.
-
createdByUserName:
string
The name of the user that created this object.
-
createdDate:
string(date)
The date this object was created.
-
createdDateInISO8601Format:
string
The date this object was created, in ISO 8601 format.
-
description:
string
The Group description.
-
displayName:
string
The display name of this object.
-
eMailAddress:
string
The Group's e-mail address.
-
expertise:
string
The Group's expertise.
-
externalID:
string
Group's external ID.
-
fullName:
string
The Group full name.
-
groupID:
string
Group's ID.
-
groupType:
object XV1GroupType
-
id:
An object's unique identifier from a long integer representation.
-
interests:
string
The Group's interests.
-
isDeleted:
boolean
True if this Group is deleted.
-
isEditable:
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 these fields.
-
isInternal:
boolean
True if the Group is internal, False if the Group is external.
-
isManageable:
boolean
True if the current User has permissions to edit (manage) this Group.
-
isRemoved:
boolean
True if this message has been removed.
-
latitude:
number(double)
The object's latitude.
-
libraryURL:
string(url)
A URL specifying this Group's library.
-
link:
string
A URL if any that the Group shows on their Wall or profile as their Link.
-
longitude:
number(double)
The object's longitude.
-
membershipURL:
string(url)
A URL to the Membership of this Group.
-
membersURL:
string(url)
A URL to the Members of this Group.
-
modifiedByID:
An object's unique identifier from a long integer representation.
-
modifiedByURL:
string(url)
A URL to the user that last modified this object.
-
modifiedByUserDisplayName:
string
The display name of the user that last modified this object.
-
modifiedByUserName:
string
The name of the user that last modified this object.
-
modifiedDate:
string(date)
The date this object was last modified.
-
modifiedDateInISO8601Format:
string
The date this object was last modified, in ISO 8601 format.
-
name:
string
The name of this object.
-
objectType:
string
The type of this object.
-
organization:
string
The Group's organization.
-
originalPictureURL:
string(url)
The original picture URL.
-
profilePictureURL:
string(url)
The profile picture URL (150 px by 150 px).
-
removedByID:
An object's unique identifier from a long integer representation.
-
removedByURL:
string(url)
A URL to the user that last removed this object.
-
removedByUserDisplayName:
string
The display name of the user that last removed this object.
-
removedByUserName:
string
The name of the user that last removed this object.
-
removedDate:
string(date)
The date this object was removed.
-
removedDateInISO8601Format:
string
The date this object was removed, in ISO 8601 format.
-
scaledPictureURL:
string(url)
The scaled picture URL (44 px by 44 px).
-
socialObjectURL:
string(url)
A URL to this object's containing collaboration object.
-
url:
string(url)
A URL to this object.
-
wallURL:
string(url)
A URL specifying this Group's wall.
Nested Schema : XV1GroupType
Type:
Show Source
object
-
field:
string
Allowed Values:
[ "PRIVATE_CLOSED", "PUBLIC_CLOSED", "PUBLIC_OPEN" ]
V1 group types.