Creates a 1-to-1 conversation

v1.0.0

Creates a 1-to-1 conversation between the authenticated user and the user with the provided userId. In case there is already an existing 1-to-1 conversation between these users, the endpoint returns the existing conversation. OauthScopes: WRITE_CONVERSATIONS, MANAGE_CONVERSATIONS

Output

{
  "properties": {
    "avatar": {
      "type": "string",
      "description": "The URL of the small avatar image of the conversation"
    },
    "avatarLarge": {
      "type": "string",
      "description": "The URL of the large avatar image of the conversation"
    },
    "convId": {
      "type": "string",
      "description": "The ID of the conversation"
    },
    "creationTime": {
      "type": "number",
      "format": "int64",
      "description": "UTC timestamp when the conversation was created"
    },
    "creatorId": {
      "type": "string",
      "description": "The ID of the user who created the conversation"
    },
    "creatorTenantId": {
      "type": "string",
      "description": "The ID of the Circuit domain (tenant) where the creator of the conversation belongs to"
    },
    "description": {
      "type": "string",
      "description": "The description of the conversation. This field is available only for conversations with type COMMUNITY"
    },
    "isGuestAccessDisabled": {
      "type": "boolean",
      "description": "Indicates whether guest access to the conversation is disabled or not"
    },
    "isModerated": {
      "type": "boolean",
      "description": "Indicates whether the conversation is moderated or not. In a moderated conversation only participants who have been assigned the role of a moderator are allowed to add or remove participants into the conversation"
    },
    "modificationTime": {
      "type": "number",
      "format": "int64",
      "description": "UTC timestamp when the conversation was modified. A conversation is modified when any of the conversation object fields change but not when conversation items are added or edited"
    },
    "participants": {
      "type": "array",
      "description": "Array of active participants",
      "items": {
        "type": "string"
      }
    },
    "topic": {
      "type": "string",
      "description": "The title of the conversation. Conversations of type DIRECT cannot have a title"
    },
    "topicPlaceholder": {
      "type": "string",
      "description": "The title of the conversation. Conversations of type DIRECT cannot have a title"
    },
    "type": {
      "type": "string",
      "description": "The type of the conversation. It can be one of the following: DIRECT, GROUP, COMMUNITY or LARGE"
    }
  }
}