Live Notifications

End a live notification

End a running activity, referenced by its instance_id. On iOS, the system dismisses the activity from the Lock Screen. On Android, the SDK normally renders the final content as a non-ongoing notification; it cancels the notification only when there's no final notification to render. You can include a final content_state to show before the activity ends.

push_payload is optional on the end call, whether Customer.io delivers directly through APNs or relays through Firebase Cloud Messaging (FCM). If you include a push_payload.alert, it must contain both a title and a body.

post/v1/live_notifications/end

Request body

instance_idstring required

The activity's instance ID (ULID), returned when you started it.

attributesobject

Static activity fields, for renderers that need them alongside the content state.

deep_linkstring

A link to open when the person taps the activity.

Response

The end event was queued.

instance_idstring

The activity's instance ID.

Changes

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