Skip to main content
POST
/
v2
/
pos
/
{posSystemId}
/
widget
/
sendMessage
Send an email or sms with widget the landing page url
curl --request POST \
  --url https://public-api-demo.clearline.me/v2/pos/{posSystemId}/widget/sendMessage \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json-patch+json' \
  --data '
{
  "posLocationId": "6orMqUyq2Hg3tP",
  "terminalId": "6orMqUyq",
  "widgetId": "5",
  "sessionId": "SESSION_ID",
  "profile": {
    "firstName": "Olli",
    "lastName": "Ozby",
    "customerEmail": "some@email.net",
    "customerPhone": "",
    "salesPerson": "0666"
  },
  "couponId": ""
}
'
{
  "data": {}
}

Authorizations

​
Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Enter JWT Bearer token only in the text input below.

Path Parameters

​
posSystemId
string
required

POS System Id

Body

Request

Send widget message request

​
widgetId
integer<int32>
required

Widget identifier

​
sessionId
string
required

Session identifier

Minimum string length: 1
​
posLocationId
string
required

POS location identifier

Minimum string length: 1
​
terminalId
string
required

Terminal identifier

Minimum string length: 1
​
profile
object
required

Profile information for POS widget

​
couponId
string | null

Coupon unique identifier

Response

Success

​
data
object

Send widget message response