Jump to

• Request
• Response

Get all user properties of the specified conversation.

get

/social/api/v1/conversations/{conversationID}/userProperties

Request

Supported Media Types

• application/json

Path Parameters

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : XV1ConversationPropertyListInfo

Type: object

V1 Conversation Property List Information DTO.

Show Source

• hasMore(optional): boolean
  If true, there are more items to be returned.
• items(optional): array items
  The properties being 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.

{
    "description":"V1 Conversation Property List Information DTO.",
    "properties":{
        "items":{
            "description":"The properties being returned.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/XV1ConversationPropertyInfo"
            }
        },
        "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 : items

Type: array

The properties being returned.

Show Source

• Array of: object XV1ConversationPropertyInfo
  V1 Conversation Property Information DTO.

{
    "description":"The properties being returned.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/XV1ConversationPropertyInfo"
    }
}

Nested Schema : XV1ConversationPropertyInfo

Type: object

V1 Conversation Property Information DTO.

Show Source

• name(optional): string
  The property name.
• value(optional): string(uuid)
  The property value.

{
    "description":"V1 Conversation Property Information DTO.",
    "properties":{
        "name":{
            "description":"The property name.",
            "type":"string"
        },
        "value":{
            "description":"The property value.",
            "type":"string",
            "format":"uuid"
        }
    }
}

Back to Top