Notifications

Server

Notification messages and subscriptions.

List notification messages

GET

https://api.cineamo.com

/notification-messages

Returns a list of notification messages objects.

List notification messages › Responses

200

A list of messages which exist to be send as a notification to users.

No data returned

Create a notification message

POST

https://api.cineamo.com

/notification-messages

Creates a notification message. Returns the created notification message.

Create a notification message › Request Body

NotificationMessage

id

integer | null · readOnly

title

string | null · readOnly

body

string | null · readOnly

readOnly

movieId

string | null · readOnly

createdDatetime

string | null · readOnly

Create a notification message › Responses

NotificationMessage was created

NotificationMessage

id

integer | null · readOnly

title

string | null · readOnly

body

string | null · readOnly

readOnly

movieId

string | null · readOnly

createdDatetime

string | null · readOnly

POST/notification-messages

curl https://api.cineamo.com/notification-messages \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 1,
  "title": "Some notification title",
  "body": "Some notification body",
  "cinema": {
    "id": 1,
    "name": "some cinema name",
    "shortName": "short name",
    "slug": "some-cinema-name",
    "description": "description",
    "phone": "012345678910",
    "street": "Some Street",
    "postalCode": "12345",
    "city": "Sim City",
    "state": "Some State",
    "stateAbbr": "SS",
    "country": "Germany",
    "countryCode": "DE",
    "currencyCode": "EUR",
    "longitude": "10.070198",
    "latitude": "49.778145",
    "distance": 0,
    "profileImageRef": "00000000-0000-0000-0000-000000000000",
    "profileImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-profile",
    "logoImageRef": "00000000-0000-0000-0000-000000000000",
    "logoImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-logo",
    "logoWideImageRef": "00000000-0000-0000-0000-000000000000",
    "logoWideImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-wide-logo",
    "priceTablePdfRef": "00000000-0000-0000-0000-000000000000",
    "priceTablePdfUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-price-table",
    "primaryColor": "primaryColor",
    "instagramLink": "instagramLink",
    "facebookLink": "facebookLink",
    "ticketSystemId": "ticketSystemId",
    "ticketSystem": "ticketSystem",
    "email": "some@email.com",
    "isActive": "true",
    "cinemaConfigurationId": 1,
    "cinemaConfiguration": {
      "id": 1,
      "minimalInitialEventVisitor": 0,
      "requestTimeoutAnswer": 0,
      "isCatering": "true",
      "ticketSystem": "ticketSystem",
      "ticketSystemId": "ticketSystemId",
      "ticketUrlTemplate": "ticketUrlTemplate",
      "facebookAccessToken": "facebookAccessToken",
      "hasMarketingAssistantBooked": "true",
      "visitorThreshold1": 0,
      "visitorThreshold2": 0,
      "isPublicRequestAvailable": "true",
      "isProgramSuggestionEnabled": "true",
      "isPrivateBookingEnabled": "true",
      "isActive": "true",
      "isPrivateBookingPartner": "true",
      "isOnlineTicketingAvailable": "true",
      "isOnlineTicketingEnabled": "true",
      "onlineTicketing": "{}",
      "isKOSCustomer": "true",
      "isInterestSystemActivated": "true",
      "isGiftCardRedemptionEnabled": "false",
      "isWebsiteCustomer": "true",
      "websiteConfiguration": "{}",
      "ticketUrlTemplateIosAppendix": "ticketUrlTemplateIosAppendix",
      "ticketUrlTemplateAndroidAppendix": "ticketUrlTemplateAndroidAppendix",
      "ticketUrlTemplateWebAppendix": "ticketUrlTemplateWebAppendix",
      "ticketUrlTemplateCinemaWebsiteAppendix": "ticketUrlTemplateCinemaWebsiteAppendix",
      "domain": "domain",
      "pulseTenantId": "pulseTenantId"
    },
    "showtimesUpdated": "showtimesUpdated",
    "isFavorite": "true",
    "hasMarketingAssistantBooked": "true",
    "cineamoTrailerConfirmedDatetime": "2022-04-11T04:11:22Z",
    "metricCustomersCount": 1,
    "metricCompareCustomersCount": 1,
    "metricCustomersTotalCount": 1,
    "cinemaChainId": 1,
    "cinemaCompanyId": 1,
    "cityId": 1,
    "openingHoursCustomText": {
      "deu": "German translation",
      "gsw": "Swiss German translation"
    }
  },
  "cineamoMovieId": "123m",
  "movieId": "123m",
  "createdDatetime": "2022-04-11T04:11:22Z"
}'

Example Request Body

{
  "id": 1,
  "title": "Some notification title",
  "body": "Some notification body",
  "cinema": {
    "id": 1,
    "name": "some cinema name",
    "shortName": "short name",
    "slug": "some-cinema-name",
    "description": "description",
    "phone": "012345678910",
    "street": "Some Street",
    "postalCode": "12345",
    "city": "Sim City",
    "state": "Some State",
    "stateAbbr": "SS",
    "country": "Germany",
    "countryCode": "DE",
    "currencyCode": "EUR",
    "longitude": "10.070198",
    "latitude": "49.778145",
    "distance": 0,
    "profileImageRef": "00000000-0000-0000-0000-000000000000",
    "profileImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-profile",
    "logoImageRef": "00000000-0000-0000-0000-000000000000",
    "logoImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-logo",
    "logoWideImageRef": "00000000-0000-0000-0000-000000000000",
    "logoWideImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-wide-logo",
    "priceTablePdfRef": "00000000-0000-0000-0000-000000000000",
    "priceTablePdfUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-price-table",
    "primaryColor": "primaryColor",
    "instagramLink": "instagramLink",
    "facebookLink": "facebookLink",
    "ticketSystemId": "ticketSystemId",
    "ticketSystem": "ticketSystem",
    "email": "some@email.com",
    "isActive": "true",
    "cinemaConfigurationId": 1,
    "cinemaConfiguration": {
      "id": 1,
      "minimalInitialEventVisitor": 0,
      "requestTimeoutAnswer": 0,
      "isCatering": "true",
      "ticketSystem": "ticketSystem",
      "ticketSystemId": "ticketSystemId",
      "ticketUrlTemplate": "ticketUrlTemplate",
      "facebookAccessToken": "facebookAccessToken",
      "hasMarketingAssistantBooked": "true",
      "visitorThreshold1": 0,
      "visitorThreshold2": 0,
      "isPublicRequestAvailable": "true",
      "isProgramSuggestionEnabled": "true",
      "isPrivateBookingEnabled": "true",
      "isActive": "true",
      "isPrivateBookingPartner": "true",
      "isOnlineTicketingAvailable": "true",
      "isOnlineTicketingEnabled": "true",
      "onlineTicketing": "{}",
      "isKOSCustomer": "true",
      "isInterestSystemActivated": "true",
      "isGiftCardRedemptionEnabled": "false",
      "isWebsiteCustomer": "true",
      "websiteConfiguration": "{}",
      "ticketUrlTemplateIosAppendix": "ticketUrlTemplateIosAppendix",
      "ticketUrlTemplateAndroidAppendix": "ticketUrlTemplateAndroidAppendix",
      "ticketUrlTemplateWebAppendix": "ticketUrlTemplateWebAppendix",
      "ticketUrlTemplateCinemaWebsiteAppendix": "ticketUrlTemplateCinemaWebsiteAppendix",
      "domain": "domain",
      "pulseTenantId": "pulseTenantId"
    },
    "showtimesUpdated": "showtimesUpdated",
    "isFavorite": "true",
    "hasMarketingAssistantBooked": "true",
    "cineamoTrailerConfirmedDatetime": "2022-04-11T04:11:22Z",
    "metricCustomersCount": 1,
    "metricCompareCustomersCount": 1,
    "metricCustomersTotalCount": 1,
    "cinemaChainId": 1,
    "cinemaCompanyId": 1,
    "cityId": 1,
    "openingHoursCustomText": {
      "deu": "German translation",
      "gsw": "Swiss German translation"
    }
  },
  "cineamoMovieId": "123m",
  "movieId": "123m",
  "createdDatetime": "2022-04-11T04:11:22Z"
}

json

Example Responses

{
  "id": 1,
  "title": "Some notification title",
  "body": "Some notification body",
  "cinema": {
    "id": 1,
    "name": "some cinema name",
    "shortName": "short name",
    "slug": "some-cinema-name",
    "description": "description",
    "phone": "012345678910",
    "street": "Some Street",
    "postalCode": "12345",
    "city": "Sim City",
    "state": "Some State",
    "stateAbbr": "SS",
    "country": "Germany",
    "countryCode": "DE",
    "currencyCode": "EUR",
    "longitude": "10.070198",
    "latitude": "49.778145",
    "distance": 0,
    "profileImageRef": "00000000-0000-0000-0000-000000000000",
    "profileImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-profile",
    "logoImageRef": "00000000-0000-0000-0000-000000000000",
    "logoImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-logo",
    "logoWideImageRef": "00000000-0000-0000-0000-000000000000",
    "logoWideImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-wide-logo",
    "priceTablePdfRef": "00000000-0000-0000-0000-000000000000",
    "priceTablePdfUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-price-table",
    "primaryColor": "primaryColor",
    "instagramLink": "instagramLink",
    "facebookLink": "facebookLink",
    "ticketSystemId": "ticketSystemId",
    "ticketSystem": "ticketSystem",
    "email": "some@email.com",
    "isActive": "true",
    "cinemaConfigurationId": 1,
    "cinemaConfiguration": {
      "id": 1,
      "minimalInitialEventVisitor": 0,
      "requestTimeoutAnswer": 0,
      "isCatering": "true",
      "ticketSystem": "ticketSystem",
      "ticketSystemId": "ticketSystemId",
      "ticketUrlTemplate": "ticketUrlTemplate",
      "facebookAccessToken": "facebookAccessToken",
      "hasMarketingAssistantBooked": "true",
      "visitorThreshold1": 0,
      "visitorThreshold2": 0,
      "isPublicRequestAvailable": "true",
      "isProgramSuggestionEnabled": "true",
      "isPrivateBookingEnabled": "true",
      "isActive": "true",
      "isPrivateBookingPartner": "true",
      "isOnlineTicketingAvailable": "true",
      "isOnlineTicketingEnabled": "true",
      "onlineTicketing": "{}",
      "isKOSCustomer": "true",
      "isInterestSystemActivated": "true",
      "isGiftCardRedemptionEnabled": "false",
      "isWebsiteCustomer": "true",
      "websiteConfiguration": "{}",
      "ticketUrlTemplateIosAppendix": "ticketUrlTemplateIosAppendix",
      "ticketUrlTemplateAndroidAppendix": "ticketUrlTemplateAndroidAppendix",
      "ticketUrlTemplateWebAppendix": "ticketUrlTemplateWebAppendix",
      "ticketUrlTemplateCinemaWebsiteAppendix": "ticketUrlTemplateCinemaWebsiteAppendix",
      "domain": "domain",
      "pulseTenantId": "pulseTenantId"
    },
    "showtimesUpdated": "showtimesUpdated",
    "isFavorite": "true",
    "hasMarketingAssistantBooked": "true",
    "cineamoTrailerConfirmedDatetime": "2022-04-11T04:11:22Z",
    "metricCustomersCount": 1,
    "metricCompareCustomersCount": 1,
    "metricCustomersTotalCount": 1,
    "cinemaChainId": 1,
    "cinemaCompanyId": 1,
    "cityId": 1,
    "openingHoursCustomText": {
      "deu": "German translation",
      "gsw": "Swiss German translation"
    }
  },
  "cineamoMovieId": "123m",
  "movieId": "123m",
  "createdDatetime": "2022-04-11T04:11:22Z"
}

json

application/json

Send marketing assistant notification message

PATCH

https://api.cineamo.com

/notification-messages/marketing-assistant-demo/{userId}/send

Send MA NotificationMessage to User

Send marketing assistant notification message › path Parameters

userId

integer · required

Send marketing assistant notification message › Request Body optional

generatePersonalizedMessage

boolean

Default: false

Send marketing assistant notification message › Responses

MA NotificationMessage was sent

No data returned

Get a notification message

GET

https://api.cineamo.com

/notification-messages/{notificationMessageId}

Returns the requested notification message.

Get a notification message › path Parameters

notificationMessageId

string · required

Get a notification message › Responses

NotificationMessage details

NotificationMessage

id

integer | null · readOnly

title

string | null · readOnly

body

string | null · readOnly

readOnly

movieId

string | null · readOnly

createdDatetime

string | null · readOnly

GET/notification-messages/{notificationMessageId}

curl https://api.cineamo.com/notification-messages/:notificationMessageId

Example Responses

{
  "id": 1,
  "title": "Some notification title",
  "body": "Some notification body",
  "cinema": {
    "id": 1,
    "name": "some cinema name",
    "shortName": "short name",
    "slug": "some-cinema-name",
    "description": "description",
    "phone": "012345678910",
    "street": "Some Street",
    "postalCode": "12345",
    "city": "Sim City",
    "state": "Some State",
    "stateAbbr": "SS",
    "country": "Germany",
    "countryCode": "DE",
    "currencyCode": "EUR",
    "longitude": "10.070198",
    "latitude": "49.778145",
    "distance": 0,
    "profileImageRef": "00000000-0000-0000-0000-000000000000",
    "profileImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-profile",
    "logoImageRef": "00000000-0000-0000-0000-000000000000",
    "logoImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-logo",
    "logoWideImageRef": "00000000-0000-0000-0000-000000000000",
    "logoWideImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-wide-logo",
    "priceTablePdfRef": "00000000-0000-0000-0000-000000000000",
    "priceTablePdfUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-price-table",
    "primaryColor": "primaryColor",
    "instagramLink": "instagramLink",
    "facebookLink": "facebookLink",
    "ticketSystemId": "ticketSystemId",
    "ticketSystem": "ticketSystem",
    "email": "some@email.com",
    "isActive": "true",
    "cinemaConfigurationId": 1,
    "cinemaConfiguration": {
      "id": 1,
      "minimalInitialEventVisitor": 0,
      "requestTimeoutAnswer": 0,
      "isCatering": "true",
      "ticketSystem": "ticketSystem",
      "ticketSystemId": "ticketSystemId",
      "ticketUrlTemplate": "ticketUrlTemplate",
      "facebookAccessToken": "facebookAccessToken",
      "hasMarketingAssistantBooked": "true",
      "visitorThreshold1": 0,
      "visitorThreshold2": 0,
      "isPublicRequestAvailable": "true",
      "isProgramSuggestionEnabled": "true",
      "isPrivateBookingEnabled": "true",
      "isActive": "true",
      "isPrivateBookingPartner": "true",
      "isOnlineTicketingAvailable": "true",
      "isOnlineTicketingEnabled": "true",
      "onlineTicketing": "{}",
      "isKOSCustomer": "true",
      "isInterestSystemActivated": "true",
      "isGiftCardRedemptionEnabled": "false",
      "isWebsiteCustomer": "true",
      "websiteConfiguration": "{}",
      "ticketUrlTemplateIosAppendix": "ticketUrlTemplateIosAppendix",
      "ticketUrlTemplateAndroidAppendix": "ticketUrlTemplateAndroidAppendix",
      "ticketUrlTemplateWebAppendix": "ticketUrlTemplateWebAppendix",
      "ticketUrlTemplateCinemaWebsiteAppendix": "ticketUrlTemplateCinemaWebsiteAppendix",
      "domain": "domain",
      "pulseTenantId": "pulseTenantId"
    },
    "showtimesUpdated": "showtimesUpdated",
    "isFavorite": "true",
    "hasMarketingAssistantBooked": "true",
    "cineamoTrailerConfirmedDatetime": "2022-04-11T04:11:22Z",
    "metricCustomersCount": 1,
    "metricCompareCustomersCount": 1,
    "metricCustomersTotalCount": 1,
    "cinemaChainId": 1,
    "cinemaCompanyId": 1,
    "cityId": 1,
    "openingHoursCustomText": {
      "deu": "German translation",
      "gsw": "Swiss German translation"
    }
  },
  "cineamoMovieId": "123m",
  "movieId": "123m",
  "createdDatetime": "2022-04-11T04:11:22Z"
}

json

application/json

Send notification message

PATCH

https://api.cineamo.com

/notification-messages/{notificationMessageId}/send

Send NotificationMessage

Send notification message › path Parameters

notificationMessageId

string · required

Send notification message › Request Body

NotificationMessage

id

integer | null · readOnly

title

string | null · readOnly

body

string | null · readOnly

readOnly

movieId

string | null · readOnly

createdDatetime

string | null · readOnly

Send notification message › Responses

NotificationMessage was sent

NotificationMessage

id

integer | null · readOnly

title

string | null · readOnly

body

string | null · readOnly

readOnly

movieId

string | null · readOnly

createdDatetime

string | null · readOnly

PATCH/notification-messages/{notificationMessageId}/send

curl https://api.cineamo.com/notification-messages/:notificationMessageId/send \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 1,
  "title": "Some notification title",
  "body": "Some notification body",
  "cinema": {
    "id": 1,
    "name": "some cinema name",
    "shortName": "short name",
    "slug": "some-cinema-name",
    "description": "description",
    "phone": "012345678910",
    "street": "Some Street",
    "postalCode": "12345",
    "city": "Sim City",
    "state": "Some State",
    "stateAbbr": "SS",
    "country": "Germany",
    "countryCode": "DE",
    "currencyCode": "EUR",
    "longitude": "10.070198",
    "latitude": "49.778145",
    "distance": 0,
    "profileImageRef": "00000000-0000-0000-0000-000000000000",
    "profileImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-profile",
    "logoImageRef": "00000000-0000-0000-0000-000000000000",
    "logoImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-logo",
    "logoWideImageRef": "00000000-0000-0000-0000-000000000000",
    "logoWideImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-wide-logo",
    "priceTablePdfRef": "00000000-0000-0000-0000-000000000000",
    "priceTablePdfUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-price-table",
    "primaryColor": "primaryColor",
    "instagramLink": "instagramLink",
    "facebookLink": "facebookLink",
    "ticketSystemId": "ticketSystemId",
    "ticketSystem": "ticketSystem",
    "email": "some@email.com",
    "isActive": "true",
    "cinemaConfigurationId": 1,
    "cinemaConfiguration": {
      "id": 1,
      "minimalInitialEventVisitor": 0,
      "requestTimeoutAnswer": 0,
      "isCatering": "true",
      "ticketSystem": "ticketSystem",
      "ticketSystemId": "ticketSystemId",
      "ticketUrlTemplate": "ticketUrlTemplate",
      "facebookAccessToken": "facebookAccessToken",
      "hasMarketingAssistantBooked": "true",
      "visitorThreshold1": 0,
      "visitorThreshold2": 0,
      "isPublicRequestAvailable": "true",
      "isProgramSuggestionEnabled": "true",
      "isPrivateBookingEnabled": "true",
      "isActive": "true",
      "isPrivateBookingPartner": "true",
      "isOnlineTicketingAvailable": "true",
      "isOnlineTicketingEnabled": "true",
      "onlineTicketing": "{}",
      "isKOSCustomer": "true",
      "isInterestSystemActivated": "true",
      "isGiftCardRedemptionEnabled": "false",
      "isWebsiteCustomer": "true",
      "websiteConfiguration": "{}",
      "ticketUrlTemplateIosAppendix": "ticketUrlTemplateIosAppendix",
      "ticketUrlTemplateAndroidAppendix": "ticketUrlTemplateAndroidAppendix",
      "ticketUrlTemplateWebAppendix": "ticketUrlTemplateWebAppendix",
      "ticketUrlTemplateCinemaWebsiteAppendix": "ticketUrlTemplateCinemaWebsiteAppendix",
      "domain": "domain",
      "pulseTenantId": "pulseTenantId"
    },
    "showtimesUpdated": "showtimesUpdated",
    "isFavorite": "true",
    "hasMarketingAssistantBooked": "true",
    "cineamoTrailerConfirmedDatetime": "2022-04-11T04:11:22Z",
    "metricCustomersCount": 1,
    "metricCompareCustomersCount": 1,
    "metricCustomersTotalCount": 1,
    "cinemaChainId": 1,
    "cinemaCompanyId": 1,
    "cityId": 1,
    "openingHoursCustomText": {
      "deu": "German translation",
      "gsw": "Swiss German translation"
    }
  },
  "cineamoMovieId": "123m",
  "movieId": "123m",
  "createdDatetime": "2022-04-11T04:11:22Z"
}'

Example Request Body

{
  "id": 1,
  "title": "Some notification title",
  "body": "Some notification body",
  "cinema": {
    "id": 1,
    "name": "some cinema name",
    "shortName": "short name",
    "slug": "some-cinema-name",
    "description": "description",
    "phone": "012345678910",
    "street": "Some Street",
    "postalCode": "12345",
    "city": "Sim City",
    "state": "Some State",
    "stateAbbr": "SS",
    "country": "Germany",
    "countryCode": "DE",
    "currencyCode": "EUR",
    "longitude": "10.070198",
    "latitude": "49.778145",
    "distance": 0,
    "profileImageRef": "00000000-0000-0000-0000-000000000000",
    "profileImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-profile",
    "logoImageRef": "00000000-0000-0000-0000-000000000000",
    "logoImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-logo",
    "logoWideImageRef": "00000000-0000-0000-0000-000000000000",
    "logoWideImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-wide-logo",
    "priceTablePdfRef": "00000000-0000-0000-0000-000000000000",
    "priceTablePdfUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-price-table",
    "primaryColor": "primaryColor",
    "instagramLink": "instagramLink",
    "facebookLink": "facebookLink",
    "ticketSystemId": "ticketSystemId",
    "ticketSystem": "ticketSystem",
    "email": "some@email.com",
    "isActive": "true",
    "cinemaConfigurationId": 1,
    "cinemaConfiguration": {
      "id": 1,
      "minimalInitialEventVisitor": 0,
      "requestTimeoutAnswer": 0,
      "isCatering": "true",
      "ticketSystem": "ticketSystem",
      "ticketSystemId": "ticketSystemId",
      "ticketUrlTemplate": "ticketUrlTemplate",
      "facebookAccessToken": "facebookAccessToken",
      "hasMarketingAssistantBooked": "true",
      "visitorThreshold1": 0,
      "visitorThreshold2": 0,
      "isPublicRequestAvailable": "true",
      "isProgramSuggestionEnabled": "true",
      "isPrivateBookingEnabled": "true",
      "isActive": "true",
      "isPrivateBookingPartner": "true",
      "isOnlineTicketingAvailable": "true",
      "isOnlineTicketingEnabled": "true",
      "onlineTicketing": "{}",
      "isKOSCustomer": "true",
      "isInterestSystemActivated": "true",
      "isGiftCardRedemptionEnabled": "false",
      "isWebsiteCustomer": "true",
      "websiteConfiguration": "{}",
      "ticketUrlTemplateIosAppendix": "ticketUrlTemplateIosAppendix",
      "ticketUrlTemplateAndroidAppendix": "ticketUrlTemplateAndroidAppendix",
      "ticketUrlTemplateWebAppendix": "ticketUrlTemplateWebAppendix",
      "ticketUrlTemplateCinemaWebsiteAppendix": "ticketUrlTemplateCinemaWebsiteAppendix",
      "domain": "domain",
      "pulseTenantId": "pulseTenantId"
    },
    "showtimesUpdated": "showtimesUpdated",
    "isFavorite": "true",
    "hasMarketingAssistantBooked": "true",
    "cineamoTrailerConfirmedDatetime": "2022-04-11T04:11:22Z",
    "metricCustomersCount": 1,
    "metricCompareCustomersCount": 1,
    "metricCustomersTotalCount": 1,
    "cinemaChainId": 1,
    "cinemaCompanyId": 1,
    "cityId": 1,
    "openingHoursCustomText": {
      "deu": "German translation",
      "gsw": "Swiss German translation"
    }
  },
  "cineamoMovieId": "123m",
  "movieId": "123m",
  "createdDatetime": "2022-04-11T04:11:22Z"
}

json

Example Responses

{
  "id": 1,
  "title": "Some notification title",
  "body": "Some notification body",
  "cinema": {
    "id": 1,
    "name": "some cinema name",
    "shortName": "short name",
    "slug": "some-cinema-name",
    "description": "description",
    "phone": "012345678910",
    "street": "Some Street",
    "postalCode": "12345",
    "city": "Sim City",
    "state": "Some State",
    "stateAbbr": "SS",
    "country": "Germany",
    "countryCode": "DE",
    "currencyCode": "EUR",
    "longitude": "10.070198",
    "latitude": "49.778145",
    "distance": 0,
    "profileImageRef": "00000000-0000-0000-0000-000000000000",
    "profileImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-profile",
    "logoImageRef": "00000000-0000-0000-0000-000000000000",
    "logoImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-logo",
    "logoWideImageRef": "00000000-0000-0000-0000-000000000000",
    "logoWideImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-wide-logo",
    "priceTablePdfRef": "00000000-0000-0000-0000-000000000000",
    "priceTablePdfUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-price-table",
    "primaryColor": "primaryColor",
    "instagramLink": "instagramLink",
    "facebookLink": "facebookLink",
    "ticketSystemId": "ticketSystemId",
    "ticketSystem": "ticketSystem",
    "email": "some@email.com",
    "isActive": "true",
    "cinemaConfigurationId": 1,
    "cinemaConfiguration": {
      "id": 1,
      "minimalInitialEventVisitor": 0,
      "requestTimeoutAnswer": 0,
      "isCatering": "true",
      "ticketSystem": "ticketSystem",
      "ticketSystemId": "ticketSystemId",
      "ticketUrlTemplate": "ticketUrlTemplate",
      "facebookAccessToken": "facebookAccessToken",
      "hasMarketingAssistantBooked": "true",
      "visitorThreshold1": 0,
      "visitorThreshold2": 0,
      "isPublicRequestAvailable": "true",
      "isProgramSuggestionEnabled": "true",
      "isPrivateBookingEnabled": "true",
      "isActive": "true",
      "isPrivateBookingPartner": "true",
      "isOnlineTicketingAvailable": "true",
      "isOnlineTicketingEnabled": "true",
      "onlineTicketing": "{}",
      "isKOSCustomer": "true",
      "isInterestSystemActivated": "true",
      "isGiftCardRedemptionEnabled": "false",
      "isWebsiteCustomer": "true",
      "websiteConfiguration": "{}",
      "ticketUrlTemplateIosAppendix": "ticketUrlTemplateIosAppendix",
      "ticketUrlTemplateAndroidAppendix": "ticketUrlTemplateAndroidAppendix",
      "ticketUrlTemplateWebAppendix": "ticketUrlTemplateWebAppendix",
      "ticketUrlTemplateCinemaWebsiteAppendix": "ticketUrlTemplateCinemaWebsiteAppendix",
      "domain": "domain",
      "pulseTenantId": "pulseTenantId"
    },
    "showtimesUpdated": "showtimesUpdated",
    "isFavorite": "true",
    "hasMarketingAssistantBooked": "true",
    "cineamoTrailerConfirmedDatetime": "2022-04-11T04:11:22Z",
    "metricCustomersCount": 1,
    "metricCompareCustomersCount": 1,
    "metricCustomersTotalCount": 1,
    "cinemaChainId": 1,
    "cinemaCompanyId": 1,
    "cityId": 1,
    "openingHoursCustomText": {
      "deu": "German translation",
      "gsw": "Swiss German translation"
    }
  },
  "cineamoMovieId": "123m",
  "movieId": "123m",
  "createdDatetime": "2022-04-11T04:11:22Z"
}

json

application/json

Delete a notification subscription all

DELETE

https://api.cineamo.com

/notification-subscription-all

Unsubscribes a device from all topics. It returns the User object.

Delete a notification subscription all › Request Body

User

id

integer | null · readOnly

username

string | null · readOnly

firstName

string | null · readOnly

lastName

string | null · readOnly

profileImageRef

string | null · readOnly

profileImageUrl

string | null · readOnly

isActivated

boolean | null · readOnly

isDeleted

boolean | null · readOnly

lastAccessTokenDatetime

string | null · readOnly

Delete a notification subscription all › Responses

User was unsubscribed from all topics

User

id

integer | null · readOnly

username

string | null · readOnly

firstName

string | null · readOnly

lastName

string | null · readOnly

profileImageRef

string | null · readOnly

profileImageUrl

string | null · readOnly

isActivated

boolean | null · readOnly

isDeleted

boolean | null · readOnly

lastAccessTokenDatetime

string | null · readOnly

DELETE/notification-subscription-all

curl https://api.cineamo.com/notification-subscription-all \
  --request DELETE \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 123,
  "username": "i_am_batman",
  "firstName": "Frank",
  "lastName": "Pentangeli",
  "profileImageRef": "00000000-0000-0000-0000-000000000000",
  "profileImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/user-profile",
  "isActivated": true,
  "isDeleted": "true",
  "lastAccessTokenDatetime": "2022-04-11T04:11:22Z"
}'

Example Request Body

{
  "id": 123,
  "username": "i_am_batman",
  "firstName": "Frank",
  "lastName": "Pentangeli",
  "profileImageRef": "00000000-0000-0000-0000-000000000000",
  "profileImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/user-profile",
  "isActivated": true,
  "isDeleted": "true",
  "lastAccessTokenDatetime": "2022-04-11T04:11:22Z"
}

json

Example Responses

{
  "id": 123,
  "username": "i_am_batman",
  "firstName": "Frank",
  "lastName": "Pentangeli",
  "profileImageRef": "00000000-0000-0000-0000-000000000000",
  "profileImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/user-profile",
  "isActivated": true,
  "isDeleted": "true",
  "lastAccessTokenDatetime": "2022-04-11T04:11:22Z"
}

json

application/json

Set notification subscription cinema

PUT

https://api.cineamo.com

/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

User

id

integer | null · readOnly

username

string | null · readOnly

firstName

string | null · readOnly

lastName

string | null · readOnly

profileImageRef

string | null · readOnly

profileImageUrl

string | null · readOnly

isActivated

boolean | null · readOnly

isDeleted

boolean | null · readOnly

lastAccessTokenDatetime

string | null · readOnly

Set notification subscription cinema › Responses

User was subscribed to a cinema topic

User

id

integer | null · readOnly

username

string | null · readOnly

firstName

string | null · readOnly

lastName

string | null · readOnly

profileImageRef

string | null · readOnly

profileImageUrl

string | null · readOnly

isActivated

boolean | null · readOnly

isDeleted

boolean | null · readOnly

lastAccessTokenDatetime

string | null · readOnly

PUT/notification-subscription-cinema

curl https://api.cineamo.com/notification-subscription-cinema \
  --request PUT \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 123,
  "username": "i_am_batman",
  "firstName": "Frank",
  "lastName": "Pentangeli",
  "profileImageRef": "00000000-0000-0000-0000-000000000000",
  "profileImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/user-profile",
  "isActivated": true,
  "isDeleted": "true",
  "lastAccessTokenDatetime": "2022-04-11T04:11:22Z"
}'

Example Request Body

{
  "id": 123,
  "username": "i_am_batman",
  "firstName": "Frank",
  "lastName": "Pentangeli",
  "profileImageRef": "00000000-0000-0000-0000-000000000000",
  "profileImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/user-profile",
  "isActivated": true,
  "isDeleted": "true",
  "lastAccessTokenDatetime": "2022-04-11T04:11:22Z"
}

json

Example Responses

{
  "id": 123,
  "username": "i_am_batman",
  "firstName": "Frank",
  "lastName": "Pentangeli",
  "profileImageRef": "00000000-0000-0000-0000-000000000000",
  "profileImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/user-profile",
  "isActivated": true,
  "isDeleted": "true",
  "lastAccessTokenDatetime": "2022-04-11T04:11:22Z"
}

json

application/json

Set notification subscription global

PUT

https://api.cineamo.com

/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

User

id

integer | null · readOnly

username

string | null · readOnly

firstName

string | null · readOnly

lastName

string | null · readOnly

profileImageRef

string | null · readOnly

profileImageUrl

string | null · readOnly

isActivated

boolean | null · readOnly

isDeleted

boolean | null · readOnly

lastAccessTokenDatetime

string | null · readOnly

Set notification subscription global › Responses

User was subscribed to a global topic

User

id

integer | null · readOnly

username

string | null · readOnly

firstName

string | null · readOnly

lastName

string | null · readOnly

profileImageRef

string | null · readOnly

profileImageUrl

string | null · readOnly

isActivated

boolean | null · readOnly

isDeleted

boolean | null · readOnly

lastAccessTokenDatetime

string | null · readOnly

PUT/notification-subscription-global

curl https://api.cineamo.com/notification-subscription-global \
  --request PUT \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 123,
  "username": "i_am_batman",
  "firstName": "Frank",
  "lastName": "Pentangeli",
  "profileImageRef": "00000000-0000-0000-0000-000000000000",
  "profileImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/user-profile",
  "isActivated": true,
  "isDeleted": "true",
  "lastAccessTokenDatetime": "2022-04-11T04:11:22Z"
}'

Example Request Body

{
  "id": 123,
  "username": "i_am_batman",
  "firstName": "Frank",
  "lastName": "Pentangeli",
  "profileImageRef": "00000000-0000-0000-0000-000000000000",
  "profileImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/user-profile",
  "isActivated": true,
  "isDeleted": "true",
  "lastAccessTokenDatetime": "2022-04-11T04:11:22Z"
}

json

Example Responses

{
  "id": 123,
  "username": "i_am_batman",
  "firstName": "Frank",
  "lastName": "Pentangeli",
  "profileImageRef": "00000000-0000-0000-0000-000000000000",
  "profileImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/user-profile",
  "isActivated": true,
  "isDeleted": "true",
  "lastAccessTokenDatetime": "2022-04-11T04:11:22Z"
}

json

application/json

Set user notification subscription

PUT

https://api.cineamo.com

/messaging-device-subscription

Sets notification-subscription and device for user. It returns the User object.

Set user notification subscription › path Parameters

userId

integer · required

Set user notification subscription › Request Body

User

id

integer | null · readOnly

username

string | null · readOnly

firstName

string | null · readOnly

lastName

string | null · readOnly

profileImageRef

string | null · readOnly

profileImageUrl

string | null · readOnly

isActivated

boolean | null · readOnly

isDeleted

boolean | null · readOnly

lastAccessTokenDatetime

string | null · readOnly

Set user notification subscription › Responses

userNotificationSubscription was updated

User

id

integer | null · readOnly

username

string | null · readOnly

firstName

string | null · readOnly

lastName

string | null · readOnly

profileImageRef

string | null · readOnly

profileImageUrl

string | null · readOnly

isActivated

boolean | null · readOnly

isDeleted

boolean | null · readOnly

lastAccessTokenDatetime

string | null · readOnly

PUT/messaging-device-subscription

curl https://api.cineamo.com/messaging-device-subscription \
  --request PUT \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 123,
  "username": "i_am_batman",
  "firstName": "Frank",
  "lastName": "Pentangeli",
  "profileImageRef": "00000000-0000-0000-0000-000000000000",
  "profileImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/user-profile",
  "isActivated": true,
  "isDeleted": "true",
  "lastAccessTokenDatetime": "2022-04-11T04:11:22Z"
}'

Example Request Body

{
  "id": 123,
  "username": "i_am_batman",
  "firstName": "Frank",
  "lastName": "Pentangeli",
  "profileImageRef": "00000000-0000-0000-0000-000000000000",
  "profileImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/user-profile",
  "isActivated": true,
  "isDeleted": "true",
  "lastAccessTokenDatetime": "2022-04-11T04:11:22Z"
}

json

Example Responses

{
  "id": 123,
  "username": "i_am_batman",
  "firstName": "Frank",
  "lastName": "Pentangeli",
  "profileImageRef": "00000000-0000-0000-0000-000000000000",
  "profileImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/user-profile",
  "isActivated": true,
  "isDeleted": "true",
  "lastAccessTokenDatetime": "2022-04-11T04:11:22Z"
}

json

application/json

Newsletter Age Ratings