Jump to

• Request
• Response

Add the specified member to the specified conversation.

post

/social/api/v1/conversations/{conversationID}/members/{memberID}

Request

Supported Media Types

• application/json

Path Parameters

• conversationID: integer(int64)
  The conversation ID. The object's unique identifier from a long integer representation.
• memberID: integer(int64)
  The member ID. The object's unique identifier from a long integer representation.

Body ()

The request body defines the details of the request.

Root Schema : XV1ConversationMemberCreateInfo

Type: object

V1 Conversation Direct Member Change Information.

Show Source

• isGroup: boolean
  True if the member is a group.
• isHidden: boolean
  The member should be hidden.
• isLocked: boolean
  The member should be locked.
• member: string
  The member name. Required.
• role: object XV1ConversationRole

{
    "description":"V1 Conversation Direct Member Change Information.",
    "properties":{
        "isGroup":{
            "description":"True if the member is a group.",
            "type":"boolean"
        },
        "isHidden":{
            "description":"The member should be hidden.",
            "type":"boolean"
        },
        "isLocked":{
            "description":"The member should be locked.",
            "type":"boolean"
        },
        "member":{
            "description":"The member name. Required.",
            "type":"string"
        },
        "role":{
            "$ref":"#/definitions/XV1ConversationRole"
        }
    }
}

Nested Schema : XV1ConversationRole

Type: object

Show Source

• field: 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.

{
    "properties":{
        "field":{
            "type":"string",
            "description":"V1 Conversation Roles. <p/> Conversation roles are used to define grantable and nongrantable access to conversations.",
            "enum":[
                "ADMIN",
                "BYPASS",
                "CONTRIBUTOR",
                "DISCOVERER",
                "GROUP_MANAGER",
                "GROUP_MEMBER",
                "HOST",
                "MANAGER",
                "MEMBER",
                "MODERATOR",
                "NONE",
                "VIEWER"
            ]
        }
    }
}

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

V1 Conversation Direct Member Information DTO.

Root Schema : XV1ConversationMemberInfo

Type: object

V1 Conversation Direct Member Information DTO.

Show Source

• altitude: number(double)
  The object's altitude.
• 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.
• displayName: string
  The display name of this object.
• id:
  An object's unique identifier from a long integer representation.
• isDirect: boolean
  The member's direct status.
• isHidden: boolean
  The member's hidden status.
• isHierarchical: boolean
  The member's hierarchical status.
• isLocked: boolean
  The member's locked status.
• isRemoved: boolean
  True if this message has been removed.
• latitude: number(double)
  The object's latitude.
• longitude: number(double)
  The object's longitude.
• membersURL: string(url)
  A URL to the collection of members.
• 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.
• 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).
• 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: object XV1ConversationRole
• scaledPictureURL: string(url)
  The scaled picture URL (44 px by 44 px).
• socialObjectURL: string(url)
  A URL to this object's containing collaboration object.
• url: string(url)
  A URL to this object.

{
    "description":"V1 Conversation Direct Member Information DTO.",
    "properties":{
        "isDirect":{
            "description":"The member's direct status.",
            "type":"boolean"
        },
        "isHidden":{
            "description":"The member's hidden status.",
            "type":"boolean"
        },
        "isHierarchical":{
            "description":"The member's hierarchical status.",
            "type":"boolean"
        },
        "isLocked":{
            "description":"The member's locked status.",
            "type":"boolean"
        },
        "membersURL":{
            "description":"A URL to the collection of members.",
            "type":"string",
            "format":"url"
        },
        "role":{
            "$ref":"#/definitions/XV1ConversationRole"
        },
        "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 : XV1ConversationRole

Type: object

Show Source

• field: 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.

{
    "properties":{
        "field":{
            "type":"string",
            "description":"V1 Conversation Roles. <p/> Conversation roles are used to define grantable and nongrantable access to conversations.",
            "enum":[
                "ADMIN",
                "BYPASS",
                "CONTRIBUTOR",
                "DISCOVERER",
                "GROUP_MANAGER",
                "GROUP_MEMBER",
                "HOST",
                "MANAGER",
                "MEMBER",
                "MODERATOR",
                "NONE",
                "VIEWER"
            ]
        }
    }
}