Jump to

• Request
• Response

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

• application/json

Path Parameters

• firstPersonID: integer(int64)
  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.
• secondPersonID: integer(int64)
  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

• value(optional): string
  The property value.

{
    "description":"V1 People Property Update Information.",
    "properties":{
        "value":{
            "description":"The property value.",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : XV1ConversationInfo

Type: object

V1 Conversation Information DTO.

Show Source

• allMembershipsURL(optional): string(url)
  A URL to the hierarchical memberships of this conversation.
• altitude(optional): number(double)
  The object's altitude.
• archiveURL(optional): string(url)
  A URL to the archive of this conversation.
• 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.
• dateFormatLocale(optional): string(locale)
  The locale of the appropriate date format for this conversation.
• discoverableID(optional):
  An object's unique identifier from a long integer representation.
• displayName(optional): string
  The display name of this object.
• externalID(optional): string
  The primary external ID of this conversation.
• folderID(optional):
  An object's unique identifier from a long integer representation.
• folderURL(optional): string(url)
  A URL to the root folder of this conversation.
• gadgetsURL(optional): string(url)
  A URL to the gadgets of this conversation.
• hasMembersLocked(optional): boolean
  True if the membership of this conversation is locked.
• hierarchicalMembersInfo(optional): object XV1HierarchicalMembersInfo
  V1 Hierarchical Members Information DTO.
• id(optional):
  An object's unique identifier from a long integer representation.
• isDisallowGuests(optional): boolean
  True if this conversation does not allow guest users.
• isDisallowOutsiders(optional): boolean
  True if this conversation does not allow outsider users.
• isDiscoverable(optional): boolean
  True if this conversation is discoverable (public).
• isExtendedAccessControl(optional): boolean
  True if this conversation uses extended access control.
• isMuted(optional): boolean
  True if this conversation is muted for the current user.
• isNew(optional): boolean
  True if this conversation has not been entered by the current user.
• isRemoved(optional): boolean
  True if this message has been removed.
• isScoped(optional): boolean
  True if the membership of this conversation is scoped by another conversation.
• isScoping(optional): boolean
  True if this is a scoping conversation.
• isScopingSame(optional): boolean
  True if this conversation is scoped to have the same membership as another conversation.
• languageLocale(optional): string(locale)
  The language locale for this conversation.
• latitude(optional): number(double)
  The object's latitude.
• likesURL(optional): string(url)
  A URL to the likes of this conversation.
• longitude(optional): number(double)
  The object's longitude.
• membershipsURL(optional): string(url)
  A URL to the memberships of this conversation.
• membersURL(optional): string(url)
  A URL to the members of this conversation.
• messagesURL(optional): string(url)
  A URL to the messages in this conversation.
• 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.
• nChats(optional): integer(int32)
  The number of chats in this conversation. (total chats less deleted chats.)
• nFollowups(optional): integer(int32)
  The number of followups in the conversation.
• nMarkableChats(optional): integer(int32)
  The number of chats that could be marked read. (Total markable less deleted markable. Does not depend on the current user.)
• nOutsiders(optional): integer(int32)
  Count of the outside users.
• nUnread(optional): integer(int32)
  The number of chats that the current user can mark read.
• 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).
• propertiesURL(optional): string(url)
  A URL to the properties of this conversation.
• 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): string
  The current user's role in this conversation.
• scaledPictureURL(optional): string(url)
  The scaled picture URL (44 px by 44 px).
• secondaryExternalIDs(optional): array secondaryExternalIDs
  The secondary external IDs for this conversation.
• securityContextID(optional): string
  The ID of the service that dictates the security for this conversation object.
• socialObjectURL(optional): string(url)
  A URL to this object's containing collaboration object.
• starsURL(optional): string(url)
  A URL to the stars of this conversation.
• state(optional): object XV1ConversationState
• timeZone(optional): string(timezone)
  The time zone for this conversation.
• url(optional): string(url)
  A URL to this object.
• userPropertiesURL(optional): string(url)
  A URL to the user properties of this conversation.
• wallPostControl(optional): object XV1WallPostControlEnum

{
    "description":"V1 Conversation Information DTO.",
    "properties":{
        "allMembershipsURL":{
            "description":"A URL to the hierarchical memberships of this conversation.",
            "type":"string",
            "format":"url"
        },
        "archiveURL":{
            "description":"A URL to the archive of this conversation.",
            "type":"string",
            "format":"url"
        },
        "dateFormatLocale":{
            "description":"The locale of the appropriate date format for this conversation.",
            "type":"string",
            "format":"locale"
        },
        "discoverableID":{
            "$ref":"#/definitions/XObjectID"
        },
        "externalID":{
            "description":"The primary external ID of this conversation.",
            "type":"string"
        },
        "folderID":{
            "$ref":"#/definitions/XObjectID"
        },
        "folderURL":{
            "description":"A URL to the root folder of this conversation.",
            "type":"string",
            "format":"url"
        },
        "gadgetsURL":{
            "description":"A URL to the gadgets of this conversation.",
            "type":"string",
            "format":"url"
        },
        "hasMembersLocked":{
            "description":"True if the membership of this conversation is locked.",
            "type":"boolean"
        },
        "hierarchicalMembersInfo":{
            "$ref":"#/definitions/XV1HierarchicalMembersInfo"
        },
        "isDisallowGuests":{
            "description":"True if this conversation does not allow guest users.",
            "type":"boolean"
        },
        "isDisallowOutsiders":{
            "description":"True if this conversation does not allow outsider users.",
            "type":"boolean"
        },
        "isDiscoverable":{
            "description":"True if this conversation is discoverable (public).",
            "type":"boolean"
        },
        "isExtendedAccessControl":{
            "description":"True if this conversation uses extended access control.",
            "type":"boolean"
        },
        "isMuted":{
            "description":"True if this conversation is muted for the current user.",
            "type":"boolean"
        },
        "isNew":{
            "description":"True if this conversation has not been entered by the current user.",
            "type":"boolean"
        },
        "isScoped":{
            "description":"True if the membership of this conversation is scoped by another conversation.",
            "type":"boolean"
        },
        "isScoping":{
            "description":"True if this is a scoping conversation.",
            "type":"boolean"
        },
        "isScopingSame":{
            "description":"True if this conversation is scoped to have the same membership as another conversation.",
            "type":"boolean"
        },
        "languageLocale":{
            "description":"The language locale for this conversation.",
            "type":"string",
            "format":"locale"
        },
        "likesURL":{
            "description":"A URL to the likes of this conversation.",
            "type":"string",
            "format":"url"
        },
        "membershipsURL":{
            "description":"A URL to the memberships of this conversation.",
            "type":"string",
            "format":"url"
        },
        "membersURL":{
            "description":"A URL to the members of this conversation.",
            "type":"string",
            "format":"url"
        },
        "messagesURL":{
            "description":"A URL to the messages in this conversation.",
            "type":"string",
            "format":"url"
        },
        "nChats":{
            "description":"The number of chats in this conversation. (total chats less deleted chats.)",
            "type":"integer",
            "format":"int32"
        },
        "nFollowups":{
            "description":"The number of followups in the conversation.",
            "type":"integer",
            "format":"int32"
        },
        "nMarkableChats":{
            "description":"The number of chats that could be marked read. (Total markable less deleted markable. Does not depend on the current user.)",
            "type":"integer",
            "format":"int32"
        },
        "nOutsiders":{
            "description":"Count of the outside users.",
            "type":"integer",
            "format":"int32"
        },
        "nUnread":{
            "description":"The number of chats that the current user can mark read.",
            "type":"integer",
            "format":"int32"
        },
        "propertiesURL":{
            "description":"A URL to the properties of this conversation.",
            "type":"string",
            "format":"url"
        },
        "role":{
            "description":"The current user's role in this conversation.",
            "type":"string"
        },
        "secondaryExternalIDs":{
            "description":"The secondary external IDs for this conversation.",
            "type":"array",
            "items":{
                "description":"The secondary external IDs for this conversation.",
                "type":"string"
            }
        },
        "securityContextID":{
            "description":"The ID of the service that dictates the security for this conversation object.",
            "type":"string"
        },
        "starsURL":{
            "description":"A URL to the stars of this conversation.",
            "type":"string",
            "format":"url"
        },
        "state":{
            "$ref":"#/definitions/XV1ConversationState"
        },
        "timeZone":{
            "description":"The time zone for this conversation.",
            "type":"string",
            "format":"timezone"
        },
        "userPropertiesURL":{
            "description":"A URL to the user properties of this conversation.",
            "type":"string",
            "format":"url"
        },
        "wallPostControl":{
            "$ref":"#/definitions/XV1WallPostControlEnum"
        },
        "originalPictureURL":{
            "description":"The original picture URL.",
            "type":"string",
            "format":"url"
        },
        "profilePictureURL":{
            "description":"The profile picture URL (150 px by 150 px).",
            "type":"string",
            "format":"url"
        },
        "scaledPictureURL":{
            "description":"The scaled picture URL (44 px by 44 px).",
            "type":"string",
            "format":"url"
        },
        "altitude":{
            "description":"The object's altitude.",
            "type":"number",
            "format":"double"
        },
        "collectionURL":{
            "description":"A URL to this object's containing collection.",
            "type":"string",
            "format":"url"
        },
        "conversationURL":{
            "description":"A URL to this object's containing conversation.",
            "type":"string",
            "format":"url"
        },
        "createdByID":{
            "$ref":"#/definitions/XObjectID"
        },
        "createdByURL":{
            "description":"A URL to the user that created this object.",
            "type":"string",
            "format":"url"
        },
        "createdByUserDisplayName":{
            "description":"The display name of the user that created this object.",
            "type":"string"
        },
        "createdByUserName":{
            "description":"The name of the user that created this object.",
            "type":"string"
        },
        "createdDate":{
            "description":"The date this object was created.",
            "type":"string",
            "format":"date"
        },
        "createdDateInISO8601Format":{
            "description":"The date this object was created, in ISO 8601 format.",
            "type":"string"
        },
        "displayName":{
            "description":"The display name of this object.",
            "type":"string"
        },
        "id":{
            "$ref":"#/definitions/XObjectID"
        },
        "isRemoved":{
            "description":"True if this message has been removed.",
            "type":"boolean"
        },
        "latitude":{
            "description":"The object's latitude.",
            "type":"number",
            "format":"double"
        },
        "longitude":{
            "description":"The object's longitude.",
            "type":"number",
            "format":"double"
        },
        "modifiedByID":{
            "$ref":"#/definitions/XObjectID"
        },
        "modifiedByURL":{
            "description":"A URL to the user that last modified this object.",
            "type":"string",
            "format":"url"
        },
        "modifiedByUserDisplayName":{
            "description":"The display name of the user that last modified this object.",
            "type":"string"
        },
        "modifiedByUserName":{
            "description":"The name of the user that last modified this object.",
            "type":"string"
        },
        "modifiedDate":{
            "description":"The date this object was last modified.",
            "type":"string",
            "format":"date"
        },
        "modifiedDateInISO8601Format":{
            "description":"The date this object was last modified, in ISO 8601 format.",
            "type":"string"
        },
        "name":{
            "description":"The name of this object.",
            "type":"string"
        },
        "objectType":{
            "description":"The type of this object.",
            "type":"string"
        },
        "removedByID":{
            "$ref":"#/definitions/XObjectID"
        },
        "removedByURL":{
            "description":"A URL to the user that last removed this object.",
            "type":"string",
            "format":"url"
        },
        "removedByUserDisplayName":{
            "description":"The display name of the user that last removed this object.",
            "type":"string"
        },
        "removedByUserName":{
            "description":"The name of the user that last removed this object.",
            "type":"string"
        },
        "removedDate":{
            "description":"The date this object was removed.",
            "type":"string",
            "format":"date"
        },
        "removedDateInISO8601Format":{
            "description":"The date this object was removed, in ISO 8601 format.",
            "type":"string"
        },
        "socialObjectURL":{
            "description":"A URL to this object's containing collaboration object.",
            "type":"string",
            "format":"url"
        },
        "url":{
            "description":"A URL to this object.",
            "type":"string",
            "format":"url"
        }
    }
}

Nested Schema : XV1HierarchicalMembersInfo

Type: object

V1 Hierarchical Members Information DTO.

Show Source

• conversationAlreadyExists(optional): boolean
  Set to true if a conversation already exists when operationType is CREATE_CONVERSATION.
• createdFolderIDs(optional): object XV1FolderIDListInfo
  List of folder IDs.
• ignoredMembers(optional): object XV1IgnoredMemberListInfo
  List of ignored members.
• ignoredUsers(optional): object XV1IgnoredUserListInfo
  List of ignored users.
• operationType(optional): object XV1HierarchicalMembersOperationType
• removedFolderIDs(optional): object XV1FolderIDListInfo
  List of folder IDs.

{
    "description":"V1 Hierarchical Members Information DTO.",
    "properties":{
        "conversationAlreadyExists":{
            "description":"Set to true if a conversation already exists when  operationType is CREATE_CONVERSATION.",
            "type":"boolean"
        },
        "createdFolderIDs":{
            "$ref":"#/definitions/XV1FolderIDListInfo"
        },
        "ignoredMembers":{
            "$ref":"#/definitions/XV1IgnoredMemberListInfo"
        },
        "ignoredUsers":{
            "$ref":"#/definitions/XV1IgnoredUserListInfo"
        },
        "operationType":{
            "$ref":"#/definitions/XV1HierarchicalMembersOperationType"
        },
        "removedFolderIDs":{
            "$ref":"#/definitions/XV1FolderIDListInfo"
        }
    }
}

Nested Schema : secondaryExternalIDs

Type: array

The secondary external IDs for this conversation.

Show Source

• Array of: string
  The secondary external IDs for this conversation.

{
    "description":"The secondary external IDs for this conversation.",
    "type":"array",
    "items":{
        "description":"The secondary external IDs for this conversation.",
        "type":"string"
    }
}

Nested Schema : XV1ConversationState

Type: object

Show Source

• field(optional): string
  Allowed Values: [ "CLOSED_CHAINED", "CLOSED_DISABLED", "CLOSED_DROPPED", "CLOSED_RESOLVED", "OPEN_ACTIVE" ]

  V1 Conversation States.

{
    "properties":{
        "field":{
            "type":"string",
            "description":"V1 Conversation States.",
            "enum":[
                "CLOSED_CHAINED",
                "CLOSED_DISABLED",
                "CLOSED_DROPPED",
                "CLOSED_RESOLVED",
                "OPEN_ACTIVE"
            ]
        }
    }
}

Nested Schema : XV1WallPostControlEnum

Type: object

Show Source

• field(optional): string
  Allowed Values: [ "ANYONE_CAN_POST", "OWNER_ONLY_POSTS", "OWNER_TOP_LEVEL" ]

  V1 Wall Posting Control Enum.

{
    "properties":{
        "field":{
            "type":"string",
            "description":"V1 Wall Posting Control Enum.",
            "enum":[
                "ANYONE_CAN_POST",
                "OWNER_ONLY_POSTS",
                "OWNER_TOP_LEVEL"
            ]
        }
    }
}

Nested Schema : XV1FolderIDListInfo

Type: object

List of folder IDs.

Show Source

• hasMore(optional): boolean
  If true, there are more items to be returned.
• ids(optional): array ids
  List of folder IDs.
• nextURL(optional): string(url)
  Next page URL for the list. Null if this is the last page.
• previousURL(optional): string(url)
  Previous page URL for the list. Null if this is the first page.
• total(optional): integer(int32)
  If specified, this is the total number of available items. Null if the total is unknown.

{
    "description":"List of folder IDs.",
    "properties":{
        "ids":{
            "description":"List of folder IDs.",
            "type":"array",
            "items":{
                "description":"List of folder IDs.",
                "type":"string"
            }
        },
        "hasMore":{
            "description":"If true, there are more items to be returned.",
            "type":"boolean"
        },
        "nextURL":{
            "description":"Next page URL for the list. Null if this is the last page.",
            "type":"string",
            "format":"url"
        },
        "previousURL":{
            "description":"Previous page URL for the list. Null if this is the first page.",
            "type":"string",
            "format":"url"
        },
        "total":{
            "description":"If specified, this is the total number of available items. Null if the total is unknown.",
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : XV1IgnoredMemberListInfo

Type: object

List of ignored members.

Show Source

• groups(optional): array groups
  List of users.
• hasMore(optional): boolean
  If true, there are more items to be returned.
• nextURL(optional): string(url)
  Next page URL for the list. Null if this is the last page.
• previousURL(optional): string(url)
  Previous page URL for the list. Null if this is the first page.
• total(optional): integer(int32)
  If specified, this is the total number of available items. Null if the total is unknown.
• users(optional): array users
  List of users.

{
    "description":"List of ignored members.",
    "properties":{
        "groups":{
            "description":"List of users.",
            "type":"array",
            "items":{
                "description":"List of users.",
                "type":"string"
            }
        },
        "users":{
            "description":"List of users.",
            "type":"array",
            "items":{
                "description":"List of users.",
                "type":"string"
            }
        },
        "hasMore":{
            "description":"If true, there are more items to be returned.",
            "type":"boolean"
        },
        "nextURL":{
            "description":"Next page URL for the list. Null if this is the last page.",
            "type":"string",
            "format":"url"
        },
        "previousURL":{
            "description":"Previous page URL for the list. Null if this is the first page.",
            "type":"string",
            "format":"url"
        },
        "total":{
            "description":"If specified, this is the total number of available items. Null if the total is unknown.",
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : XV1IgnoredUserListInfo

Type: object

List of ignored users.

Show Source

• hasMore(optional): boolean
  If true, there are more items to be returned.
• nextURL(optional): string(url)
  Next page URL for the list. Null if this is the last page.
• previousURL(optional): string(url)
  Previous page URL for the list. Null if this is the first page.
• total(optional): integer(int32)
  If specified, this is the total number of available items. Null if the total is unknown.
• users(optional): array users
  List of users.

{
    "description":"List of ignored users.",
    "properties":{
        "users":{
            "description":"List of users.",
            "type":"array",
            "items":{
                "description":"List of users.",
                "type":"string"
            }
        },
        "hasMore":{
            "description":"If true, there are more items to be returned.",
            "type":"boolean"
        },
        "nextURL":{
            "description":"Next page URL for the list. Null if this is the last page.",
            "type":"string",
            "format":"url"
        },
        "previousURL":{
            "description":"Previous page URL for the list. Null if this is the first page.",
            "type":"string",
            "format":"url"
        },
        "total":{
            "description":"If specified, this is the total number of available items. Null if the total is unknown.",
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : XV1HierarchicalMembersOperationType

Type: object

Show Source

• field(optional): string
  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.

{
    "properties":{
        "field":{
            "type":"string",
            "description":"V1 Users and Groups API Operation Types on Hierarchical Members.",
            "enum":[
                "ASSOCIATE_CONVERSATION",
                "CREATE_CONVERSATION",
                "MOVE_FILE",
                "MOVE_FOLDER",
                "MOVE_MEMBERS",
                "REMOVE_MEMBERS",
                "REMOVE_MEMBERS_OBJECT",
                "SHARE_FOLDER"
            ]
        }
    }
}

Nested Schema : ids

Type: array

List of folder IDs.

Show Source

• Array of: string
  List of folder IDs.

{
    "description":"List of folder IDs.",
    "type":"array",
    "items":{
        "description":"List of folder IDs.",
        "type":"string"
    }
}

Nested Schema : groups

Type: array

List of users.

Show Source

• Array of: string
  List of users.

{
    "description":"List of users.",
    "type":"array",
    "items":{
        "description":"List of users.",
        "type":"string"
    }
}

Nested Schema : users

Type: array

List of users.

Show Source

• Array of: string
  List of users.

{
    "description":"List of users.",
    "type":"array",
    "items":{
        "description":"List of users.",
        "type":"string"
    }
}

Nested Schema : users

Type: array

List of users.

Show Source

• Array of: string
  List of users.

{
    "description":"List of users.",
    "type":"array",
    "items":{
        "description":"List of users.",
        "type":"string"
    }
}

Back to Top