REST API for Conversations

Set the specified user properties on the specified conversation.

post

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

Request

Supported Media Types

application/json

Path Parameters

conversationID: integer(int64)

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

The user property ID. The object's unique identifier from a long integer representation.

The request body defines the details of the request.

Root Schema : XV1ConversationPropertyUpdateInfo

Type: object

V1 Conversation Property Update Information.

Show Source

value(optional): string

The property value.

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

Response

Supported Media Types

application/json

200 Response

Successful operation.

Root 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"
        }
    }
}