Notification messages and subscriptions.
List notification campaigns
Lists authored notification campaigns, scoped to the requester's authority/tenant. Optional cinemaId/chainId narrow the list; they are enforced against the caller's authority.
query Parameters
pageperPagesortorderquerystatuscinemaIdchainIdList notification campaigns › Responses
Notification campaigns
Edit a notification campaign
Partially updates a draft or scheduled campaign — only the fields present in the request are changed. Re-checks the edited audience against the editor's authority. Returns the updated campaign.
path Parameters
notificationIdEdit a notification campaign › Responses
Campaign updated
Upload a notification-campaign image
Uploads a campaign push image to the CDN and returns its public URL for the campaign's imageUrl/secondaryImageUrl fields.
Upload a notification-campaign image › Request Body
fileImage file (png, jpeg, gif or webp; max 4MB)
Upload a notification-campaign image › Responses
Image uploaded
urlPublic CDN URL of the image
Resend a notification campaign
Duplicates a finished campaign (sent/partially failed/failed/canceled) into a new campaign and immediately queues it for dispatch. The source campaign is left untouched. Returns the new campaign.
path Parameters
notificationIdResend a notification campaign › Responses
Resend accepted (queued for fan-out)
Update a notification inbox item
Marks an inbox item read / received / clicked / deleted for the authenticated user.
path Parameters
notificationDeliveryIdUpdate a notification inbox item › Request Body
idchannelisReadisReceivedClientisClickedisDeletedcreatedDatetimetypeeventNamecontextpathsymboltitletextdataendpointadapterimageUrlsecondaryImageUrlscheduledDatetimemovieIdtargetTypetargetIdUpdate a notification inbox item › Responses
Notification delivery updated
Create a notification message
Creates a notification message. Returns the created notification message.
Create a notification message › Request Body
idtitlebodycreatedDatetimecineamoMovieIdDeprecated: the legacy Cineamo movie id. This endpoint is slated for removal and gains no numeric alternative.
movieIdDeprecated: despite the name this is the legacy Cineamo movie id, not a numeric movie id. This endpoint is slated for removal.
Create a notification message › Responses
NotificationMessage was created
idtitlebodycreatedDatetimecineamoMovieIdDeprecated: the legacy Cineamo movie id. This endpoint is slated for removal and gains no numeric alternative.
movieIdDeprecated: despite the name this is the legacy Cineamo movie id, not a numeric movie id. This endpoint is slated for removal.
Get a notification message
Returns the requested notification message.
path Parameters
notificationMessageIdGet a notification message › Responses
NotificationMessage details
idtitlebodycreatedDatetimecineamoMovieIdDeprecated: the legacy Cineamo movie id. This endpoint is slated for removal and gains no numeric alternative.
movieIdDeprecated: despite the name this is the legacy Cineamo movie id, not a numeric movie id. This endpoint is slated for removal.
Send notification message
Send NotificationMessage
path Parameters
notificationMessageIdSend notification message › Request Body
idtitlebodycreatedDatetimecineamoMovieIdDeprecated: the legacy Cineamo movie id. This endpoint is slated for removal and gains no numeric alternative.
movieIdDeprecated: despite the name this is the legacy Cineamo movie id, not a numeric movie id. This endpoint is slated for removal.
Send notification message › Responses
NotificationMessage was sent
idtitlebodycreatedDatetimecineamoMovieIdDeprecated: the legacy Cineamo movie id. This endpoint is slated for removal and gains no numeric alternative.
movieIdDeprecated: despite the name this is the legacy Cineamo movie id, not a numeric movie id. This endpoint is slated for removal.
Delete a notification subscription all
Unsubscribes a device from all topics. It returns the User object.
Delete a notification subscription all › Request Body
idusernamefirstNamelastNameprofileImageRefprofileImageUrlisActivatedisDeletedlastAccessTokenDatetimeDelete a notification subscription all › Responses
User was unsubscribed from all topics
idusernamefirstNamelastNameprofileImageRefprofileImageUrlisActivatedisDeletedlastAccessTokenDatetimeSet notification subscription cinema
Subscribes a device to a cinema topic, to get notifications about everything related to that topic. It returns the User object.
Set notification subscription cinema › Request Body
idusernamefirstNamelastNameprofileImageRefprofileImageUrlisActivatedisDeletedlastAccessTokenDatetimeSet notification subscription cinema › Responses
User was subscribed to a cinema topic
idusernamefirstNamelastNameprofileImageRefprofileImageUrlisActivatedisDeletedlastAccessTokenDatetimeSet notification subscription global
Subscribes a device to a global topic, to get notifications about everything related to that topic. It returns the User object.
Set notification subscription global › Request Body
idusernamefirstNamelastNameprofileImageRefprofileImageUrlisActivatedisDeletedlastAccessTokenDatetimeSet notification subscription global › Responses
User was subscribed to a global topic
idusernamefirstNamelastNameprofileImageRefprofileImageUrlisActivatedisDeletedlastAccessTokenDatetimeSet user notification subscription
Sets notification-subscription and device for user. It returns the User object.
path Parameters
userIdSet user notification subscription › Request Body
idusernamefirstNamelastNameprofileImageRefprofileImageUrlisActivatedisDeletedlastAccessTokenDatetimeSet user notification subscription › Responses
userNotificationSubscription was updated
idusernamefirstNamelastNameprofileImageRefprofileImageUrlisActivatedisDeletedlastAccessTokenDatetime
