Update the specified conversation.
put
/social/api/v1/conversations/{conversationID}
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 : XV1ConversationUpdateInfo
Type:
object
V1 Conversation Update Information.
Show Source
-
impersonateUser:
string
User to impersonate.
-
updater:
object XConversationUpdater
Updater for conversations.
Nested Schema : XConversationUpdater
Type:
object
Updater for conversations.
Show Source
-
ALTITUDE:
string
Double for the altitude.
-
DATE_FORMAT_LOCALE:
string
The date-format locale.
-
DISALLOW_GUESTS:
string
Boolean for disallow guests status.
-
EXTENDED_ACCESS_CONTROL:
string
Boolean for use extended access control status.
-
fMap:
string
The contained Map of Strings to Values.
-
LANGUAGE_LOCALE:
string
The spoken language locale.
-
LATITUDE:
string
Double for the latitude.
-
LATITUDE_MAX:
number(double)
Maximum possible latitude.
-
LATITUDE_MIN:
number(double)
Minimum possible latitude.
-
LONGITUDE:
string
Double for the longitude.
-
LONGITUDE_MAX:
number(double)
Maximum possible longitude.
-
LONGITUDE_MIN:
number(double)
Minimum possible longitude.
-
MEMBERS_LOCKED:
string
Boolean for members locked status.
-
OUTCOME:
string
Integer for the outcome. (0-100)
-
RETENTION_EXTENDED:
string
Boolean for whether this conversation uses the extended retention policy.
-
SHORT_NAME:
string
String for the short name.
-
TIME_ZONE:
string
The time zone.
Response
Supported Media Types
- application/json
200 Response
Successful operation.
V1 Conversation Information DTO.
Root Schema : XV1ConversationInfo
Type:
object
V1 Conversation Information DTO.
Show Source
-
allMembershipsURL:
string(url)
A URL to the hierarchical memberships of this conversation.
-
altitude:
number(double)
The object's altitude.
-
archiveURL:
string(url)
A URL to the archive of this conversation.
-
collectionURL:
string(url)
A URL to this object's containing collection.
-
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.
-
dateFormatLocale:
string(locale)
The locale of the appropriate date format for this conversation.
-
discoverableID:
An object's unique identifier from a long integer representation.
-
displayName:
string
The display name of this object.
-
externalID:
string
The primary external ID of this conversation.
-
folderID:
An object's unique identifier from a long integer representation.
-
folderURL:
string(url)
A URL to the root folder of this conversation.
-
gadgetsURL:
string(url)
A URL to the gadgets of this conversation.
-
hasMembersLocked:
boolean
True if the membership of this conversation is locked.
-
hierarchicalMembersInfo:
object XV1HierarchicalMembersInfo
V1 Hierarchical Members Information DTO.
-
id:
An object's unique identifier from a long integer representation.
-
isDisallowGuests:
boolean
True if this conversation does not allow guest users.
-
isDisallowOutsiders:
boolean
True if this conversation does not allow outsider users.
-
isDiscoverable:
boolean
True if this conversation is discoverable (public).
-
isExtendedAccessControl:
boolean
True if this conversation uses extended access control.
-
isMuted:
boolean
True if this conversation is muted for the current user.
-
isNew:
boolean
True if this conversation has not been entered by the current user.
-
isRemoved:
boolean
True if this message has been removed.
-
isScoped:
boolean
True if the membership of this conversation is scoped by another conversation.
-
isScoping:
boolean
True if this is a scoping conversation.
-
isScopingSame:
boolean
True if this conversation is scoped to have the same membership as another conversation.
-
languageLocale:
string(locale)
The language locale for this conversation.
-
latitude:
number(double)
The object's latitude.
-
likesURL:
string(url)
A URL to the likes of this conversation.
-
longitude:
number(double)
The object's longitude.
-
membershipsURL:
string(url)
A URL to the memberships of this conversation.
-
membersURL:
string(url)
A URL to the members of this conversation.
-
messagesURL:
string(url)
A URL to the messages in this conversation.
-
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.
-
nChats:
integer(int32)
The number of chats in this conversation. (total chats less deleted chats.)
-
nFollowups:
integer(int32)
The number of followups in the conversation.
-
nMarkableChats:
integer(int32)
The number of chats that could be marked read. (Total markable less deleted markable. Does not depend on the current user.)
-
nOutsiders:
integer(int32)
Count of the outside users.
-
nUnread:
integer(int32)
The number of chats that the current user can mark read.
-
objectType:
string
The type of this object.
-
originalPictureURL:
string(url)
The original picture URL.
-
profilePictureURL:
string(url)
The profile picture URL (150 px by 150 px).
-
propertiesURL:
string(url)
A URL to the properties of this conversation.
-
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.
-
role:
string
The current user's role in this conversation.
-
scaledPictureURL:
string(url)
The scaled picture URL (44 px by 44 px).
-
secondaryExternalIDs:
array secondaryExternalIDs
The secondary external IDs for this conversation.
-
securityContextID:
string
The ID of the service that dictates the security for this Conversation object.
-
socialObjectURL:
string(url)
A URL to this object's containing collaboration object.
-
starsURL:
string(url)
A URL to the stars of this conversation.
-
state:
object XV1ConversationState
-
timeZone:
string(timezone)
The time zone for this conversation.
-
url:
string(url)
A URL to this object.
-
userPropertiesURL:
string(url)
A URL to the user properties of this conversation.
-
wallPostControl:
object XV1WallPostControlEnum
Nested Schema : XV1HierarchicalMembersInfo
Type:
object
V1 Hierarchical Members Information DTO.
Show Source
-
createdFolderIDs:
object XV1FolderIDListInfo
List of folder IDs.
-
ignoredMembers:
object XV1IgnoredMemberListInfo
List of ignored members.
-
ignoredUsers:
object XV1IgnoredUserListInfo
List of ignored users.
-
operationType:
object XV1HierarchicalMembersOperationType
-
removedFolderIDs:
object XV1FolderIDListInfo
List of folder IDs.
Nested Schema : secondaryExternalIDs
Type:
array
The secondary external IDs for this conversation.
Show Source
-
[0]:
string
The secondary external IDs for this conversation.
Nested Schema : XV1ConversationState
Type:
Show Source
object
-
field:
string
Allowed Values:
[ "CLOSED_CHAINED", "CLOSED_DISABLED", "CLOSED_DROPPED", "CLOSED_RESOLVED", "OPEN_ACTIVE" ]
V1 Conversation States.
Nested Schema : XV1WallPostControlEnum
Type:
Show Source
object
-
field:
string
Allowed Values:
[ "ANYONE_CAN_POST", "OWNER_ONLY_POSTS", "OWNER_TOP_LEVEL" ]
V1 Wall Posting Control Enum.
Nested Schema : XV1FolderIDListInfo
Type:
object
List of folder IDs.
Show Source
-
hasMore:
boolean
If true, there are more items to be returned.
-
ids:
array ids
List of folder IDs.
-
nextURL:
string(url)
Next page URL for the list. Null if this is the last page.
-
previousURL:
string(url)
Previous page URL for the list. Null if this is the first page.
-
total:
integer(int32)
If specified, this is the total number of available items. Null if the total is unknown.
Nested Schema : XV1IgnoredMemberListInfo
Type:
object
List of ignored members.
Show Source
-
groups:
array groups
List of users.
-
hasMore:
boolean
If true, there are more items to be returned.
-
nextURL:
string(url)
Next page URL for the list. Null if this is the last page.
-
previousURL:
string(url)
Previous page URL for the list. Null if this is the first page.
-
total:
integer(int32)
If specified, this is the total number of available items. Null if the total is unknown.
-
users:
array users
List of users.
Nested Schema : XV1IgnoredUserListInfo
Type:
object
List of ignored users.
Show Source
-
hasMore:
boolean
If true, there are more items to be returned.
-
nextURL:
string(url)
Next page URL for the list. Null if this is the last page.
-
previousURL:
string(url)
Previous page URL for the list. Null if this is the first page.
-
total:
integer(int32)
If specified, this is the total number of available items. Null if the total is unknown.
-
users:
array users
List of users.
Nested Schema : XV1HierarchicalMembersOperationType
Type:
Show Source
object
-
field:
string
Allowed Values:
[ "ASSOCIATE_CONVERSATION", "CREATE_CONVERSATION", "MOVE_FILE", "MOVE_FOLDER", "MOVE_MEMBERS", "REMOVE_MEMBERS", "REMOVE_MEMBERS_OBJECT", "SHARE_FOLDER" ]
V1 Collaboration API Operation Types on Hierarchical Members.
Examples
The following example shows how to update the specified conversation by submitting a PUT request on the REST resource using cURL. For more information about cURL, see Use cURL.
curl -X PUT -c mycookies.jar -b mycookies.jar -H 'X-Waggle-RandomID:b97554e5a31e50a734899ee4f79218bd' -H 'Content-Type: application/json' https://socialnetwork06065-ustraveler15926.socialnetwork.dc1.c9dev1.example.com/osn/social/api/v1/conversations/22006 -d '{ "updater" : {"State":"OPEN_ACTIVE", "Altitude":"15"}}'
Example of Request Body
The following shows an example of the request document in JSON format.
{ "updater" : {"State":"OPEN_ACTIVE", "Altitude":"15"} }
Example of Response Body
The following shows an example of the response JSON document.
"jeff.pringle@example.com", "createdByUserDisplayName" : "jeff.pringle@example.com", "createdByURL" : "https://socialnetwork06065-ustraveler15926.socialnetwork.dc1.c9dev1.example.com/osn/social/api/v1/people/11001", "createdDate" : 1455325485929, "modifiedByID" : "11001", "modifiedByUserName" : "jeff.pringle@example.com", "modifiedByUserDisplayName" : "jeff.pringle@example.com", "modifiedByURL" : "https://socialnetwork06065-ustraveler15926.socialnetwork.dc1.c9dev1.example.com/osn/social/api/v1/people/11001", "modifiedDate" : 1455326386743, "isRemoved" : false, "url" : "https://socialnetwork06065-ustraveler15926.socialnetwork.dc1.c9dev1.example.com/osn/social/api/v1/conversations/22006", "externalID" : "ext00055", "secondaryExternalIDs" : ["ext00055"], "isScoping" : false, "isScopingSame" : false, "isScoped" : false, "state" : "OPEN_ACTIVE", "isDiscoverable" : false, "wallPostControl" : "ANYONE_CAN_POST", "hasMembersLocked" : false, "isDisallowGuests" : false, "isDisallowOutsiders" : false, "nOutsiders" : 0, "isExtendedAccessControl" : false, "folderID" : "22011", "role" : "HOST", "isMuted" : false, "isNew" : true, "nChats" : 2, "nMarkableChats" : 1, "nUnread" : 0, "nFollowups" : 0, "membersURL" : "https://socialnetwork06065-ustraveler15926.socialnetwork.dc1.c9dev1.example.com/osn/social/api/v1/conversations/22006/members", "membershipsURL" : "https://socialnetwork06065-ustraveler15926.socialnetwork.dc1.c9dev1.example.com/osn/social/api/v1/conversations/22006/memberships", "messagesURL" : "https://socialnetwork06065-ustraveler15926.socialnetwork.dc1.c9dev1.example.com/osn/social/api/v1/conversations/22006/messages", "propertiesURL" : "https://socialnetwork06065-ustraveler15926.socialnetwork.dc1.c9dev1.example.com/osn/social/api/v1/conversations/22006/properties", "userPropertiesURL" : "https://socialnetwork06065-ustraveler15926.socialnetwork.dc1.c9dev1.example.com/osn/social/api/v1/conversations/22006/userProperties", "starsURL" : "https://socialnetwork06065-ustraveler15926.socialnetwork.dc1.c9dev1.example.com/osn/social/api/v1/conversations/22006/stars", "likesURL" : "https://socialnetwork06065-ustraveler15926.socialnetwork.dc1.c9dev1.example.com/osn/social/api/v1/conversations/22006/likes", "gadgetsURL" : "https://socialnetwork06065-ustraveler15926.socialnetwork.dc1.c9dev1.example.com/osn/social/api/v1/conversations/22006/gadgets", "archiveURL" : "https://socialnetwork06065-ustraveler15926.socialnetwork.dc1.c9dev1.example.com/osn/social/api/v1/conversations/22006/archive", "folderURL" : "https://socialnetwork06065-ustraveler15926.socialnetwork.dc1.c9dev1.example.com/osn/social/api/v1/folders/22011" }