Endpoints
- Message templates
- Session
- Team
- Messages
- Help center collections
- Help center articles
- Help center redirects
- Ticket
- Engagement Banner
- Engagement Chat Message
- Engagement Cobrowse
- Engagement Email
- Engagement News
- Engagement Product Tour
- Engagement Push Notification
- Engagement Survey
- Engagement Tooltip
- Engagement Whatsapp Messages
- Engagement Checklist
- Engagement
- AI content
- Engagement Modal
- Invitation
- Project
Messages
Create a new message
Create a new message
POST
/
messages
curl --request POST \
--url https://api.gleap.io/v3/messages \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'project: <project>' \
--data '{
"user": "<string>",
"session": "<string>",
"bot": true,
"fallbackUser": {
"username": "<string>",
"email": "<string>",
"imageUrl": "<string>"
},
"messageRef": "<string>",
"ticket": "<string>",
"data": "<any>",
"translatedData": "<any>",
"type": "<string>",
"emailId": "<string>",
"sessionNotificationsUnread": true,
"outbound": "<string>",
"outboundTemplate": "<string>",
"outboundSubject": "<string>",
"status": "<any>",
"statusHistory": [
"<any>"
],
"comment": "<any>",
"isReply": true,
"kaiChat": true,
"aiData": "<any>",
"attachments": [
{
"name": "<string>",
"url": "<string>",
"type": "<string>"
}
],
"channel": {
"id": "<string>",
"type": "<string>",
"messageId": "<string>"
},
"sendToChannel": true,
"isNote": true,
"rating": "<string>"
}'
"<any>"
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Headers
Body
application/json
Response
200 - application/json
Ok
The response is of type any
.
curl --request POST \
--url https://api.gleap.io/v3/messages \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'project: <project>' \
--data '{
"user": "<string>",
"session": "<string>",
"bot": true,
"fallbackUser": {
"username": "<string>",
"email": "<string>",
"imageUrl": "<string>"
},
"messageRef": "<string>",
"ticket": "<string>",
"data": "<any>",
"translatedData": "<any>",
"type": "<string>",
"emailId": "<string>",
"sessionNotificationsUnread": true,
"outbound": "<string>",
"outboundTemplate": "<string>",
"outboundSubject": "<string>",
"status": "<any>",
"statusHistory": [
"<any>"
],
"comment": "<any>",
"isReply": true,
"kaiChat": true,
"aiData": "<any>",
"attachments": [
{
"name": "<string>",
"url": "<string>",
"type": "<string>"
}
],
"channel": {
"id": "<string>",
"type": "<string>",
"messageId": "<string>"
},
"sendToChannel": true,
"isNote": true,
"rating": "<string>"
}'
"<any>"