Create the one-on-one conversation for the specified users.

post

/social/api/v1/people/{firstPersonID}/chats/{secondPersonID}

This method will create the one-on-one conversation if it does not already exist. Currently property update information is not being consumed by the API to update any property.

Request

Supported Media Types
Path Parameters
  • The ID of the first user in the one-on-one conversation. The ordering of the first and second person IDs does not matter. The object's unique identifier from a long integer representation.
  • The ID of the second user in the one-on-one conversation. The ordering of the first and second person IDs does not matter. The object's unique identifier from a long integer representation.
Body ()
The request body defines the details of the request.
Root Schema : XV1PeoplePropertyUpdateInfo
Type: object
V1 People Property Update Information.
Show Source
Back to Top

Response

Supported Media Types

200 Response

Successful operation.
Body ()
Root Schema : XV1ConversationInfo
Type: object
V1 Conversation Information DTO.
Show Source
Nested Schema : XV1HierarchicalMembersInfo
Type: object
V1 Hierarchical Members Information DTO.
Show Source
Nested Schema : secondaryExternalIDs
Type: array
The secondary external IDs for this conversation.
Show Source
Nested Schema : XV1ConversationState
Type: object
Show Source
  • Allowed Values: [ "CLOSED_CHAINED", "CLOSED_DISABLED", "CLOSED_DROPPED", "CLOSED_RESOLVED", "OPEN_ACTIVE" ]
    V1 Conversation States.
Nested Schema : XV1WallPostControlEnum
Type: object
Show Source
  • 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
Nested Schema : XV1IgnoredMemberListInfo
Type: object
List of ignored members.
Show Source
Nested Schema : XV1IgnoredUserListInfo
Type: object
List of ignored users.
Show Source
Nested Schema : XV1HierarchicalMembersOperationType
Type: object
Show Source
  • Allowed Values: [ "ASSOCIATE_CONVERSATION", "CREATE_CONVERSATION", "MOVE_FILE", "MOVE_FOLDER", "MOVE_MEMBERS", "REMOVE_MEMBERS", "REMOVE_MEMBERS_OBJECT", "SHARE_FOLDER" ]
    V1 Users and Groups API Operation Types on Hierarchical Members.
Nested Schema : ids
Type: array
List of folder IDs.
Show Source
Nested Schema : groups
Type: array
List of users.
Show Source
Nested Schema : users
Type: array
List of users.
Show Source
Nested Schema : users
Type: array
List of users.
Show Source
Back to Top