Skip to main content
POST
/
conversations
/
{id}
/
restart
If this is a WhatsApp conversation it is possible to restart the conversation by calling this endpoint. A WhatsApp template message will be sent asking the customer if they want to continue the conversation. The template is a marketing message and will cost about 11 cents. This opens up a new 24 hours window for chatting as soon as the customer replies with anything (even "No"). See the "Important" hint in the description of the reply_until field in this document! The conversation must have expired before. 
curl --request POST \
  --url https://1-some-client.some-server.healvi-chat/third-party/v1/conversations/{id}/restart \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "id": 123,
    "conversation_id": 123,
    "from": "system",
    "source": "user",
    "user_id": 123,
    "contents": [
      "<unknown>"
    ],
    "status": "created",
    "agent_reaction": "<string>",
    "customer_reaction": "<string>",
    "sent_at": "2023-01-01T12:00:00Z",
    "reference": "<unknown>",
    "latest_error": {
      "id": 123,
      "message_id": 123,
      "type": "status-update",
      "original_message": "<string>",
      "created_at": "2023-01-01T12:00:00Z"
    },
    "whatsapp_campaign": {
      "id": 123,
      "name": "<string>"
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.chat.voicebot.studio/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
integer
required

Response

200 - application/json

Success

​
data
object

A message within a conversation.