POST suggestions

This section describes how to use the POST suggestions endpoint. Use the /api/v1/suggestions (POST) endpoint to create a new Conversation Starter as shown in the sample payload.

Note: Include a user-input variable within the Conversation Starter by using curly brackets, such as {ProductCode}.

These properties do not need to be included but will be received in the response payload:

  • warnings
  • guid
  • createdon
  • createdby
  • updatedon
{
    "warnings": null,
    "guid": "13c863f9-9835-4f1e-b7f8-4ec0bfd7d968",
    "suggestion": "Display user details for employee {FullName}",
    "ibcScreenId": "osportal_user_ibcscreenIDexample",
    "logicalidPrefix": null,
    "createdOn": "2024-01-01T12:00:00.000000Z",
    "createdBy": null,
    "updatedBy": null,
    "updatedOn": null
}