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
Engagement News
Update a news article.
PUT
/
engagement
/
news
/
{newsId}
curl --request PUT \
--url https://api.gleap.io/v3/engagement/news/{newsId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'project: <project>' \
--data '"<any>"'
{
"emailTemplate": {
"isValid": {},
"createFromHexString": {},
"createFromTime": {},
"generate": {},
"cacheHexString": "<any>",
"prototype": "<string>"
},
"sourceOutbound": {
"isValid": {},
"createFromHexString": {},
"createFromTime": {},
"generate": {},
"cacheHexString": "<any>",
"prototype": "<string>"
},
"trigger": "<any>",
"pageFilterDelay": 123,
"pageFilter": "<string>",
"eventTriggerDelay": 123,
"eventTrigger": "<string>",
"actionType": "<string>",
"sentAt": "2023-11-07T05:31:56Z",
"stats": "<any>",
"subject": "<any>",
"coverImageUrl": "<string>",
"sender": {
"isValid": {},
"createFromHexString": {},
"createFromTime": {},
"generate": {},
"cacheHexString": "<any>",
"prototype": "<string>"
},
"project": {
"isValid": {},
"createFromHexString": {},
"createFromTime": {},
"generate": {},
"cacheHexString": "<any>",
"prototype": "<string>"
},
"data": "<any>",
"config": "<any>",
"message": "<any>",
"aiSummaryOutdated": true,
"aiSummary": "<string>",
"organisation": {
"isValid": {},
"createFromHexString": {},
"createFromTime": {},
"generate": {},
"cacheHexString": "<any>",
"prototype": "<string>"
},
"createdBy": {
"isValid": {},
"createFromHexString": {},
"createFromTime": {},
"generate": {},
"cacheHexString": "<any>",
"prototype": "<string>"
},
"pageFilterType": "is",
"frequencyDays": 123,
"frequency": "<string>",
"frequencyType": "<string>",
"format": "<string>",
"sent": true,
"sound": true,
"newTrigger": true,
"hidden": true,
"status": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"conditions": [
"<any>"
],
"targetAudience": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"name": "<string>",
"type": "<string>",
"_id": "<string>"
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Headers
Path Parameters
Body
application/json · any
The body is of type any
.
Response
200 - application/json
Ok
The response is of type object
.
curl --request PUT \
--url https://api.gleap.io/v3/engagement/news/{newsId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'project: <project>' \
--data '"<any>"'
{
"emailTemplate": {
"isValid": {},
"createFromHexString": {},
"createFromTime": {},
"generate": {},
"cacheHexString": "<any>",
"prototype": "<string>"
},
"sourceOutbound": {
"isValid": {},
"createFromHexString": {},
"createFromTime": {},
"generate": {},
"cacheHexString": "<any>",
"prototype": "<string>"
},
"trigger": "<any>",
"pageFilterDelay": 123,
"pageFilter": "<string>",
"eventTriggerDelay": 123,
"eventTrigger": "<string>",
"actionType": "<string>",
"sentAt": "2023-11-07T05:31:56Z",
"stats": "<any>",
"subject": "<any>",
"coverImageUrl": "<string>",
"sender": {
"isValid": {},
"createFromHexString": {},
"createFromTime": {},
"generate": {},
"cacheHexString": "<any>",
"prototype": "<string>"
},
"project": {
"isValid": {},
"createFromHexString": {},
"createFromTime": {},
"generate": {},
"cacheHexString": "<any>",
"prototype": "<string>"
},
"data": "<any>",
"config": "<any>",
"message": "<any>",
"aiSummaryOutdated": true,
"aiSummary": "<string>",
"organisation": {
"isValid": {},
"createFromHexString": {},
"createFromTime": {},
"generate": {},
"cacheHexString": "<any>",
"prototype": "<string>"
},
"createdBy": {
"isValid": {},
"createFromHexString": {},
"createFromTime": {},
"generate": {},
"cacheHexString": "<any>",
"prototype": "<string>"
},
"pageFilterType": "is",
"frequencyDays": 123,
"frequency": "<string>",
"frequencyType": "<string>",
"format": "<string>",
"sent": true,
"sound": true,
"newTrigger": true,
"hidden": true,
"status": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"conditions": [
"<any>"
],
"targetAudience": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"name": "<string>",
"type": "<string>",
"_id": "<string>"
}