Jump to

• Request
• Response

Create a new applink for the specified conversation.

post

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

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 : XV1AppLinkCreateInfo

Type: object

V1 App Link Create Information DTO.

Show Source

• sendInvitation(optional): boolean
  If set to true and a shadow user gets created, send an invitation to the user.
• userID(optional):
  An object's unique identifier from a long integer representation.
• userName(optional): string
  The name of the user for whom the applink will be created. Either {@link #userID} or {@link #userName} must be specified. If they are both specified, {@link #userID} will take precedence.

{
    "description":"V1 App Link Create Information DTO.",
    "properties":{
        "sendInvitation":{
            "description":"If set to true and a shadow user gets created, send an invitation to the user.",
            "type":"boolean"
        },
        "userID":{
            "$ref":"#/definitions/XObjectID"
        },
        "userName":{
            "description":"The name of the user for whom the applink will be created. Either {@link #userID} or  {@link #userName} must be specified. If they are both specified, {@link #userID} will  take precedence.",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : XV1AppLinkInfo

Type: object

V1 App Link Information DTO.

Show Source

• accessToken(optional): string
  The access token. When the cList for the applink is launched, this token will be passed to the Content and Experience Cloud server.
• appLinkURL(optional): string
  The full URL for cList, containing the conversation or collaboration object ID for which the link is generated.

{
    "description":"V1 App Link Information DTO.",
    "properties":{
        "accessToken":{
            "description":"The access token. When the cList for the applink is launched, this token will be  passed to the Content and Experience Cloud server.",
            "type":"string"
        },
        "appLinkURL":{
            "description":"The full URL for cList, containing the conversation or collaboration object ID for which the link is  generated.",
            "type":"string"
        }
    }
}

Back to Top