v4

OpenAPI 3.0.02026-07-31257282489.4 KB

Engagement News

Update a news article.

Update an engagement news article. Any pending (not yet sent) deliveries for this engagement are discarded and re-queued from the updated document. While an engagement is live, its audience, targeting and scheduling fields cannot be changed (for fixed frequency engagements neither can its content); pause it first or the request fails with 409. Setting status to live starts delivery. type, project, organisation and createdBy are set server-side and ignored if supplied.

put/engagement/news/{newsId}

Path parameters

newsIdstring required

Headers

projectstring required

Request body

{"stackTrail":"paths:/engagement/news/{newsId}:put:requestBody:content:application/json:schema","oasType":"schema","type":"unknown"}

Response

{"stackTrail":"paths:/engagement/news/{newsId}:put:responses:200:content:application/json:schema:allOf:properties:trigger","oasType":"schema","type":"unknown"}

pageFilterDelaynumber double

pageFilterstring

eventTriggerDelaynumber double

eventTriggerstring

actionTypestring

sentAtstring date-time

{"stackTrail":"paths:/engagement/news/{newsId}:put:responses:200:content:application/json:schema:allOf:properties:stats","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/engagement/news/{newsId}:put:responses:200:content:application/json:schema:allOf:properties:subject","oasType":"schema","type":"unknown"}

coverImageUrlstring

subTypestring

searchContentstring

{"stackTrail":"paths:/engagement/news/{newsId}:put:responses:200:content:application/json:schema:allOf:properties:data","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/engagement/news/{newsId}:put:responses:200:content:application/json:schema:allOf:properties:conditions","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/engagement/news/{newsId}:put:responses:200:content:application/json:schema:allOf:properties:config","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/engagement/news/{newsId}:put:responses:200:content:application/json:schema:allOf:properties:message","oasType":"schema","type":"unknown"}

aiSummaryOutdatedboolean

aiSummarystring

startSendingAfterstring date-time required

stopSendingAfterstring date-time required

frequencyDaysnumber double required

frequencystring required

frequencyTypestring required

sentboolean required

soundboolean required

newTriggerboolean required

formatstring required

updatedAtstring date-time required

statusstring required

targetAudiencestring required

createdAtstring date-time required

hiddenboolean required

tagsstring[] required

namestring required

typestring required

_idstring required