Create chat link

Create a new Link

post

Creates a new link from the request payload.

Path parameters

chatIdstringRequired

The chat ID.

Body

idstringOptional

namestringOptional

iconstring · nullableOptional

revisioninteger · int32Optional

uristring · nullableOptional

Represents the URI for link.

objectIdstring · nullableOptional

Represents the ObjectId for link.

Responses

201

Created

application/json

idstringOptional

namestringOptional

iconstring · nullableOptional

revisioninteger · int32Optional

uristring · nullableOptional

Represents the URI for link.

objectIdstring · nullableOptional

Represents the ObjectId for link.

403

Forbidden

application/json

500

Internal Server Error

post/public/v1/helpdesk/chats/{chatId}/links

POST /public/v1/helpdesk/chats/{chatId}/links HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 1606

{
  "id": "text",
  "audit": {
    "created": {
      "at": "2026-01-01T00:00:00.000Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "updated": {
      "at": "2026-01-01T00:00:00.000Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "deleted": {
      "at": "2026-01-01T00:00:00.000Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "name": "text",
  "icon": "text",
  "revision": 1,
  "message": {
    "id": "text",
    "audit": {
      "created": {
        "at": "2026-01-01T00:00:00.000Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      },
      "updated": {
        "at": "2026-01-01T00:00:00.000Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      },
      "deleted": {
        "at": "2026-01-01T00:00:00.000Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      },
      "madePublic": {
        "at": "2026-01-01T00:00:00.000Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      },
      "madePrivate": {
        "at": "2026-01-01T00:00:00.000Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      }
    },
    "$meta": {
      "omitted": [
        "text"
      ]
    },
    "revision": 1,
    "chat": {
      "id": "text",
      "name": "text",
      "icon": "text",
      "revision": 1,
      "type": "Direct"
    },
    "sender": {
      "id": "text",
      "revision": 1,
      "muted": true,
      "status": "Active"
    },
    "content": "text",
    "visibility": "Public",
    "isDeleted": true,
    "links": [
      {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1,
        "message": "[Circular Reference]",
        "uri": "text",
        "objectId": "text"
      }
    ],
    "identity": {
      "id": "text",
      "name": "text",
      "icon": "text",
      "revision": 1
    },
    "replyTo": {
      "id": "text",
      "revision": 1,
      "content": "text",
      "visibility": "Public",
      "isDeleted": true
    }
  },
  "chat": {
    "id": "text",
    "name": "text",
    "icon": "text",
    "revision": 1,
    "type": "Direct"
  },
  "uri": "text",
  "objectId": "text"
}

{
  "id": "text",
  "audit": {
    "created": {
      "at": "2026-01-01T00:00:00.000Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "updated": {
      "at": "2026-01-01T00:00:00.000Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "deleted": {
      "at": "2026-01-01T00:00:00.000Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "name": "text",
  "icon": "text",
  "revision": 1,
  "message": {
    "id": "text",
    "audit": {
      "created": {
        "at": "2026-01-01T00:00:00.000Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      },
      "updated": {
        "at": "2026-01-01T00:00:00.000Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      },
      "deleted": {
        "at": "2026-01-01T00:00:00.000Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      },
      "madePublic": {
        "at": "2026-01-01T00:00:00.000Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      },
      "madePrivate": {
        "at": "2026-01-01T00:00:00.000Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      }
    },
    "$meta": {
      "omitted": [
        "text"
      ]
    },
    "revision": 1,
    "chat": {
      "id": "text",
      "name": "text",
      "icon": "text",
      "revision": 1,
      "type": "Direct"
    },
    "sender": {
      "id": "text",
      "revision": 1,
      "muted": true,
      "status": "Active"
    },
    "content": "text",
    "visibility": "Public",
    "isDeleted": true,
    "links": [
      {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1,
        "message": "[Circular Reference]",
        "uri": "text",
        "objectId": "text"
      }
    ],
    "identity": {
      "id": "text",
      "name": "text",
      "icon": "text",
      "revision": 1
    },
    "replyTo": {
      "id": "text",
      "revision": 1,
      "content": "text",
      "visibility": "Public",
      "isDeleted": true
    }
  },
  "chat": {
    "id": "text",
    "name": "text",
    "icon": "text",
    "revision": 1,
    "type": "Direct"
  },
  "uri": "text",
  "objectId": "text"
}