Jump to

• Request
• Response

Set a property on the specified conversation.

post

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

Request

Supported Media Types

• application/json

Path Parameters

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

Body ()

The request body defines the details of the request.

Root Schema : XV1ConversationPropertyCreateInfo

Type: object

V1 Conversation Property Create Information.

Show Source

• name: string
  The property name. Required.
• value: string
  The property value.

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

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

V1 Conversation Property Information DTO.

Root Schema : XV1ConversationPropertyInfo

Type: object

V1 Conversation Property Information DTO.

Show Source

• name: string
  The property name.
• value: 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"
        }
    }
}