Engagement News

Update a news article.

Changed on

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. searchContent is derived from subject (recomputed only when subject is sent) and ignored if supplied. News items always use a dynamic audience, so frequencyType: "fixed" and csvContacts are ignored unless the item already stores them.

put/engagement/news/{newsId}

Request

  • Base URL
    https://api.gleap.io/v3
  • URL
    https://api.gleap.io/v3/engagement/news/{newsId}
  • Auth
    HTTP bearer

Path parameters

newsIdstring required

Headers

projectstring required

Request body

unknown required

Response

Ok

unknown required

Changes

  • fd83cd1963c4Revision changes
    • info

      removed subschema #1 subschema #3 from the response body allOf list for the response status

  • d12d5ab961e5Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status