Ticket API

Endpoint to converse with a ticket automation virtual agent.


Request

post/converse/ticket
Headers Parameters:
  1. AuthorizationstringRequired

    String API Key for the bot. The key can be generated on custom CRM integration page in our Ultimate.ai Dashboard. Please see Authentication article to learn more.

  2. botidstringRequired

    The ID of the bot that is sending the event.

Body

Required
Request Body Schema: application/json
  1. platformConversationIdstring

    An ID provided by the custom CRM to identify the conversation. The custom CRM application can decide the format.

  2. textstring

    String content of email

  3. platformstring

    Name of the used platform. For a custom CRM application, this should be "PUBLIC_API".

  4. metadataarray

    Variables to store in session

    1. keystring

      Variable key/name

    2. valuestring

      Variable value

    3. sanitizeboolean

      Variable sanitize flag

Response

The request has been acknowledge and will be processed. The actual response will come through webhooks.

Request Body

{
	"platformConversationId": "string",
	"text": "string",
	"platform": "string",
	"metadata": [
		{
			"key": "string",
			"value": "string",
			"sanitize": true
		}
	]
}