Invite Rating - Chat API

POST

conversations

{id}

invite-rating

Generate a message containing an invite link for the user to leave a rating.

curl --request POST \
  --url https://1-some-client.some-server.healvi-chat/third-party/v1/conversations/{id}/invite-rating \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "text": "<string>",
    "link": "<string>",
    "rating": {
      "id": 123,
      "code": "<string>",
      "stars": 123,
      "comment": "<string>",
      "created_at": "2023-01-01T12:00:00Z",
      "updated_at": "2023-01-01T12:00:00Z"
    }
  }
}

Authorizations

Authorization

string

header

required

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

Path Parameters

integer

required

Response

200 - application/json

Success

data

object

Show child attributes

Restart ConversationIf 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.

Generate a message containing an invite link for the user to leave a rating.

curl --request POST \
  --url https://1-some-client.some-server.healvi-chat/third-party/v1/conversations/{id}/invite-rating \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "text": "<string>",
    "link": "<string>",
    "rating": {
      "id": 123,
      "code": "<string>",
      "stars": 123,
      "comment": "<string>",
      "created_at": "2023-01-01T12:00:00Z",
      "updated_at": "2023-01-01T12:00:00Z"
    }
  }
}