Push

Update a push campaign

Changed on

Updates a draft or scheduled push campaign. Only the fields you pass change; content fields merge over the stored content. A scheduled campaign keeps its schedule and cannot be cleared to empty content. Requires the campaigns:write scope.

patch/push/campaigns/{campaignId}

Request

  • Base URL
    https://api.sequenzy.com/api/v1
  • URL
    https://api.sequenzy.com/api/v1/push/campaigns/{campaignId}
  • Auth
    HTTP bearer

Path parameters

campaignIdstring required

Push campaign ID.

Request body

namestring
targetListsobject

Audience, same shape as campaign targetLists.

titlestring

Notification title. Merge tags such as {{FIRST_NAME|there}} are supported.

bodystring

Notification message. Merge tags are supported.

urlstring nullable

Link opened on tap. An https URL, an app deep link (myapp://...), or a merge tag. Browsers only open https links. null clears it.

imageUrlstring nullable

Optional https image shown in the notification.

iconUrlstring nullable

Optional https icon for web push. Defaults to the workspace icon.

platformsstring[]

Limit delivery to these platforms. Omit or pass an empty array for every platform.

Example request

{
  "title": "Your order shipped",
  "body": "Tap to track your delivery.",
  "url": "https://shop.example.com/orders"
}

Response

Campaign updated

successboolean

Example response

{
  "success": true,
  "campaign": {
    "content": {
      "title": "Your order shipped",
      "body": "Tap to track your delivery.",
      "url": "https://shop.example.com/orders"
    }
  }
}

Changes