Sign in
scheduled-notifications

Update a scheduled notification

Update a scheduled notification. Only notifications with 'pending_approval' or 'rejected' status can be updated. After update, notification will require admin approval again. You can modify the title, body, scheduled time, target configuration, and other properties.

put/notifications/scheduled/{id}

Path parameters

idnumber required
Example:1

Notification ID

Request body

titlestring

Notification title

bodystring

Notification body

scheduledTimestring

Updated scheduled time (ISO 8601 format)

targetType'user' | 'users' | 'all_users' | 'tokens' | 'topic' | 'condition'

Updated target type

targetValueobject

Updated target value

dataobject

Updated custom data

imageUrlstring

Updated image URL

clickActionstring

Updated click action

timezonestring

Updated timezone

Example request

{
  "title": "Updated Title",
  "body": "Updated body text",
  "scheduledTime": "2025-12-25T15:00:00Z",
  "targetType": "topic",
  "data": {
    "campaignId": "456"
  },
  "imageUrl": "https://example.com/new-image.jpg",
  "clickAction": "OPEN_NEW_PAGE",
  "timezone": "America/New_York"
}

Response

Notification updated successfully

notification_idnumber required

Notification ID

titlestring required

Notification title

bodystring required

Notification body

scheduled_timestring date-time required

Scheduled time

timezonestring required

Timezone

target_type'user' | 'users' | 'all_users' | 'tokens' | 'topic' | 'condition' required

Target type

target_valueobject

Target value

status'pending_approval' | 'pending' | 'processing' | 'sent' | 'failed' | 'cancelled' | 'expired' | 'rejected' required

Current status

sent_atstring date-time

Sent timestamp

success_countnumber required

Number of successful sends

failure_countnumber required

Number of failed sends

error_messagestring

Error message if failed

created_atstring date-time required

Created timestamp

updated_atstring date-time required

Updated timestamp

Example response

{
  "notification_id": 1,
  "title": "Flash Sale Alert",
  "body": "Get 50% off!",
  "scheduled_time": "2025-12-25T10:00:00Z",
  "timezone": "Asia/Kuala_Lumpur",
  "target_type": "all_users",
  "status": "pending",
  "created_at": "2025-12-01T10:00:00Z",
  "updated_at": "2025-12-01T10:00:00Z"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.