Add new members to the specified conversation.
post
/social/api/v1/conversations/{conversationID}/members
Request
Supported Media Types
- application/json
Path Parameters
-
conversationID: integer(int64)
The conversation ID. The object's unique identifier from a long integer representation.
The request body defines the details of the request.
Root Schema : XV1ConversationMemberCreateInfo
Type:
object
V1 Conversation Direct Member Change Information.
Show Source
-
groupOriginType(optional):
object XV1GroupOriginType
-
isGroup(optional):
boolean
True if the member is a group.
-
isHidden(optional):
boolean
The member should be hidden.
-
isLocked(optional):
boolean
The member should be locked.
-
member(optional):
string
The member name. Required.
-
role(optional):
object XV1ConversationRole
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 : XV1ConversationRole
Type:
Show Source
object
-
field(optional):
string
Allowed Values:
[ "ADMIN", "BYPASS", "CONTRIBUTOR", "DISCOVERER", "GROUP_MANAGER", "GROUP_MEMBER", "HOST", "MANAGER", "MEMBER", "MODERATOR", "NONE", "VIEWER" ]
V1 Conversation Roles.Conversation roles are used to define grantable and nongrantable access to conversations.
Response
Supported Media Types
- application/json
200 Response
Successful operation.
Root Schema : XV1ConversationMemberInfo
Type:
object
V1 Conversation Direct Member Information DTO.
Show Source
-
altitude(optional):
number(double)
The object's altitude.
-
collectionURL(optional):
string(url)
A URL to this object's containing collection.
-
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.
-
displayName(optional):
string
The display name of this object.
-
id(optional):
An object's unique identifier from a long integer representation.
-
isDirect(optional):
boolean
The member's direct status.
-
isHidden(optional):
boolean
The member's hidden status.
-
isHierarchical(optional):
boolean
The member's hierarchical status.
-
isLocked(optional):
boolean
The member's locked status.
-
isRemoved(optional):
boolean
True if this message has been removed.
-
latitude(optional):
number(double)
The object's latitude.
-
longitude(optional):
number(double)
The object's longitude.
-
membersURL(optional):
string(url)
A URL to the collection of members.
-
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.
-
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.
-
role(optional):
object XV1ConversationRole
-
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.
Nested Schema : XV1ConversationRole
Type:
Show Source
object
-
field(optional):
string
Allowed Values:
[ "ADMIN", "BYPASS", "CONTRIBUTOR", "DISCOVERER", "GROUP_MANAGER", "GROUP_MEMBER", "HOST", "MANAGER", "MEMBER", "MODERATOR", "NONE", "VIEWER" ]
V1 Conversation Roles.Conversation roles are used to define grantable and nongrantable access to conversations.
404 Response
Failed operation. GroupOriginType does not match with the group.
Root 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.