Cinemas

id

integer · readOnly · required

name

string · readOnly · required

description

string · readOnly · required

phone

string · readOnly · required

street

string · readOnly · required

postalCode

string · readOnly · required

city

string · readOnly · required

state

string · readOnly · required

stateAbbr

string · readOnly · required

country

string · readOnly · required

countryCode

string · readOnly · required

currencyCode

string · readOnly · required

longitude

number | null · float · readOnly · required

latitude

number | null · float · readOnly · required

email

string | null · readOnly · required

isActive

boolean · readOnly · required

shortName

string | null · readOnly

slug

string | null · readOnly

distance

integer | null · readOnly

(in meters)

profileImageRef

string | null · readOnly

profileImageUrl

string | null · readOnly

logoImageRef

string | null · readOnly

logoImageUrl

string | null · readOnly

logoWideImageRef

string | null · readOnly

logoWideImageUrl

string | null · readOnly

priceTablePdfRef

string | null · readOnly

priceTablePdfUrl

string | null · readOnly

primaryColor

string | null · readOnly

instagramLink

string | null · readOnly

facebookLink

string | null · readOnly

ticketSystemId

string | null · readOnly

ticketSystem

string | null · readOnly

cinemaConfigurationId

integer | null · readOnly

readOnly

showtimesUpdated

string | null · readOnly

isFavorite

boolean | null · readOnly

cineamoTrailerConfirmedDatetime

string | null · readOnly

metricCustomersCount

integer | null · readOnly

metricCompareCustomersCount

integer | null · readOnly

metricCustomersTotalCount

integer | null · readOnly

cinemaChainId

integer | null · readOnly

cinemaCompanyId

integer | null · readOnly

cityId

integer | null · readOnly

openingHoursCustomText

array | null · readOnly

GET/cinemas

curl https://api.cineamo.com/cinemas

Example Responses

[
  {
    "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"
    }
  }
]

application/json

Create a cinema

POST

https://api.cineamo.com

/cinemas

Creates a cinema. Returns the created cinema.

Create a cinema › Request Body

id

integer · readOnly · required

name

string · readOnly · required

description

string · readOnly · required

phone

string · readOnly · required

street

string · readOnly · required

postalCode

string · readOnly · required

city

string · readOnly · required

state

string · readOnly · required

stateAbbr

string · readOnly · required

country

string · readOnly · required

countryCode

string · readOnly · required

currencyCode

string · readOnly · required

longitude

number | null · float · readOnly · required

latitude

number | null · float · readOnly · required

email

string | null · readOnly · required

isActive

boolean · readOnly · required

shortName

string | null · readOnly

slug

string | null · readOnly

distance

integer | null · readOnly

(in meters)

profileImageRef

string | null · readOnly

profileImageUrl

string | null · readOnly

logoImageRef

string | null · readOnly

logoImageUrl

string | null · readOnly

logoWideImageRef

string | null · readOnly

logoWideImageUrl

string | null · readOnly

priceTablePdfRef

string | null · readOnly

priceTablePdfUrl

string | null · readOnly

primaryColor

string | null · readOnly

instagramLink

string | null · readOnly

facebookLink

string | null · readOnly

ticketSystemId

string | null · readOnly

ticketSystem

string | null · readOnly

cinemaConfigurationId

integer | null · readOnly

readOnly

showtimesUpdated

string | null · readOnly

isFavorite

boolean | null · readOnly

cineamoTrailerConfirmedDatetime

string | null · readOnly

metricCustomersCount

integer | null · readOnly

metricCompareCustomersCount

integer | null · readOnly

metricCustomersTotalCount

integer | null · readOnly

cinemaChainId

integer | null · readOnly

cinemaCompanyId

integer | null · readOnly

cityId

integer | null · readOnly

openingHoursCustomText

array | null · readOnly

Create a cinema › Responses

Cinema was created

id

integer · readOnly · required

name

string · readOnly · required

description

string · readOnly · required

phone

string · readOnly · required

street

string · readOnly · required

postalCode

string · readOnly · required

city

string · readOnly · required

state

string · readOnly · required

stateAbbr

string · readOnly · required

country

string · readOnly · required

countryCode

string · readOnly · required

currencyCode

string · readOnly · required

longitude

number | null · float · readOnly · required

latitude

number | null · float · readOnly · required

email

string | null · readOnly · required

isActive

boolean · readOnly · required

shortName

string | null · readOnly

slug

string | null · readOnly

distance

integer | null · readOnly

(in meters)

profileImageRef

string | null · readOnly

profileImageUrl

string | null · readOnly

logoImageRef

string | null · readOnly

logoImageUrl

string | null · readOnly

logoWideImageRef

string | null · readOnly

logoWideImageUrl

string | null · readOnly

priceTablePdfRef

string | null · readOnly

priceTablePdfUrl

string | null · readOnly

primaryColor

string | null · readOnly

instagramLink

string | null · readOnly

facebookLink

string | null · readOnly

ticketSystemId

string | null · readOnly

ticketSystem

string | null · readOnly

cinemaConfigurationId

integer | null · readOnly

readOnly

showtimesUpdated

string | null · readOnly

isFavorite

boolean | null · readOnly

cineamoTrailerConfirmedDatetime

string | null · readOnly

metricCustomersCount

integer | null · readOnly

metricCompareCustomersCount

integer | null · readOnly

metricCustomersTotalCount

integer | null · readOnly

cinemaChainId

integer | null · readOnly

cinemaCompanyId

integer | null · readOnly

cityId

integer | null · readOnly

openingHoursCustomText

array | null · readOnly

POST/cinemas

curl https://api.cineamo.com/cinemas \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "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"
  }
}'

Example Request Body

{
  "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"
  }
}

Example Responses

{
  "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"
  }
}

application/json

Set cinema cinema distinction

PUT

https://api.cineamo.com

/cinemas/{cinemaId}/distinctions/{distinctionId}

Creates or updates a CinemaDistinction relationship between a cinema and distinction.

Set cinema cinema distinction › path Parameters

cinemaId

integer · required

distinctionId

integer · required

Set cinema cinema distinction › Request Body

CinemaDistinction

id

integer · readOnly

createdDatetime

string | null · readOnly

readOnly

position

integer | null

Set cinema cinema distinction › Responses

Cinema distinction has been updated

CinemaDistinction

id

integer · readOnly

createdDatetime

string | null · readOnly

readOnly

position

integer | null

PUT/cinemas/{cinemaId}/distinctions/{distinctionId}

curl https://api.cineamo.com/cinemas/:cinemaId/distinctions/:distinctionId \
  --request PUT \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 1,
  "createdDatetime": "2022-04-11T04:11:22Z",
  "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"
    }
  },
  "distinction": {
    "id": 1,
    "name": "Gold Standard",
    "description": "Premium cinema quality certification",
    "imageRef": "00000000-0000-0000-0000-000000000000",
    "imageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/distinction-logo"
  },
  "position": 1
}'

Example Request Body

{
  "id": 1,
  "createdDatetime": "2022-04-11T04:11:22Z",
  "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"
    }
  },
  "distinction": {
    "id": 1,
    "name": "Gold Standard",
    "description": "Premium cinema quality certification",
    "imageRef": "00000000-0000-0000-0000-000000000000",
    "imageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/distinction-logo"
  },
  "position": 1
}

Example Responses

{
  "id": 1,
  "createdDatetime": "2022-04-11T04:11:22Z",
  "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"
    }
  },
  "distinction": {
    "id": 1,
    "name": "Gold Standard",
    "description": "Premium cinema quality certification",
    "imageRef": "00000000-0000-0000-0000-000000000000",
    "imageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/distinction-logo"
  },
  "position": 1
}

application/json

Delete a cinema distinction

DELETE

https://api.cineamo.com

/cinemas/{cinemaId}/distinctions/{distinctionId}

Deletes a cinema distinction. It returns a response code but no response data.

Delete a cinema distinction › path Parameters

cinemaId

integer · required

distinctionId

integer · required

Delete a cinema distinction › Responses

Cinema distinction was deleted

No data returned

DELETE/cinemas/{cinemaId}/distinctions/{distinctionId}

curl https://api.cineamo.com/cinemas/:cinemaId/distinctions/:distinctionId \
  --request DELETE

Example Responses

No example specified for this content type

List cinema cinema distinctions

GET

https://api.cineamo.com

/cinemas/{cinemaId}/cinema-distinctions

Returns a list of CinemaDistinction objects for a cinema.

List cinema cinema distinctions › path Parameters

cinemaId

integer · required

List cinema cinema distinctions › query Parameters

page

integer

perPage

integer

sort

string

order

string

List cinema cinema distinctions › Responses

CinemaDistinction list

CinemaDistinction

id

integer · readOnly

createdDatetime

string | null · readOnly

readOnly

position

integer | null

GET/cinemas/{cinemaId}/cinema-distinctions

curl https://api.cineamo.com/cinemas/:cinemaId/cinema-distinctions

Example Responses

{
  "id": 1,
  "createdDatetime": "2022-04-11T04:11:22Z",
  "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"
    }
  },
  "distinction": {
    "id": 1,
    "name": "Gold Standard",
    "description": "Premium cinema quality certification",
    "imageRef": "00000000-0000-0000-0000-000000000000",
    "imageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/distinction-logo"
  },
  "position": 1
}

application/json

Create a cinema featured content

POST

https://api.cineamo.com

/cinemas/{cinemaId}/featured-contents

Creates a featured content entry for a cinema.

Create a cinema featured content › path Parameters

cinemaId

integer · required

Create a cinema featured content › Request Body

id

integer · readOnly

createdDatetime

string | null · readOnly

readOnly

highlightText

string | null

desktopImageRef

string | null · uuid

mobileImageRef

string | null · uuid

activeFromDatetime

string | null · date-time

activeUntilDatetime

string | null · date-time

showFeatureBadge

boolean

featureBadge

string | null

showButton

boolean

buttonTitle

string | null

reason

string | null

highlightColor

string | null

link

string | null

position

integer | null

Create a cinema featured content › Responses

Cinema featured content has been created

id

integer · readOnly

createdDatetime

string | null · readOnly

readOnly

highlightText

string | null

desktopImageRef

string | null · uuid

mobileImageRef

string | null · uuid

activeFromDatetime

string | null · date-time

activeUntilDatetime

string | null · date-time

showFeatureBadge

boolean

featureBadge

string | null

showButton

boolean

buttonTitle

string | null

reason

string | null

highlightColor

string | null

link

string | null

position

integer | null

POST/cinemas/{cinemaId}/featured-contents

curl https://api.cineamo.com/cinemas/:cinemaId/featured-contents \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 1,
  "createdDatetime": "2022-04-11T04:11:22Z",
  "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"
    }
  },
  "content": {
    "id": 1,
    "name": "some content name",
    "slug": "some-content-name",
    "category": "movie_series",
    "description": "description",
    "isOwnContent": true,
    "duration": 160,
    "creatorCinemaId": 1,
    "posterImageRef": "00000000-0000-0000-0000-000000000000",
    "posterImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/content-profile",
    "backdropImageRef": "00000000-0000-0000-0000-000000000000",
    "backdropImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/content-backdrop",
    "ageRating": "18",
    "trailerUrl": "https://example.com/trailer.mp4",
    "isRegularEvent": true,
    "hasMarketingAssistantBooked": true,
    "futureShowingsCount": 5,
    "premiereDate": "2022-04-11T04:11:22Z",
    "movie": {
      "id": 1,
      "tmdbId": 1,
      "cineamoId": "155m",
      "title": "Some Movie Title",
      "lastUpdated": 0,
      "isTmdbSyncSkipped": true,
      "series": true,
      "selectedByCinema": true,
      "adult": true,
      "backdropPath": "backdropPath",
      "genres": [
        {
          "id": 0,
          "name": "name"
        }
      ],
      "homepage": "homepage",
      "imdbId": "imdbId",
      "originalLanguage": "originalLanguage",
      "originalTitle": "Some Original Title",
      "overview": "Some movie overview...",
      "popularity": 0,
      "posterPath": "posterPath",
      "productionCompanies": [
        {
          "name": "name",
          "id": 0,
          "logoPath": "logoPath",
          "originCountry": "originCountry"
        }
      ],
      "productionCountries": [
        {}
      ],
      "releaseDate": "releaseDate",
      "revenue": 0,
      "runtime": 0,
      "firstAirDate": "firstAirDate",
      "status": "status",
      "tagline": "tagline",
      "video": true,
      "voteAverage": 0,
      "voteCount": 0,
      "alternativeTitles": {},
      "credits": {},
      "images": {},
      "videos": {
        "id": 0,
        "results": [
          "string"
        ]
      },
      "translations": {
        "id": 0,
        "translations": 0
      },
      "similar": {
        "page": 0,
        "totalPages": 0,
        "totalResults": 0,
        "results": [
          "string"
        ]
      },
      "releaseDates": {
        "id": 0,
        "results": [
          "string"
        ]
      },
      "noRightsAvailable": true,
      "noRightsTimestamp": 0,
      "thirdParties": {
        "moviePilot": {
          "voteAverage": 0,
          "link": "link",
          "voteCount": 0
        }
      },
      "slug": "some-slug",
      "rentrakTitle": 0,
      "movieAccessibility": {
        "id": 1,
        "movieId": 1,
        "iso31661": "DE",
        "gretaMovieId": "abc123",
        "hasClosedCaption": false,
        "hasAudioDescription": false,
        "hasSoundAmplification": false
      }
    },
    "movieId": 123,
    "metrics": {
      "messagesCount": 0,
      "clickedMessagesCount": 0,
      "ticketPurchaseIntentsCount": 0
    }
  },
  "highlightText": "Summer blockbuster",
  "desktopImageRef": "00000000-0000-0000-0000-000000000000",
  "mobileImageRef": "00000000-0000-0000-0000-000000000000",
  "activeFromDatetime": "2024-08-25T15:00:00Z",
  "activeUntilDatetime": "2024-08-25T15:00:00Z",
  "showFeatureBadge": false,
  "featureBadge": "Vorverkauf",
  "showButton": false,
  "buttonTitle": "Tickets sichern",
  "reason": "pre_sale",
  "highlightColor": "#467c9c",
  "link": "https://example.com/tickets",
  "position": 0
}'

Example Request Body

{
  "id": 1,
  "createdDatetime": "2022-04-11T04:11:22Z",
  "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"
    }
  },
  "content": {
    "id": 1,
    "name": "some content name",
    "slug": "some-content-name",
    "category": "movie_series",
    "description": "description",
    "isOwnContent": true,
    "duration": 160,
    "creatorCinemaId": 1,
    "posterImageRef": "00000000-0000-0000-0000-000000000000",
    "posterImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/content-profile",
    "backdropImageRef": "00000000-0000-0000-0000-000000000000",
    "backdropImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/content-backdrop",
    "ageRating": "18",
    "trailerUrl": "https://example.com/trailer.mp4",
    "isRegularEvent": true,
    "hasMarketingAssistantBooked": true,
    "futureShowingsCount": 5,
    "premiereDate": "2022-04-11T04:11:22Z",
    "movie": {
      "id": 1,
      "tmdbId": 1,
      "cineamoId": "155m",
      "title": "Some Movie Title",
      "lastUpdated": 0,
      "isTmdbSyncSkipped": true,
      "series": true,
      "selectedByCinema": true,
      "adult": true,
      "backdropPath": "backdropPath",
      "genres": [
        {
          "id": 0,
          "name": "name"
        }
      ],
      "homepage": "homepage",
      "imdbId": "imdbId",
      "originalLanguage": "originalLanguage",
      "originalTitle": "Some Original Title",
      "overview": "Some movie overview...",
      "popularity": 0,
      "posterPath": "posterPath",
      "productionCompanies": [
        {
          "name": "name",
          "id": 0,
          "logoPath": "logoPath",
          "originCountry": "originCountry"
        }
      ],
      "productionCountries": [
        {}
      ],
      "releaseDate": "releaseDate",
      "revenue": 0,
      "runtime": 0,
      "firstAirDate": "firstAirDate",
      "status": "status",
      "tagline": "tagline",
      "video": true,
      "voteAverage": 0,
      "voteCount": 0,
      "alternativeTitles": {},
      "credits": {},
      "images": {},
      "videos": {
        "id": 0,
        "results": [
          "string"
        ]
      },
      "translations": {
        "id": 0,
        "translations": 0
      },
      "similar": {
        "page": 0,
        "totalPages": 0,
        "totalResults": 0,
        "results": [
          "string"
        ]
      },
      "releaseDates": {
        "id": 0,
        "results": [
          "string"
        ]
      },
      "noRightsAvailable": true,
      "noRightsTimestamp": 0,
      "thirdParties": {
        "moviePilot": {
          "voteAverage": 0,
          "link": "link",
          "voteCount": 0
        }
      },
      "slug": "some-slug",
      "rentrakTitle": 0,
      "movieAccessibility": {
        "id": 1,
        "movieId": 1,
        "iso31661": "DE",
        "gretaMovieId": "abc123",
        "hasClosedCaption": false,
        "hasAudioDescription": false,
        "hasSoundAmplification": false
      }
    },
    "movieId": 123,
    "metrics": {
      "messagesCount": 0,
      "clickedMessagesCount": 0,
      "ticketPurchaseIntentsCount": 0
    }
  },
  "highlightText": "Summer blockbuster",
  "desktopImageRef": "00000000-0000-0000-0000-000000000000",
  "mobileImageRef": "00000000-0000-0000-0000-000000000000",
  "activeFromDatetime": "2024-08-25T15:00:00Z",
  "activeUntilDatetime": "2024-08-25T15:00:00Z",
  "showFeatureBadge": false,
  "featureBadge": "Vorverkauf",
  "showButton": false,
  "buttonTitle": "Tickets sichern",
  "reason": "pre_sale",
  "highlightColor": "#467c9c",
  "link": "https://example.com/tickets",
  "position": 0
}

Example Responses

{
  "id": 1,
  "createdDatetime": "2022-04-11T04:11:22Z",
  "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"
    }
  },
  "content": {
    "id": 1,
    "name": "some content name",
    "slug": "some-content-name",
    "category": "movie_series",
    "description": "description",
    "isOwnContent": true,
    "duration": 160,
    "creatorCinemaId": 1,
    "posterImageRef": "00000000-0000-0000-0000-000000000000",
    "posterImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/content-profile",
    "backdropImageRef": "00000000-0000-0000-0000-000000000000",
    "backdropImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/content-backdrop",
    "ageRating": "18",
    "trailerUrl": "https://example.com/trailer.mp4",
    "isRegularEvent": true,
    "hasMarketingAssistantBooked": true,
    "futureShowingsCount": 5,
    "premiereDate": "2022-04-11T04:11:22Z",
    "movie": {
      "id": 1,
      "tmdbId": 1,
      "cineamoId": "155m",
      "title": "Some Movie Title",
      "lastUpdated": 0,
      "isTmdbSyncSkipped": true,
      "series": true,
      "selectedByCinema": true,
      "adult": true,
      "backdropPath": "backdropPath",
      "genres": [
        {
          "id": 0,
          "name": "name"
        }
      ],
      "homepage": "homepage",
      "imdbId": "imdbId",
      "originalLanguage": "originalLanguage",
      "originalTitle": "Some Original Title",
      "overview": "Some movie overview...",
      "popularity": 0,
      "posterPath": "posterPath",
      "productionCompanies": [
        {
          "name": "name",
          "id": 0,
          "logoPath": "logoPath",
          "originCountry": "originCountry"
        }
      ],
      "productionCountries": [
        {}
      ],
      "releaseDate": "releaseDate",
      "revenue": 0,
      "runtime": 0,
      "firstAirDate": "firstAirDate",
      "status": "status",
      "tagline": "tagline",
      "video": true,
      "voteAverage": 0,
      "voteCount": 0,
      "alternativeTitles": {},
      "credits": {},
      "images": {},
      "videos": {
        "id": 0,
        "results": [
          "string"
        ]
      },
      "translations": {
        "id": 0,
        "translations": 0
      },
      "similar": {
        "page": 0,
        "totalPages": 0,
        "totalResults": 0,
        "results": [
          "string"
        ]
      },
      "releaseDates": {
        "id": 0,
        "results": [
          "string"
        ]
      },
      "noRightsAvailable": true,
      "noRightsTimestamp": 0,
      "thirdParties": {
        "moviePilot": {
          "voteAverage": 0,
          "link": "link",
          "voteCount": 0
        }
      },
      "slug": "some-slug",
      "rentrakTitle": 0,
      "movieAccessibility": {
        "id": 1,
        "movieId": 1,
        "iso31661": "DE",
        "gretaMovieId": "abc123",
        "hasClosedCaption": false,
        "hasAudioDescription": false,
        "hasSoundAmplification": false
      }
    },
    "movieId": 123,
    "metrics": {
      "messagesCount": 0,
      "clickedMessagesCount": 0,
      "ticketPurchaseIntentsCount": 0
    }
  },
  "highlightText": "Summer blockbuster",
  "desktopImageRef": "00000000-0000-0000-0000-000000000000",
  "mobileImageRef": "00000000-0000-0000-0000-000000000000",
  "activeFromDatetime": "2024-08-25T15:00:00Z",
  "activeUntilDatetime": "2024-08-25T15:00:00Z",
  "showFeatureBadge": false,
  "featureBadge": "Vorverkauf",
  "showButton": false,
  "buttonTitle": "Tickets sichern",
  "reason": "pre_sale",
  "highlightColor": "#467c9c",
  "link": "https://example.com/tickets",
  "position": 0
}

application/json

Delete a cinema featured content

DELETE

https://api.cineamo.com

/cinemas/{cinemaId}/featured-contents/{cinemaFeaturedContentId}

Deletes a cinema featured content. It returns a response code but no response data.

Delete a cinema featured content › path Parameters

cinemaId

integer · required

cinemaFeaturedContentId

integer · required

Delete a cinema featured content › Responses

Cinema featured content was deleted

No data returned

DELETE/cinemas/{cinemaId}/featured-contents/{cinemaFeaturedContentId}

curl https://api.cineamo.com/cinemas/:cinemaId/featured-contents/:cinemaFeaturedContentId \
  --request DELETE

Example Responses

No example specified for this content type

Update a cinema featured content

PATCH

https://api.cineamo.com

/cinemas/{cinemaId}/featured-contents/{cinemaFeaturedContentId}

Partially updates a featured content entry. Only the provided fields are changed.

Update a cinema featured content › path Parameters

cinemaId

integer · required

cinemaFeaturedContentId

integer · required

Update a cinema featured content › Request Body

id

integer · readOnly

createdDatetime

string | null · readOnly

readOnly

highlightText

string | null

desktopImageRef

string | null · uuid

mobileImageRef

string | null · uuid

activeFromDatetime

string | null · date-time

activeUntilDatetime

string | null · date-time

showFeatureBadge

boolean

featureBadge

string | null

showButton

boolean

buttonTitle

string | null

reason

string | null

highlightColor

string | null

link

string | null

position

integer | null

Update a cinema featured content › Responses

200

Cinema featured content has been updated

id

integer · readOnly

createdDatetime

string | null · readOnly

readOnly

highlightText

string | null

desktopImageRef

string | null · uuid

mobileImageRef

string | null · uuid

activeFromDatetime

string | null · date-time

activeUntilDatetime

string | null · date-time

showFeatureBadge

boolean

featureBadge

string | null

showButton

boolean

buttonTitle

string | null

reason

string | null

highlightColor

string | null

link

string | null

position

integer | null

PATCH/cinemas/{cinemaId}/featured-contents/{cinemaFeaturedContentId}

curl https://api.cineamo.com/cinemas/:cinemaId/featured-contents/:cinemaFeaturedContentId \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 1,
  "createdDatetime": "2022-04-11T04:11:22Z",
  "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"
    }
  },
  "content": {
    "id": 1,
    "name": "some content name",
    "slug": "some-content-name",
    "category": "movie_series",
    "description": "description",
    "isOwnContent": true,
    "duration": 160,
    "creatorCinemaId": 1,
    "posterImageRef": "00000000-0000-0000-0000-000000000000",
    "posterImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/content-profile",
    "backdropImageRef": "00000000-0000-0000-0000-000000000000",
    "backdropImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/content-backdrop",
    "ageRating": "18",
    "trailerUrl": "https://example.com/trailer.mp4",
    "isRegularEvent": true,
    "hasMarketingAssistantBooked": true,
    "futureShowingsCount": 5,
    "premiereDate": "2022-04-11T04:11:22Z",
    "movie": {
      "id": 1,
      "tmdbId": 1,
      "cineamoId": "155m",
      "title": "Some Movie Title",
      "lastUpdated": 0,
      "isTmdbSyncSkipped": true,
      "series": true,
      "selectedByCinema": true,
      "adult": true,
      "backdropPath": "backdropPath",
      "genres": [
        {
          "id": 0,
          "name": "name"
        }
      ],
      "homepage": "homepage",
      "imdbId": "imdbId",
      "originalLanguage": "originalLanguage",
      "originalTitle": "Some Original Title",
      "overview": "Some movie overview...",
      "popularity": 0,
      "posterPath": "posterPath",
      "productionCompanies": [
        {
          "name": "name",
          "id": 0,
          "logoPath": "logoPath",
          "originCountry": "originCountry"
        }
      ],
      "productionCountries": [
        {}
      ],
      "releaseDate": "releaseDate",
      "revenue": 0,
      "runtime": 0,
      "firstAirDate": "firstAirDate",
      "status": "status",
      "tagline": "tagline",
      "video": true,
      "voteAverage": 0,
      "voteCount": 0,
      "alternativeTitles": {},
      "credits": {},
      "images": {},
      "videos": {
        "id": 0,
        "results": [
          "string"
        ]
      },
      "translations": {
        "id": 0,
        "translations": 0
      },
      "similar": {
        "page": 0,
        "totalPages": 0,
        "totalResults": 0,
        "results": [
          "string"
        ]
      },
      "releaseDates": {
        "id": 0,
        "results": [
          "string"
        ]
      },
      "noRightsAvailable": true,
      "noRightsTimestamp": 0,
      "thirdParties": {
        "moviePilot": {
          "voteAverage": 0,
          "link": "link",
          "voteCount": 0
        }
      },
      "slug": "some-slug",
      "rentrakTitle": 0,
      "movieAccessibility": {
        "id": 1,
        "movieId": 1,
        "iso31661": "DE",
        "gretaMovieId": "abc123",
        "hasClosedCaption": false,
        "hasAudioDescription": false,
        "hasSoundAmplification": false
      }
    },
    "movieId": 123,
    "metrics": {
      "messagesCount": 0,
      "clickedMessagesCount": 0,
      "ticketPurchaseIntentsCount": 0
    }
  },
  "highlightText": "Summer blockbuster",
  "desktopImageRef": "00000000-0000-0000-0000-000000000000",
  "mobileImageRef": "00000000-0000-0000-0000-000000000000",
  "activeFromDatetime": "2024-08-25T15:00:00Z",
  "activeUntilDatetime": "2024-08-25T15:00:00Z",
  "showFeatureBadge": false,
  "featureBadge": "Vorverkauf",
  "showButton": false,
  "buttonTitle": "Tickets sichern",
  "reason": "pre_sale",
  "highlightColor": "#467c9c",
  "link": "https://example.com/tickets",
  "position": 0
}'

Example Request Body

{
  "id": 1,
  "createdDatetime": "2022-04-11T04:11:22Z",
  "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"
    }
  },
  "content": {
    "id": 1,
    "name": "some content name",
    "slug": "some-content-name",
    "category": "movie_series",
    "description": "description",
    "isOwnContent": true,
    "duration": 160,
    "creatorCinemaId": 1,
    "posterImageRef": "00000000-0000-0000-0000-000000000000",
    "posterImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/content-profile",
    "backdropImageRef": "00000000-0000-0000-0000-000000000000",
    "backdropImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/content-backdrop",
    "ageRating": "18",
    "trailerUrl": "https://example.com/trailer.mp4",
    "isRegularEvent": true,
    "hasMarketingAssistantBooked": true,
    "futureShowingsCount": 5,
    "premiereDate": "2022-04-11T04:11:22Z",
    "movie": {
      "id": 1,
      "tmdbId": 1,
      "cineamoId": "155m",
      "title": "Some Movie Title",
      "lastUpdated": 0,
      "isTmdbSyncSkipped": true,
      "series": true,
      "selectedByCinema": true,
      "adult": true,
      "backdropPath": "backdropPath",
      "genres": [
        {
          "id": 0,
          "name": "name"
        }
      ],
      "homepage": "homepage",
      "imdbId": "imdbId",
      "originalLanguage": "originalLanguage",
      "originalTitle": "Some Original Title",
      "overview": "Some movie overview...",
      "popularity": 0,
      "posterPath": "posterPath",
      "productionCompanies": [
        {
          "name": "name",
          "id": 0,
          "logoPath": "logoPath",
          "originCountry": "originCountry"
        }
      ],
      "productionCountries": [
        {}
      ],
      "releaseDate": "releaseDate",
      "revenue": 0,
      "runtime": 0,
      "firstAirDate": "firstAirDate",
      "status": "status",
      "tagline": "tagline",
      "video": true,
      "voteAverage": 0,
      "voteCount": 0,
      "alternativeTitles": {},
      "credits": {},
      "images": {},
      "videos": {
        "id": 0,
        "results": [
          "string"
        ]
      },
      "translations": {
        "id": 0,
        "translations": 0
      },
      "similar": {
        "page": 0,
        "totalPages": 0,
        "totalResults": 0,
        "results": [
          "string"
        ]
      },
      "releaseDates": {
        "id": 0,
        "results": [
          "string"
        ]
      },
      "noRightsAvailable": true,
      "noRightsTimestamp": 0,
      "thirdParties": {
        "moviePilot": {
          "voteAverage": 0,
          "link": "link",
          "voteCount": 0
        }
      },
      "slug": "some-slug",
      "rentrakTitle": 0,
      "movieAccessibility": {
        "id": 1,
        "movieId": 1,
        "iso31661": "DE",
        "gretaMovieId": "abc123",
        "hasClosedCaption": false,
        "hasAudioDescription": false,
        "hasSoundAmplification": false
      }
    },
    "movieId": 123,
    "metrics": {
      "messagesCount": 0,
      "clickedMessagesCount": 0,
      "ticketPurchaseIntentsCount": 0
    }
  },
  "highlightText": "Summer blockbuster",
  "desktopImageRef": "00000000-0000-0000-0000-000000000000",
  "mobileImageRef": "00000000-0000-0000-0000-000000000000",
  "activeFromDatetime": "2024-08-25T15:00:00Z",
  "activeUntilDatetime": "2024-08-25T15:00:00Z",
  "showFeatureBadge": false,
  "featureBadge": "Vorverkauf",
  "showButton": false,
  "buttonTitle": "Tickets sichern",
  "reason": "pre_sale",
  "highlightColor": "#467c9c",
  "link": "https://example.com/tickets",
  "position": 0
}

Example Responses

{
  "id": 1,
  "createdDatetime": "2022-04-11T04:11:22Z",
  "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"
    }
  },
  "content": {
    "id": 1,
    "name": "some content name",
    "slug": "some-content-name",
    "category": "movie_series",
    "description": "description",
    "isOwnContent": true,
    "duration": 160,
    "creatorCinemaId": 1,
    "posterImageRef": "00000000-0000-0000-0000-000000000000",
    "posterImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/content-profile",
    "backdropImageRef": "00000000-0000-0000-0000-000000000000",
    "backdropImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/content-backdrop",
    "ageRating": "18",
    "trailerUrl": "https://example.com/trailer.mp4",
    "isRegularEvent": true,
    "hasMarketingAssistantBooked": true,
    "futureShowingsCount": 5,
    "premiereDate": "2022-04-11T04:11:22Z",
    "movie": {
      "id": 1,
      "tmdbId": 1,
      "cineamoId": "155m",
      "title": "Some Movie Title",
      "lastUpdated": 0,
      "isTmdbSyncSkipped": true,
      "series": true,
      "selectedByCinema": true,
      "adult": true,
      "backdropPath": "backdropPath",
      "genres": [
        {
          "id": 0,
          "name": "name"
        }
      ],
      "homepage": "homepage",
      "imdbId": "imdbId",
      "originalLanguage": "originalLanguage",
      "originalTitle": "Some Original Title",
      "overview": "Some movie overview...",
      "popularity": 0,
      "posterPath": "posterPath",
      "productionCompanies": [
        {
          "name": "name",
          "id": 0,
          "logoPath": "logoPath",
          "originCountry": "originCountry"
        }
      ],
      "productionCountries": [
        {}
      ],
      "releaseDate": "releaseDate",
      "revenue": 0,
      "runtime": 0,
      "firstAirDate": "firstAirDate",
      "status": "status",
      "tagline": "tagline",
      "video": true,
      "voteAverage": 0,
      "voteCount": 0,
      "alternativeTitles": {},
      "credits": {},
      "images": {},
      "videos": {
        "id": 0,
        "results": [
          "string"
        ]
      },
      "translations": {
        "id": 0,
        "translations": 0
      },
      "similar": {
        "page": 0,
        "totalPages": 0,
        "totalResults": 0,
        "results": [
          "string"
        ]
      },
      "releaseDates": {
        "id": 0,
        "results": [
          "string"
        ]
      },
      "noRightsAvailable": true,
      "noRightsTimestamp": 0,
      "thirdParties": {
        "moviePilot": {
          "voteAverage": 0,
          "link": "link",
          "voteCount": 0
        }
      },
      "slug": "some-slug",
      "rentrakTitle": 0,
      "movieAccessibility": {
        "id": 1,
        "movieId": 1,
        "iso31661": "DE",
        "gretaMovieId": "abc123",
        "hasClosedCaption": false,
        "hasAudioDescription": false,
        "hasSoundAmplification": false
      }
    },
    "movieId": 123,
    "metrics": {
      "messagesCount": 0,
      "clickedMessagesCount": 0,
      "ticketPurchaseIntentsCount": 0
    }
  },
  "highlightText": "Summer blockbuster",
  "desktopImageRef": "00000000-0000-0000-0000-000000000000",
  "mobileImageRef": "00000000-0000-0000-0000-000000000000",
  "activeFromDatetime": "2024-08-25T15:00:00Z",
  "activeUntilDatetime": "2024-08-25T15:00:00Z",
  "showFeatureBadge": false,
  "featureBadge": "Vorverkauf",
  "showButton": false,
  "buttonTitle": "Tickets sichern",
  "reason": "pre_sale",
  "highlightColor": "#467c9c",
  "link": "https://example.com/tickets",
  "position": 0
}

application/json

List cinema featured contents

GET

https://api.cineamo.com

/cinemas/{cinemaId}/cinema-featured-contents

Returns a list of CinemaFeaturedContent objects.

List cinema featured contents › query Parameters

page

integer

perPage

integer

sort

string

order

string

activeDatetime

string · date-time

List cinema featured contents › Responses

CinemaFeaturedContent list

id

integer · readOnly

createdDatetime

string | null · readOnly

readOnly

highlightText

string | null

desktopImageRef

string | null · uuid

mobileImageRef

string | null · uuid

activeFromDatetime

string | null · date-time

activeUntilDatetime

string | null · date-time

showFeatureBadge

boolean

featureBadge

string | null

showButton

boolean

buttonTitle

string | null

reason

string | null

highlightColor

string | null

link

string | null

position

integer | null

GET/cinemas/{cinemaId}/cinema-featured-contents

curl https://api.cineamo.com/cinemas/:cinemaId/cinema-featured-contents

Example Responses

{
  "id": 1,
  "createdDatetime": "2022-04-11T04:11:22Z",
  "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"
    }
  },
  "content": {
    "id": 1,
    "name": "some content name",
    "slug": "some-content-name",
    "category": "movie_series",
    "description": "description",
    "isOwnContent": true,
    "duration": 160,
    "creatorCinemaId": 1,
    "posterImageRef": "00000000-0000-0000-0000-000000000000",
    "posterImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/content-profile",
    "backdropImageRef": "00000000-0000-0000-0000-000000000000",
    "backdropImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/content-backdrop",
    "ageRating": "18",
    "trailerUrl": "https://example.com/trailer.mp4",
    "isRegularEvent": true,
    "hasMarketingAssistantBooked": true,
    "futureShowingsCount": 5,
    "premiereDate": "2022-04-11T04:11:22Z",
    "movie": {
      "id": 1,
      "tmdbId": 1,
      "cineamoId": "155m",
      "title": "Some Movie Title",
      "lastUpdated": 0,
      "isTmdbSyncSkipped": true,
      "series": true,
      "selectedByCinema": true,
      "adult": true,
      "backdropPath": "backdropPath",
      "genres": [
        {
          "id": 0,
          "name": "name"
        }
      ],
      "homepage": "homepage",
      "imdbId": "imdbId",
      "originalLanguage": "originalLanguage",
      "originalTitle": "Some Original Title",
      "overview": "Some movie overview...",
      "popularity": 0,
      "posterPath": "posterPath",
      "productionCompanies": [
        {
          "name": "name",
          "id": 0,
          "logoPath": "logoPath",
          "originCountry": "originCountry"
        }
      ],
      "productionCountries": [
        {}
      ],
      "releaseDate": "releaseDate",
      "revenue": 0,
      "runtime": 0,
      "firstAirDate": "firstAirDate",
      "status": "status",
      "tagline": "tagline",
      "video": true,
      "voteAverage": 0,
      "voteCount": 0,
      "alternativeTitles": {},
      "credits": {},
      "images": {},
      "videos": {
        "id": 0,
        "results": [
          "string"
        ]
      },
      "translations": {
        "id": 0,
        "translations": 0
      },
      "similar": {
        "page": 0,
        "totalPages": 0,
        "totalResults": 0,
        "results": [
          "string"
        ]
      },
      "releaseDates": {
        "id": 0,
        "results": [
          "string"
        ]
      },
      "noRightsAvailable": true,
      "noRightsTimestamp": 0,
      "thirdParties": {
        "moviePilot": {
          "voteAverage": 0,
          "link": "link",
          "voteCount": 0
        }
      },
      "slug": "some-slug",
      "rentrakTitle": 0,
      "movieAccessibility": {
        "id": 1,
        "movieId": 1,
        "iso31661": "DE",
        "gretaMovieId": "abc123",
        "hasClosedCaption": false,
        "hasAudioDescription": false,
        "hasSoundAmplification": false
      }
    },
    "movieId": 123,
    "metrics": {
      "messagesCount": 0,
      "clickedMessagesCount": 0,
      "ticketPurchaseIntentsCount": 0
    }
  },
  "highlightText": "Summer blockbuster",
  "desktopImageRef": "00000000-0000-0000-0000-000000000000",
  "mobileImageRef": "00000000-0000-0000-0000-000000000000",
  "activeFromDatetime": "2024-08-25T15:00:00Z",
  "activeUntilDatetime": "2024-08-25T15:00:00Z",
  "showFeatureBadge": false,
  "featureBadge": "Vorverkauf",
  "showButton": false,
  "buttonTitle": "Tickets sichern",
  "reason": "pre_sale",
  "highlightColor": "#467c9c",
  "link": "https://example.com/tickets",
  "position": 0
}

application/json

List cinema images

GET

https://api.cineamo.com

/cinemas/{cinemaId}/images

Returns a list of Image objects (Cinema images).

List cinema images › query Parameters

page

integer

perPage

integer

sort

string

order

string

List cinema images › Responses

200

A list of Image objects

Image[]

Image

id

integer · readOnly

path

string · readOnly

imageRef

string | null · readOnly

imageUrl

string | null · readOnly

position

integer

GET/cinemas/{cinemaId}/images

curl https://api.cineamo.com/cinemas/:cinemaId/images

Example Responses

[
  {
    "id": 1,
    "path": "path/to/image",
    "imageRef": "00000000-0000-0000-0000-000000000000",
    "imageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/image",
    "position": 1
  }
]

application/json

Set cinema images

PUT

https://api.cineamo.com

/cinemas/{cinemaId}/images

Sets a list of Image objects (Cinema images).

Set cinema images › Request Body

Image

id

integer · readOnly

path

string · readOnly

imageRef

string | null · readOnly

imageUrl

string | null · readOnly

position

integer

Set cinema images › Responses

200

A list of Cinema Image objects were set

Image

id

integer · readOnly

path

string · readOnly

imageRef

string | null · readOnly

imageUrl

string | null · readOnly

position

integer

PUT/cinemas/{cinemaId}/images

curl https://api.cineamo.com/cinemas/:cinemaId/images \
  --request PUT \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 1,
  "path": "path/to/image",
  "imageRef": "00000000-0000-0000-0000-000000000000",
  "imageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/image",
  "position": 1
}'

Example Request Body

{
  "id": 1,
  "path": "path/to/image",
  "imageRef": "00000000-0000-0000-0000-000000000000",
  "imageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/image",
  "position": 1
}

Example Responses

{
  "id": 1,
  "path": "path/to/image",
  "imageRef": "00000000-0000-0000-0000-000000000000",
  "imageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/image",
  "position": 1
}

application/json

List orders for a cinema

GET

https://api.cineamo.com

/cinemas/{cinemaId}/orders

Returns a list of Order objects.

List orders for a cinema › query Parameters

page

integer

perPage

integer

sort

string

order

string

userIds

integer[]

createdDatetimeStart

string · date-time

createdDatetimeEnd

string · date-time

states

string[]

Enum values:

pending

fulfilled

orphaned

refunded

canceled

canceled_by_payment_system

payment_failed_after_fulfillment

refunded_fulfillment_failed

List orders for a cinema › Responses

200

Order list

Order

id

integer · readOnly

cinemaId

integer | null · readOnly

userId

integer | null · readOnly

email

string | null · readOnly

priceNet

integer | null · readOnly

priceTotal

integer | null · readOnly

state

string | null · readOnly

createdDatetime

string | null · readOnly

invoiceId

integer | null · readOnly

invoiceRef

string | null · readOnly

cartUuid

string | null · readOnly

array | null · readOnly

Full price breakdown with all adjustments

client

string | null · readOnly

GET/cinemas/{cinemaId}/orders

curl https://api.cineamo.com/cinemas/:cinemaId/orders

Example Responses

{
  "id": 1,
  "cinemaId": 1,
  "userId": 1,
  "email": "some-email@cineamo.test",
  "priceNet": 1,
  "priceTotal": 1,
  "state": "pending",
  "createdDatetime": "2022-04-11T04:11:22Z",
  "invoiceId": 1,
  "invoiceRef": "pi_1A2bC3DeF4ghIJkL5mno6PqR",
  "cartUuid": "00000000-0000-0000-0000-000000000000",
  "priceBreakdown": [
    {
      "type": "tax",
      "label": "VAT 19%",
      "amount": 380
    }
  ],
  "client": "web"
}

application/json

List cinema cinema promotions

GET

https://api.cineamo.com

/cinemas/{cinemaId}/cinema-promotions

Returns a list of CinemaPromotion objects for a cinema.

List cinema cinema promotions › path Parameters

cinemaId

integer · required

List cinema cinema promotions › query Parameters

page

integer

perPage

integer

sort

string

order

string

activeDatetime

string

List cinema cinema promotions › Responses

CinemaPromotion list

CinemaPromotion

id

integer · readOnly

desktopImageRef

string | null · readOnly

desktopImageUrl

string | null · readOnly

mobileImageRef

string | null · readOnly

mobileImageUrl

string | null · readOnly

imageDescription

string | null · readOnly

link

string | null · readOnly

videoLink

string | null · readOnly

activeFromDatetime

string | null · readOnly

activeUntilDatetime

string | null · readOnly

position

integer | null

cinemaId

integer | null · readOnly

GET/cinemas/{cinemaId}/cinema-promotions

curl https://api.cineamo.com/cinemas/:cinemaId/cinema-promotions

Example Responses

{
  "id": 1,
  "desktopImageRef": "00000000-0000-0000-0000-000000000000",
  "desktopImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-promotion-desktop-image",
  "mobileImageRef": "00000000-0000-0000-0000-000000000000",
  "mobileImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-promotion-mobile-image",
  "imageDescription": "Summer promotion banner",
  "link": "https://example.com/promotion",
  "videoLink": "https://example.com/video",
  "activeFromDatetime": "2022-04-11T04:11:22Z",
  "activeUntilDatetime": "2022-05-11T06:11:22Z",
  "position": 1,
  "cinemaId": 1
}

application/json

Get a cinema

GET

https://api.cineamo.com

/cinemas/domain/{domain}

Returns the requested cinema.

Get a cinema › path Parameters

domain

string · required

Get a cinema › Responses

Cinema details

id

integer · readOnly · required

name

string · readOnly · required

description

string · readOnly · required

phone

string · readOnly · required

street

string · readOnly · required

postalCode

string · readOnly · required

city

string · readOnly · required

state

string · readOnly · required

stateAbbr

string · readOnly · required

country

string · readOnly · required

countryCode

string · readOnly · required

currencyCode

string · readOnly · required

longitude

number | null · float · readOnly · required

latitude

number | null · float · readOnly · required

email

string | null · readOnly · required

isActive

boolean · readOnly · required

shortName

string | null · readOnly

slug

string | null · readOnly

distance

integer | null · readOnly

(in meters)

profileImageRef

string | null · readOnly

profileImageUrl

string | null · readOnly

logoImageRef

string | null · readOnly

logoImageUrl

string | null · readOnly

logoWideImageRef

string | null · readOnly

logoWideImageUrl

string | null · readOnly

priceTablePdfRef

string | null · readOnly

priceTablePdfUrl

string | null · readOnly

primaryColor

string | null · readOnly

instagramLink

string | null · readOnly

facebookLink

string | null · readOnly

ticketSystemId

string | null · readOnly

ticketSystem

string | null · readOnly

cinemaConfigurationId

integer | null · readOnly

readOnly

showtimesUpdated

string | null · readOnly

isFavorite

boolean | null · readOnly

cineamoTrailerConfirmedDatetime

string | null · readOnly

metricCustomersCount

integer | null · readOnly

metricCompareCustomersCount

integer | null · readOnly

metricCustomersTotalCount

integer | null · readOnly

cinemaChainId

integer | null · readOnly

cinemaCompanyId

integer | null · readOnly

cityId

integer | null · readOnly

openingHoursCustomText

array | null · readOnly

GET/cinemas/domain/{domain}

curl https://api.cineamo.com/cinemas/domain/:domain

Example Responses

{
  "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"
  }
}

application/json

Get a cinema

GET

https://api.cineamo.com

/cinemas/{cinemaSlug}

Returns the requested cinema.

Get a cinema › path Parameters

cinemaSlug

string · required

Get a cinema › Responses

Cinema details

id

integer · readOnly · required

name

string · readOnly · required

description

string · readOnly · required

phone

string · readOnly · required

street

string · readOnly · required

postalCode

string · readOnly · required

city

string · readOnly · required

state

string · readOnly · required

stateAbbr

string · readOnly · required

country

string · readOnly · required

countryCode

string · readOnly · required

currencyCode

string · readOnly · required

longitude

number | null · float · readOnly · required

latitude

number | null · float · readOnly · required

email

string | null · readOnly · required

isActive

boolean · readOnly · required

shortName

string | null · readOnly

slug

string | null · readOnly

distance

integer | null · readOnly

(in meters)

profileImageRef

string | null · readOnly

profileImageUrl

string | null · readOnly

logoImageRef

string | null · readOnly

logoImageUrl

string | null · readOnly

logoWideImageRef

string | null · readOnly

logoWideImageUrl

string | null · readOnly

priceTablePdfRef

string | null · readOnly

priceTablePdfUrl

string | null · readOnly

primaryColor

string | null · readOnly

instagramLink

string | null · readOnly

facebookLink

string | null · readOnly

ticketSystemId

string | null · readOnly

ticketSystem

string | null · readOnly

cinemaConfigurationId

integer | null · readOnly

readOnly

showtimesUpdated

string | null · readOnly

isFavorite

boolean | null · readOnly

cineamoTrailerConfirmedDatetime

string | null · readOnly

metricCustomersCount

integer | null · readOnly

metricCompareCustomersCount

integer | null · readOnly

metricCustomersTotalCount

integer | null · readOnly

cinemaChainId

integer | null · readOnly

cinemaCompanyId

integer | null · readOnly

cityId

integer | null · readOnly

openingHoursCustomText

array | null · readOnly

GET/cinemas/{cinemaSlug}

curl https://api.cineamo.com/cinemas/:cinemaSlug

Example Responses

{
  "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"
  }
}

application/json

Get a cinema

GET

https://api.cineamo.com

/cinemas/{cinemaId}

Returns the requested cinema.

Get a cinema › path Parameters

cinemaId

integer · required

Get a cinema › Responses

Cinema details

id

integer · readOnly · required

name

string · readOnly · required

description

string · readOnly · required

phone

string · readOnly · required

street

string · readOnly · required

postalCode

string · readOnly · required

city

string · readOnly · required

state

string · readOnly · required

stateAbbr

string · readOnly · required

country

string · readOnly · required

countryCode

string · readOnly · required

currencyCode

string · readOnly · required

longitude

number | null · float · readOnly · required

latitude

number | null · float · readOnly · required

email

string | null · readOnly · required

isActive

boolean · readOnly · required

shortName

string | null · readOnly

slug

string | null · readOnly

distance

integer | null · readOnly

(in meters)

profileImageRef

string | null · readOnly

profileImageUrl

string | null · readOnly

logoImageRef

string | null · readOnly

logoImageUrl

string | null · readOnly

logoWideImageRef

string | null · readOnly

logoWideImageUrl

string | null · readOnly

priceTablePdfRef

string | null · readOnly

priceTablePdfUrl

string | null · readOnly

primaryColor

string | null · readOnly

instagramLink

string | null · readOnly

facebookLink

string | null · readOnly

ticketSystemId

string | null · readOnly

ticketSystem

string | null · readOnly

cinemaConfigurationId

integer | null · readOnly

readOnly

showtimesUpdated

string | null · readOnly

isFavorite

boolean | null · readOnly

cineamoTrailerConfirmedDatetime

string | null · readOnly

metricCustomersCount

integer | null · readOnly

metricCompareCustomersCount

integer | null · readOnly

metricCustomersTotalCount

integer | null · readOnly

cinemaChainId

integer | null · readOnly

cinemaCompanyId

integer | null · readOnly

cityId

integer | null · readOnly

openingHoursCustomText

array | null · readOnly

GET/cinemas/{cinemaId}

curl https://api.cineamo.com/cinemas/:cinemaId

Example Responses

{
  "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"
  }
}

application/json

Update a cinema

PATCH

https://api.cineamo.com

/cinemas/{cinemaId}

Updates a cinema. Returns the updated cinema.

Update a cinema › path Parameters

cinemaId

integer · required

Update a cinema › Request Body

id

integer · readOnly · required

name

string · readOnly · required

description

string · readOnly · required

phone

string · readOnly · required

street

string · readOnly · required

postalCode

string · readOnly · required

city

string · readOnly · required

state

string · readOnly · required

stateAbbr

string · readOnly · required

country

string · readOnly · required

countryCode

string · readOnly · required

currencyCode

string · readOnly · required

longitude

number | null · float · readOnly · required

latitude

number | null · float · readOnly · required

email

string | null · readOnly · required

isActive

boolean · readOnly · required

shortName

string | null · readOnly

slug

string | null · readOnly

distance

integer | null · readOnly

(in meters)

profileImageRef

string | null · readOnly

profileImageUrl

string | null · readOnly

logoImageRef

string | null · readOnly

logoImageUrl

string | null · readOnly

logoWideImageRef

string | null · readOnly

logoWideImageUrl

string | null · readOnly

priceTablePdfRef

string | null · readOnly

priceTablePdfUrl

string | null · readOnly

primaryColor

string | null · readOnly

instagramLink

string | null · readOnly

facebookLink

string | null · readOnly

ticketSystemId

string | null · readOnly

ticketSystem

string | null · readOnly

cinemaConfigurationId

integer | null · readOnly

readOnly

showtimesUpdated

string | null · readOnly

isFavorite

boolean | null · readOnly

cineamoTrailerConfirmedDatetime

string | null · readOnly

metricCustomersCount

integer | null · readOnly

metricCompareCustomersCount

integer | null · readOnly

metricCustomersTotalCount

integer | null · readOnly

cinemaChainId

integer | null · readOnly

cinemaCompanyId

integer | null · readOnly

cityId

integer | null · readOnly

openingHoursCustomText

array | null · readOnly

Update a cinema › Responses

Cinema was updated

id

integer · readOnly · required

name

string · readOnly · required

description

string · readOnly · required

phone

string · readOnly · required

street

string · readOnly · required

postalCode

string · readOnly · required

city

string · readOnly · required

state

string · readOnly · required

stateAbbr

string · readOnly · required

country

string · readOnly · required

countryCode

string · readOnly · required

currencyCode

string · readOnly · required

longitude

number | null · float · readOnly · required

latitude

number | null · float · readOnly · required

email

string | null · readOnly · required

isActive

boolean · readOnly · required

shortName

string | null · readOnly

slug

string | null · readOnly

distance

integer | null · readOnly

(in meters)

profileImageRef

string | null · readOnly

profileImageUrl

string | null · readOnly

logoImageRef

string | null · readOnly

logoImageUrl

string | null · readOnly

logoWideImageRef

string | null · readOnly

logoWideImageUrl

string | null · readOnly

priceTablePdfRef

string | null · readOnly

priceTablePdfUrl

string | null · readOnly

primaryColor

string | null · readOnly

instagramLink

string | null · readOnly

facebookLink

string | null · readOnly

ticketSystemId

string | null · readOnly

ticketSystem

string | null · readOnly

cinemaConfigurationId

integer | null · readOnly

readOnly

showtimesUpdated

string | null · readOnly

isFavorite

boolean | null · readOnly

cineamoTrailerConfirmedDatetime

string | null · readOnly

metricCustomersCount

integer | null · readOnly

metricCompareCustomersCount

integer | null · readOnly

metricCustomersTotalCount

integer | null · readOnly

cinemaChainId

integer | null · readOnly

cinemaCompanyId

integer | null · readOnly

cityId

integer | null · readOnly

openingHoursCustomText

array | null · readOnly

PATCH/cinemas/{cinemaId}

curl https://api.cineamo.com/cinemas/:cinemaId \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --data '{
  "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"
  }
}'

Example Request Body

{
  "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"
  }
}

Example Responses

{
  "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"
  }
}

application/json

Create a seat map sync

POST

https://api.cineamo.com

/cinemas/{cinemaId}/seat-map-sync

Syncs cinema seat-map. It returns empty response.

Create a seat map sync › Responses

Cinema seat-map was synced.

No data returned

POST/cinemas/{cinemaId}/seat-map-sync

curl https://api.cineamo.com/cinemas/:cinemaId/seat-map-sync \
  --request POST

Example Responses

No example specified for this content type

Create a showtimes crawl

POST

https://api.cineamo.com

/cinemas/{cinemaId}/showtimes-crawl

Queues showtime crawling for a cinema. Returns 202 with source count.

Create a showtimes crawl › Responses

Crawl commands queued.

No data returned

POST/cinemas/{cinemaId}/showtimes-crawl

curl https://api.cineamo.com/cinemas/:cinemaId/showtimes-crawl \
  --request POST

Example Responses

No example specified for this content type

Create a showtimes crawl batch

POST

https://api.cineamo.com

/cinemas/showtimes-crawl-batch

Queues a batch crawl command for all enabled cinema sources.

Create a showtimes crawl batch › Responses

Batch crawl command queued.

No data returned

POST/cinemas/showtimes-crawl-batch

curl https://api.cineamo.com/cinemas/showtimes-crawl-batch \
  --request POST

Example Responses

No example specified for this content type

Create a showtimes sync

POST

https://api.cineamo.com

/cinemas/{cinemaId}/showtimes-sync

Syncs cinema showtimes. It returns empty response.

Create a showtimes sync › Responses

Cinema showtimes was synced.

No data returned

POST/cinemas/{cinemaId}/showtimes-sync

curl https://api.cineamo.com/cinemas/:cinemaId/showtimes-sync \
  --request POST

Example Responses

No example specified for this content type

List cinema cinema sites

GET

https://api.cineamo.com

/cinemas/{cinemaId}/cinema-sites

Returns all CinemaSites that belong to the given cinema.

List cinema cinema sites › path Parameters

cinemaId

integer · required

List cinema cinema sites › query Parameters

page

integer

perPage

integer

List cinema cinema sites › Responses

CinemaSite list

CinemaSite

id

integer · readOnly

name

string · readOnly

description

string | null · readOnly

street

string | null · readOnly

postalCode

string | null · readOnly

city

string | null · readOnly

state

string | null · readOnly

stateAbbr

string | null · readOnly

phone

string | null · readOnly

latitude

number | null · readOnly

longitude

number | null · readOnly

profileImageRef

string | null · readOnly

cinemaId

integer · readOnly

createdDatetime

string | null · readOnly

GET/cinemas/{cinemaId}/cinema-sites

curl https://api.cineamo.com/cinemas/:cinemaId/cinema-sites

Example Responses

{
  "id": 1,
  "name": "Downtown Cinema Site",
  "description": "Our main downtown location",
  "street": "123 Main St",
  "postalCode": "12345",
  "city": "New York",
  "state": "New York",
  "stateAbbr": "NY",
  "phone": "+1234567890",
  "latitude": 40.7128,
  "longitude": -74.006,
  "profileImageRef": "550e8400-e29b-41d4-a716-446655440000",
  "cinemaId": 1,
  "createdDatetime": "2022-04-11T04:11:22Z"
}

application/json

List cinema cinema site configurations

GET

https://api.cineamo.com

/cinemas/{cinemaId}/cinema-site-configurations

Returns a list of CinemaSiteConfiguration objects for a cinema.

List cinema cinema site configurations › path Parameters

cinemaId

integer · required

List cinema cinema site configurations › query Parameters

page

integer

perPage

integer

sort

string

order

string

List cinema cinema site configurations › Responses

CinemaSiteConfiguration list

CinemaSiteConfiguration

id

integer · readOnly

cinemaSiteId

integer · readOnly

ticketSystem

string | null · readOnly

ticketSystemId

string | null · readOnly

ticketUrlTemplate

string | null · readOnly

ticketUrlTemplateIosAppendix

string | null · readOnly

ticketUrlTemplateAndroidAppendix

string | null · readOnly

ticketUrlTemplateWebAppendix

string | null · readOnly

ticketUrlTemplateCinemaWebsiteAppendix

string | null · readOnly

showtimesAdapterConfiguration

object | null · readOnly

createdDatetime

string | null · date-time · readOnly

updatedDatetime

string | null · date-time · readOnly

GET/cinemas/{cinemaId}/cinema-site-configurations

curl https://api.cineamo.com/cinemas/:cinemaId/cinema-site-configurations

Example Responses

{
  "id": 1,
  "cinemaSiteId": 1,
  "ticketSystem": "compeso_cloudticket",
  "ticketSystemId": "12345",
  "ticketUrlTemplate": "https://tickets.cinema.com/{showingId}",
  "ticketUrlTemplateIosAppendix": "ticketUrlTemplateIosAppendix",
  "ticketUrlTemplateAndroidAppendix": "ticketUrlTemplateAndroidAppendix",
  "ticketUrlTemplateWebAppendix": "ticketUrlTemplateWebAppendix",
  "ticketUrlTemplateCinemaWebsiteAppendix": "ticketUrlTemplateCinemaWebsiteAppendix",
  "showtimesAdapterConfiguration": {},
  "createdDatetime": "2022-04-11T04:11:22Z",
  "updatedDatetime": "2022-04-11T04:11:22Z"
}

application/json

List cinema contents

GET

https://api.cineamo.com

/cinemas/{cinemaId}/contents

Returns a list of Content objects for a specific cinema.

List cinema contents › path Parameters

cinemaId

integer · required

List cinema contents › query Parameters

page

integer

perPage

integer

sort

string

order

string

query

string

creatorCinemaId

integer

cineamoMovieId

string

Deprecated: use movieId instead (filters by the legacy Cineamo movie id).

movieId

integer

Filter contents by the movie id (Content.movie relation). Takes precedence over cineamoMovieId when both are given.

showingDate

string

showingStartDateTime

string

showingEndDateTime

string

hasPremiereShowings

boolean

metricStartDatetime

string

metricEndDatetime

string

hasMarketingAssistantBooked

boolean

cinemaCountryCode

string

isMovie

boolean

isShowingNow

boolean

List cinema contents › Responses

Cinema contents list

Content[]

Content

id

integer · readOnly

name

string · readOnly

slug

string | null · readOnly

category

string · readOnly

description

string · readOnly

isOwnContent

boolean | null · readOnly

duration

integer | null · readOnly

creatorCinemaId

integer | null · readOnly

posterImageRef

string | null · readOnly

posterImageUrl

string | null · readOnly

backdropImageRef

string | null · readOnly

backdropImageUrl

string | null · readOnly

ageRating

string | null · readOnly

trailerUrl

string | null · readOnly

hasMarketingAssistantBooked

boolean · readOnly

futureShowingsCount

integer | null · readOnly

premiereDate

string | null · readOnly

movieId

integer | null · readOnly

GET/cinemas/{cinemaId}/contents

curl https://api.cineamo.com/cinemas/:cinemaId/contents

Example Responses

[
  {
    "id": 1,
    "name": "some content name",
    "slug": "some-content-name",
    "category": "movie_series",
    "description": "description",
    "isOwnContent": true,
    "duration": 160,
    "creatorCinemaId": 1,
    "posterImageRef": "00000000-0000-0000-0000-000000000000",
    "posterImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/content-profile",
    "backdropImageRef": "00000000-0000-0000-0000-000000000000",
    "backdropImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/content-backdrop",
    "ageRating": "18",
    "trailerUrl": "https://example.com/trailer.mp4",
    "isRegularEvent": true,
    "hasMarketingAssistantBooked": true,
    "futureShowingsCount": 5,
    "premiereDate": "2022-04-11T04:11:22Z",
    "movie": {
      "id": 1,
      "tmdbId": 1,
      "cineamoId": "155m",
      "title": "Some Movie Title",
      "lastUpdated": 0,
      "isTmdbSyncSkipped": true,
      "series": true,
      "selectedByCinema": true,
      "adult": true,
      "backdropPath": "backdropPath",
      "genres": [
        {
          "id": 0,
          "name": "name"
        }
      ],
      "homepage": "homepage",
      "imdbId": "imdbId",
      "originalLanguage": "originalLanguage",
      "originalTitle": "Some Original Title",
      "overview": "Some movie overview...",
      "popularity": 0,
      "posterPath": "posterPath",
      "productionCompanies": [
        {
          "name": "name",
          "id": 0,
          "logoPath": "logoPath",
          "originCountry": "originCountry"
        }
      ],
      "productionCountries": [
        {}
      ],
      "releaseDate": "releaseDate",
      "revenue": 0,
      "runtime": 0,
      "firstAirDate": "firstAirDate",
      "status": "status",
      "tagline": "tagline",
      "video": true,
      "voteAverage": 0,
      "voteCount": 0,
      "alternativeTitles": {},
      "credits": {},
      "images": {},
      "videos": {
        "id": 0,
        "results": [
          "string"
        ]
      },
      "translations": {
        "id": 0,
        "translations": 0
      },
      "similar": {
        "page": 0,
        "totalPages": 0,
        "totalResults": 0,
        "results": [
          "string"
        ]
      },
      "releaseDates": {
        "id": 0,
        "results": [
          "string"
        ]
      },
      "noRightsAvailable": true,
      "noRightsTimestamp": 0,
      "thirdParties": {
        "moviePilot": {
          "voteAverage": 0,
          "link": "link",
          "voteCount": 0
        }
      },
      "slug": "some-slug",
      "rentrakTitle": 0,
      "movieAccessibility": {
        "id": 1,
        "movieId": 1,
        "iso31661": "DE",
        "gretaMovieId": "abc123",
        "hasClosedCaption": false,
        "hasAudioDescription": false,
        "hasSoundAmplification": false
      }
    },
    "movieId": 123,
    "metrics": {
      "messagesCount": 0,
      "clickedMessagesCount": 0,
      "ticketPurchaseIntentsCount": 0
    }
  }
]

application/json

Get a cinema content

GET

https://api.cineamo.com

/cinemas/{cinemaId}/contents/{contentId}

Returns a Content object for a specific cinema.

Get a cinema content › path Parameters

cinemaId

integer · required

contentId

integer · required

Get a cinema content › Responses

Cinema content details

Content

id

integer · readOnly

name

string · readOnly

slug

string | null · readOnly

category

string · readOnly

description

string · readOnly

isOwnContent

boolean | null · readOnly

duration

integer | null · readOnly

creatorCinemaId

integer | null · readOnly

posterImageRef

string | null · readOnly

posterImageUrl

string | null · readOnly

backdropImageRef

string | null · readOnly

backdropImageUrl

string | null · readOnly

ageRating

string | null · readOnly

trailerUrl

string | null · readOnly

hasMarketingAssistantBooked

boolean · readOnly

futureShowingsCount

integer | null · readOnly

premiereDate

string | null · readOnly

movieId

integer | null · readOnly

GET/cinemas/{cinemaId}/contents/{contentId}

curl https://api.cineamo.com/cinemas/:cinemaId/contents/:contentId

Example Responses

{
  "id": 1,
  "name": "some content name",
  "slug": "some-content-name",
  "category": "movie_series",
  "description": "description",
  "isOwnContent": true,
  "duration": 160,
  "creatorCinemaId": 1,
  "posterImageRef": "00000000-0000-0000-0000-000000000000",
  "posterImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/content-profile",
  "backdropImageRef": "00000000-0000-0000-0000-000000000000",
  "backdropImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/content-backdrop",
  "ageRating": "18",
  "trailerUrl": "https://example.com/trailer.mp4",
  "isRegularEvent": true,
  "hasMarketingAssistantBooked": true,
  "futureShowingsCount": 5,
  "premiereDate": "2022-04-11T04:11:22Z",
  "movie": {
    "id": 1,
    "tmdbId": 1,
    "cineamoId": "155m",
    "title": "Some Movie Title",
    "lastUpdated": 0,
    "isTmdbSyncSkipped": true,
    "series": true,
    "selectedByCinema": true,
    "adult": true,
    "backdropPath": "backdropPath",
    "genres": [
      {
        "id": 0,
        "name": "name"
      }
    ],
    "homepage": "homepage",
    "imdbId": "imdbId",
    "originalLanguage": "originalLanguage",
    "originalTitle": "Some Original Title",
    "overview": "Some movie overview...",
    "popularity": 0,
    "posterPath": "posterPath",
    "productionCompanies": [
      {
        "name": "name",
        "id": 0,
        "logoPath": "logoPath",
        "originCountry": "originCountry"
      }
    ],
    "productionCountries": [
      {}
    ],
    "releaseDate": "releaseDate",
    "revenue": 0,
    "runtime": 0,
    "firstAirDate": "firstAirDate",
    "status": "status",
    "tagline": "tagline",
    "video": true,
    "voteAverage": 0,
    "voteCount": 0,
    "alternativeTitles": {},
    "credits": {},
    "images": {},
    "videos": {
      "id": 0,
      "results": [
        "string"
      ]
    },
    "translations": {
      "id": 0,
      "translations": 0
    },
    "similar": {
      "page": 0,
      "totalPages": 0,
      "totalResults": 0,
      "results": [
        "string"
      ]
    },
    "releaseDates": {
      "id": 0,
      "results": [
        "string"
      ]
    },
    "noRightsAvailable": true,
    "noRightsTimestamp": 0,
    "thirdParties": {
      "moviePilot": {
        "voteAverage": 0,
        "link": "link",
        "voteCount": 0
      }
    },
    "slug": "some-slug",
    "rentrakTitle": 0,
    "movieAccessibility": {
      "id": 1,
      "movieId": 1,
      "iso31661": "DE",
      "gretaMovieId": "abc123",
      "hasClosedCaption": false,
      "hasAudioDescription": false,
      "hasSoundAmplification": false
    }
  },
  "movieId": 123,
  "metrics": {
    "messagesCount": 0,
    "clickedMessagesCount": 0,
    "ticketPurchaseIntentsCount": 0
  }
}

application/json

Set cinema cinema content upcoming

PUT

https://api.cineamo.com

/cinemas/{cinemaId}/content-upcomings/{contentId}

Creates or updates a CinemaContentUpcoming relationship between a cinema and content.

Set cinema cinema content upcoming › path Parameters

cinemaId

integer · required

contentId

integer · required

Set cinema cinema content upcoming › Request Body

CinemaContentUpcoming

id

integer · readOnly

createdDatetime

string | null · readOnly

readOnly

releaseDate

string | null · readOnly

position

integer | null

Set cinema cinema content upcoming › Responses

Cinema content upcoming has been updated

CinemaContentUpcoming

id

integer · readOnly

createdDatetime

string | null · readOnly

readOnly

releaseDate

string | null · readOnly

position

integer | null

PUT/cinemas/{cinemaId}/content-upcomings/{contentId}

curl https://api.cineamo.com/cinemas/:cinemaId/content-upcomings/:contentId \
  --request PUT \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 1,
  "createdDatetime": "2022-04-11T04:11:22Z",
  "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"
    }
  },
  "content": {
    "id": 1,
    "name": "some content name",
    "slug": "some-content-name",
    "category": "movie_series",
    "description": "description",
    "isOwnContent": true,
    "duration": 160,
    "creatorCinemaId": 1,
    "posterImageRef": "00000000-0000-0000-0000-000000000000",
    "posterImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/content-profile",
    "backdropImageRef": "00000000-0000-0000-0000-000000000000",
    "backdropImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/content-backdrop",
    "ageRating": "18",
    "trailerUrl": "https://example.com/trailer.mp4",
    "isRegularEvent": true,
    "hasMarketingAssistantBooked": true,
    "futureShowingsCount": 5,
    "premiereDate": "2022-04-11T04:11:22Z",
    "movie": {
      "id": 1,
      "tmdbId": 1,
      "cineamoId": "155m",
      "title": "Some Movie Title",
      "lastUpdated": 0,
      "isTmdbSyncSkipped": true,
      "series": true,
      "selectedByCinema": true,
      "adult": true,
      "backdropPath": "backdropPath",
      "genres": [
        {
          "id": 0,
          "name": "name"
        }
      ],
      "homepage": "homepage",
      "imdbId": "imdbId",
      "originalLanguage": "originalLanguage",
      "originalTitle": "Some Original Title",
      "overview": "Some movie overview...",
      "popularity": 0,
      "posterPath": "posterPath",
      "productionCompanies": [
        {
          "name": "name",
          "id": 0,
          "logoPath": "logoPath",
          "originCountry": "originCountry"
        }
      ],
      "productionCountries": [
        {}
      ],
      "releaseDate": "releaseDate",
      "revenue": 0,
      "runtime": 0,
      "firstAirDate": "firstAirDate",
      "status": "status",
      "tagline": "tagline",
      "video": true,
      "voteAverage": 0,
      "voteCount": 0,
      "alternativeTitles": {},
      "credits": {},
      "images": {},
      "videos": {
        "id": 0,
        "results": [
          "string"
        ]
      },
      "translations": {
        "id": 0,
        "translations": 0
      },
      "similar": {
        "page": 0,
        "totalPages": 0,
        "totalResults": 0,
        "results": [
          "string"
        ]
      },
      "releaseDates": {
        "id": 0,
        "results": [
          "string"
        ]
      },
      "noRightsAvailable": true,
      "noRightsTimestamp": 0,
      "thirdParties": {
        "moviePilot": {
          "voteAverage": 0,
          "link": "link",
          "voteCount": 0
        }
      },
      "slug": "some-slug",
      "rentrakTitle": 0,
      "movieAccessibility": {
        "id": 1,
        "movieId": 1,
        "iso31661": "DE",
        "gretaMovieId": "abc123",
        "hasClosedCaption": false,
        "hasAudioDescription": false,
        "hasSoundAmplification": false
      }
    },
    "movieId": 123,
    "metrics": {
      "messagesCount": 0,
      "clickedMessagesCount": 0,
      "ticketPurchaseIntentsCount": 0
    }
  },
  "releaseDate": "2022-04-11",
  "position": 1
}'

Example Request Body

{
  "id": 1,
  "createdDatetime": "2022-04-11T04:11:22Z",
  "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"
    }
  },
  "content": {
    "id": 1,
    "name": "some content name",
    "slug": "some-content-name",
    "category": "movie_series",
    "description": "description",
    "isOwnContent": true,
    "duration": 160,
    "creatorCinemaId": 1,
    "posterImageRef": "00000000-0000-0000-0000-000000000000",
    "posterImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/content-profile",
    "backdropImageRef": "00000000-0000-0000-0000-000000000000",
    "backdropImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/content-backdrop",
    "ageRating": "18",
    "trailerUrl": "https://example.com/trailer.mp4",
    "isRegularEvent": true,
    "hasMarketingAssistantBooked": true,
    "futureShowingsCount": 5,
    "premiereDate": "2022-04-11T04:11:22Z",
    "movie": {
      "id": 1,
      "tmdbId": 1,
      "cineamoId": "155m",
      "title": "Some Movie Title",
      "lastUpdated": 0,
      "isTmdbSyncSkipped": true,
      "series": true,
      "selectedByCinema": true,
      "adult": true,
      "backdropPath": "backdropPath",
      "genres": [
        {
          "id": 0,
          "name": "name"
        }
      ],
      "homepage": "homepage",
      "imdbId": "imdbId",
      "originalLanguage": "originalLanguage",
      "originalTitle": "Some Original Title",
      "overview": "Some movie overview...",
      "popularity": 0,
      "posterPath": "posterPath",
      "productionCompanies": [
        {
          "name": "name",
          "id": 0,
          "logoPath": "logoPath",
          "originCountry": "originCountry"
        }
      ],
      "productionCountries": [
        {}
      ],
      "releaseDate": "releaseDate",
      "revenue": 0,
      "runtime": 0,
      "firstAirDate": "firstAirDate",
      "status": "status",
      "tagline": "tagline",
      "video": true,
      "voteAverage": 0,
      "voteCount": 0,
      "alternativeTitles": {},
      "credits": {},
      "images": {},
      "videos": {
        "id": 0,
        "results": [
          "string"
        ]
      },
      "translations": {
        "id": 0,
        "translations": 0
      },
      "similar": {
        "page": 0,
        "totalPages": 0,
        "totalResults": 0,
        "results": [
          "string"
        ]
      },
      "releaseDates": {
        "id": 0,
        "results": [
          "string"
        ]
      },
      "noRightsAvailable": true,
      "noRightsTimestamp": 0,
      "thirdParties": {
        "moviePilot": {
          "voteAverage": 0,
          "link": "link",
          "voteCount": 0
        }
      },
      "slug": "some-slug",
      "rentrakTitle": 0,
      "movieAccessibility": {
        "id": 1,
        "movieId": 1,
        "iso31661": "DE",
        "gretaMovieId": "abc123",
        "hasClosedCaption": false,
        "hasAudioDescription": false,
        "hasSoundAmplification": false
      }
    },
    "movieId": 123,
    "metrics": {
      "messagesCount": 0,
      "clickedMessagesCount": 0,
      "ticketPurchaseIntentsCount": 0
    }
  },
  "releaseDate": "2022-04-11",
  "position": 1
}

Example Responses

{
  "id": 1,
  "createdDatetime": "2022-04-11T04:11:22Z",
  "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"
    }
  },
  "content": {
    "id": 1,
    "name": "some content name",
    "slug": "some-content-name",
    "category": "movie_series",
    "description": "description",
    "isOwnContent": true,
    "duration": 160,
    "creatorCinemaId": 1,
    "posterImageRef": "00000000-0000-0000-0000-000000000000",
    "posterImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/content-profile",
    "backdropImageRef": "00000000-0000-0000-0000-000000000000",
    "backdropImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/content-backdrop",
    "ageRating": "18",
    "trailerUrl": "https://example.com/trailer.mp4",
    "isRegularEvent": true,
    "hasMarketingAssistantBooked": true,
    "futureShowingsCount": 5,
    "premiereDate": "2022-04-11T04:11:22Z",
    "movie": {
      "id": 1,
      "tmdbId": 1,
      "cineamoId": "155m",
      "title": "Some Movie Title",
      "lastUpdated": 0,
      "isTmdbSyncSkipped": true,
      "series": true,
      "selectedByCinema": true,
      "adult": true,
      "backdropPath": "backdropPath",
      "genres": [
        {
          "id": 0,
          "name": "name"
        }
      ],
      "homepage": "homepage",
      "imdbId": "imdbId",
      "originalLanguage": "originalLanguage",
      "originalTitle": "Some Original Title",
      "overview": "Some movie overview...",
      "popularity": 0,
      "posterPath": "posterPath",
      "productionCompanies": [
        {
          "name": "name",
          "id": 0,
          "logoPath": "logoPath",
          "originCountry": "originCountry"
        }
      ],
      "productionCountries": [
        {}
      ],
      "releaseDate": "releaseDate",
      "revenue": 0,
      "runtime": 0,
      "firstAirDate": "firstAirDate",
      "status": "status",
      "tagline": "tagline",
      "video": true,
      "voteAverage": 0,
      "voteCount": 0,
      "alternativeTitles": {},
      "credits": {},
      "images": {},
      "videos": {
        "id": 0,
        "results": [
          "string"
        ]
      },
      "translations": {
        "id": 0,
        "translations": 0
      },
      "similar": {
        "page": 0,
        "totalPages": 0,
        "totalResults": 0,
        "results": [
          "string"
        ]
      },
      "releaseDates": {
        "id": 0,
        "results": [
          "string"
        ]
      },
      "noRightsAvailable": true,
      "noRightsTimestamp": 0,
      "thirdParties": {
        "moviePilot": {
          "voteAverage": 0,
          "link": "link",
          "voteCount": 0
        }
      },
      "slug": "some-slug",
      "rentrakTitle": 0,
      "movieAccessibility": {
        "id": 1,
        "movieId": 1,
        "iso31661": "DE",
        "gretaMovieId": "abc123",
        "hasClosedCaption": false,
        "hasAudioDescription": false,
        "hasSoundAmplification": false
      }
    },
    "movieId": 123,
    "metrics": {
      "messagesCount": 0,
      "clickedMessagesCount": 0,
      "ticketPurchaseIntentsCount": 0
    }
  },
  "releaseDate": "2022-04-11",
  "position": 1
}

application/json

Delete a cinema content upcoming

DELETE

https://api.cineamo.com

/cinemas/{cinemaId}/content-upcomings/{contentId}

Deletes a cinema content upcoming. It returns a response code but no response data.

Delete a cinema content upcoming › path Parameters

cinemaId

integer · required

contentId

integer · required

Delete a cinema content upcoming › Responses

Cinema content upcoming was deleted

No data returned

DELETE/cinemas/{cinemaId}/content-upcomings/{contentId}

curl https://api.cineamo.com/cinemas/:cinemaId/content-upcomings/:contentId \
  --request DELETE

Example Responses

No example specified for this content type

List cinema cinema content upcomings

GET

https://api.cineamo.com

/cinemas/{cinemaId}/cinema-content-upcomings

Returns a list of CinemaContentUpcoming objects.

List cinema cinema content upcomings › query Parameters

page

integer

perPage

integer

sort

string

order

string

query

string

cinemaIds

integer[]

releaseDateStart

string · date

releaseDateEnd

string · date

isHidden

boolean

hasReleaseDate

boolean

scope

string[]

Enum values:

unscheduled

List cinema cinema content upcomings › Responses

CinemaCinemaContentUpcoming list

CinemaContentUpcoming

id

integer · readOnly

createdDatetime

string | null · readOnly

readOnly

releaseDate

string | null · readOnly

position

integer | null

GET/cinemas/{cinemaId}/cinema-content-upcomings

curl https://api.cineamo.com/cinemas/:cinemaId/cinema-content-upcomings

Example Responses

{
  "id": 1,
  "createdDatetime": "2022-04-11T04:11:22Z",
  "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"
    }
  },
  "content": {
    "id": 1,
    "name": "some content name",
    "slug": "some-content-name",
    "category": "movie_series",
    "description": "description",
    "isOwnContent": true,
    "duration": 160,
    "creatorCinemaId": 1,
    "posterImageRef": "00000000-0000-0000-0000-000000000000",
    "posterImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/content-profile",
    "backdropImageRef": "00000000-0000-0000-0000-000000000000",
    "backdropImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/content-backdrop",
    "ageRating": "18",
    "trailerUrl": "https://example.com/trailer.mp4",
    "isRegularEvent": true,
    "hasMarketingAssistantBooked": true,
    "futureShowingsCount": 5,
    "premiereDate": "2022-04-11T04:11:22Z",
    "movie": {
      "id": 1,
      "tmdbId": 1,
      "cineamoId": "155m",
      "title": "Some Movie Title",
      "lastUpdated": 0,
      "isTmdbSyncSkipped": true,
      "series": true,
      "selectedByCinema": true,
      "adult": true,
      "backdropPath": "backdropPath",
      "genres": [
        {
          "id": 0,
          "name": "name"
        }
      ],
      "homepage": "homepage",
      "imdbId": "imdbId",
      "originalLanguage": "originalLanguage",
      "originalTitle": "Some Original Title",
      "overview": "Some movie overview...",
      "popularity": 0,
      "posterPath": "posterPath",
      "productionCompanies": [
        {
          "name": "name",
          "id": 0,
          "logoPath": "logoPath",
          "originCountry": "originCountry"
        }
      ],
      "productionCountries": [
        {}
      ],
      "releaseDate": "releaseDate",
      "revenue": 0,
      "runtime": 0,
      "firstAirDate": "firstAirDate",
      "status": "status",
      "tagline": "tagline",
      "video": true,
      "voteAverage": 0,
      "voteCount": 0,
      "alternativeTitles": {},
      "credits": {},
      "images": {},
      "videos": {
        "id": 0,
        "results": [
          "string"
        ]
      },
      "translations": {
        "id": 0,
        "translations": 0
      },
      "similar": {
        "page": 0,
        "totalPages": 0,
        "totalResults": 0,
        "results": [
          "string"
        ]
      },
      "releaseDates": {
        "id": 0,
        "results": [
          "string"
        ]
      },
      "noRightsAvailable": true,
      "noRightsTimestamp": 0,
      "thirdParties": {
        "moviePilot": {
          "voteAverage": 0,
          "link": "link",
          "voteCount": 0
        }
      },
      "slug": "some-slug",
      "rentrakTitle": 0,
      "movieAccessibility": {
        "id": 1,
        "movieId": 1,
        "iso31661": "DE",
        "gretaMovieId": "abc123",
        "hasClosedCaption": false,
        "hasAudioDescription": false,
        "hasSoundAmplification": false
      }
    },
    "movieId": 123,
    "metrics": {
      "messagesCount": 0,
      "clickedMessagesCount": 0,
      "ticketPurchaseIntentsCount": 0
    }
  },
  "releaseDate": "2022-04-11",
  "position": 1
}

application/json

List cinema movies

GET

https://api.cineamo.com

/cinemas/{cinemaId}/movies

Returns a list of Movie objects for a specific cinema.

List cinema movies › path Parameters

cinemaId

integer · required

List cinema movies › query Parameters

page

integer

perPage

integer

sort

string

order

string

query

string

cineamoMovieId

string

Deprecated: use movieId instead (filters by the legacy Cineamo movie id).

movieId

integer

Filter movies by the numeric movie id (Movie.id).

releaseDateStart

string

releaseDateEnd

string

region

string

distributorId

integer

isShowingNow

boolean

cinemaCountryCode

string

type

string

List cinema movies › Responses

Movie list for cinema

CinemaMovie[]

CinemaMovie

cinemaId

integer · readOnly · required

id

integer | null · readOnly

tmdbId

integer | null · readOnly

title

string | null · readOnly

lastUpdated

integer | null · readOnly

isTmdbSyncSkipped

boolean | null · readOnly

series

boolean · readOnly

selectedByCinema

boolean · readOnly

adult

boolean · readOnly

backdropPath

string | null · readOnly

array | null · readOnly

homepage

string | null · readOnly

imdbId

string | null · readOnly

originalLanguage

string | null · readOnly

originalTitle

string | null · readOnly

overview

string | null · readOnly

popularity

number · float · readOnly

posterPath

string | null · readOnly

array | null · readOnly

productionCountries

array | null · readOnly

releaseDate

string | null · readOnly

revenue

integer | null · readOnly

runtime

integer | null · readOnly

firstAirDate

string | null · readOnly

status

string | null · readOnly

tagline

string | null · readOnly

video

boolean | null · readOnly

voteAverage

number · float · readOnly

voteCount

integer · readOnly

readOnly

noRightsAvailable

boolean · readOnly

noRightsTimestamp

integer | null · readOnly

readOnly

slug

string | null · readOnly

rentrakTitle

integer | null · readOnly

readOnly

GET/cinemas/{cinemaId}/movies

curl https://api.cineamo.com/cinemas/:cinemaId/movies

Example Responses

[
  {
    "id": 1,
    "tmdbId": 1,
    "cineamoId": "155m",
    "title": "Some Movie Title",
    "lastUpdated": 0,
    "isTmdbSyncSkipped": true,
    "series": true,
    "selectedByCinema": true,
    "adult": true,
    "backdropPath": "backdropPath",
    "genres": [
      {
        "id": 0,
        "name": "name"
      }
    ],
    "homepage": "homepage",
    "imdbId": "imdbId",
    "originalLanguage": "originalLanguage",
    "originalTitle": "Some Original Title",
    "overview": "Some movie overview...",
    "popularity": 0,
    "posterPath": "posterPath",
    "productionCompanies": [
      {
        "name": "name",
        "id": 0,
        "logoPath": "logoPath",
        "originCountry": "originCountry"
      }
    ],
    "productionCountries": [
      {}
    ],
    "releaseDate": "releaseDate",
    "revenue": 0,
    "runtime": 0,
    "firstAirDate": "firstAirDate",
    "status": "status",
    "tagline": "tagline",
    "video": true,
    "voteAverage": 0,
    "voteCount": 0,
    "alternativeTitles": {},
    "credits": {},
    "images": {},
    "videos": {
      "id": 0,
      "results": [
        "string"
      ]
    },
    "translations": {
      "id": 0,
      "translations": 0
    },
    "similar": {
      "page": 0,
      "totalPages": 0,
      "totalResults": 0,
      "results": [
        "string"
      ]
    },
    "releaseDates": {
      "id": 0,
      "results": [
        "string"
      ]
    },
    "noRightsAvailable": true,
    "noRightsTimestamp": 0,
    "thirdParties": {
      "moviePilot": {
        "voteAverage": 0,
        "link": "link",
        "voteCount": 0
      }
    },
    "slug": "some-slug",
    "rentrakTitle": 0,
    "movieAccessibility": {
      "id": 1,
      "movieId": 1,
      "iso31661": "DE",
      "gretaMovieId": "abc123",
      "hasClosedCaption": false,
      "hasAudioDescription": false,
      "hasSoundAmplification": false
    },
    "cinemaId": 1
  }
]

application/json

Get a cinema movie

GET

https://api.cineamo.com

/cinemas/{cinemaId}/movies/{movieId}

Returns a Movie object for a specific cinema with cinema-specific customizations.

Get a cinema movie › path Parameters

cinemaId

integer · required

movieId

integer · required

Get a cinema movie › Responses

Cinema-specific movie details

CinemaMovie

cinemaId

integer · readOnly · required

id

integer | null · readOnly

tmdbId

integer | null · readOnly

title

string | null · readOnly

lastUpdated

integer | null · readOnly

isTmdbSyncSkipped

boolean | null · readOnly

series

boolean · readOnly

selectedByCinema

boolean · readOnly

adult

boolean · readOnly

backdropPath

string | null · readOnly

array | null · readOnly

homepage

string | null · readOnly

imdbId

string | null · readOnly

originalLanguage

string | null · readOnly

originalTitle

string | null · readOnly

overview

string | null · readOnly

popularity

number · float · readOnly

posterPath

string | null · readOnly

array | null · readOnly

productionCountries

array | null · readOnly

releaseDate

string | null · readOnly

revenue

integer | null · readOnly

runtime

integer | null · readOnly

firstAirDate

string | null · readOnly

status

string | null · readOnly

tagline

string | null · readOnly

video

boolean | null · readOnly

voteAverage

number · float · readOnly

voteCount

integer · readOnly

readOnly

noRightsAvailable

boolean · readOnly

noRightsTimestamp

integer | null · readOnly

readOnly

slug

string | null · readOnly

rentrakTitle

integer | null · readOnly

readOnly

GET/cinemas/{cinemaId}/movies/{movieId}

curl https://api.cineamo.com/cinemas/:cinemaId/movies/:movieId

Example Responses

{
  "id": 1,
  "tmdbId": 1,
  "cineamoId": "155m",
  "title": "Some Movie Title",
  "lastUpdated": 0,
  "isTmdbSyncSkipped": true,
  "series": true,
  "selectedByCinema": true,
  "adult": true,
  "backdropPath": "backdropPath",
  "genres": [
    {
      "id": 0,
      "name": "name"
    }
  ],
  "homepage": "homepage",
  "imdbId": "imdbId",
  "originalLanguage": "originalLanguage",
  "originalTitle": "Some Original Title",
  "overview": "Some movie overview...",
  "popularity": 0,
  "posterPath": "posterPath",
  "productionCompanies": [
    {
      "name": "name",
      "id": 0,
      "logoPath": "logoPath",
      "originCountry": "originCountry"
    }
  ],
  "productionCountries": [
    {}
  ],
  "releaseDate": "releaseDate",
  "revenue": 0,
  "runtime": 0,
  "firstAirDate": "firstAirDate",
  "status": "status",
  "tagline": "tagline",
  "video": true,
  "voteAverage": 0,
  "voteCount": 0,
  "alternativeTitles": {},
  "credits": {},
  "images": {},
  "videos": {
    "id": 0,
    "results": [
      "string"
    ]
  },
  "translations": {
    "id": 0,
    "translations": 0
  },
  "similar": {
    "page": 0,
    "totalPages": 0,
    "totalResults": 0,
    "results": [
      "string"
    ]
  },
  "releaseDates": {
    "id": 0,
    "results": [
      "string"
    ]
  },
  "noRightsAvailable": true,
  "noRightsTimestamp": 0,
  "thirdParties": {
    "moviePilot": {
      "voteAverage": 0,
      "link": "link",
      "voteCount": 0
    }
  },
  "slug": "some-slug",
  "rentrakTitle": 0,
  "movieAccessibility": {
    "id": 1,
    "movieId": 1,
    "iso31661": "DE",
    "gretaMovieId": "abc123",
    "hasClosedCaption": false,
    "hasAudioDescription": false,
    "hasSoundAmplification": false
  },
  "cinemaId": 1
}

application/json

Set cinema movie customization

PUT

https://api.cineamo.com

/cinemas/{cinemaId}/movie-customizations/{movieId}

Creates or updates a MovieCustomization relationship between a cinema and movie.

Set cinema movie customization › path Parameters

cinemaId

integer · required

movieId

integer · required

Set cinema movie customization › Request Body

MovieCustomization

id

integer · readOnly

createdDatetime

string | null · readOnly

readOnly

title

string | null · readOnly

description

string | null · readOnly

posterImageRef

string | null · readOnly

posterImageUrl

string | null · readOnly

backdropImageRef

string | null · readOnly

backdropImageUrl

string | null · readOnly

iso6393

string | null · readOnly

ISO 639-3 language code

Example: deu

preferedTrailerUrl

string | null · readOnly

Custom trailer URL

Example: https://example.com/trailer.mp4

isActive

boolean · readOnly

Set cinema movie customization › Responses

Movie customization has been updated

MovieCustomization

id

integer · readOnly

createdDatetime

string | null · readOnly

readOnly

title

string | null · readOnly

description

string | null · readOnly

posterImageRef

string | null · readOnly

posterImageUrl

string | null · readOnly

backdropImageRef

string | null · readOnly

backdropImageUrl

string | null · readOnly

iso6393

string | null · readOnly

ISO 639-3 language code

Example: deu

preferedTrailerUrl

string | null · readOnly

Custom trailer URL

Example: https://example.com/trailer.mp4

isActive

boolean · readOnly

PUT/cinemas/{cinemaId}/movie-customizations/{movieId}

curl https://api.cineamo.com/cinemas/:cinemaId/movie-customizations/:movieId \
  --request PUT \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 1,
  "createdDatetime": "2022-04-11T04:11:22Z",
  "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"
    }
  },
  "movie": {
    "id": 1,
    "tmdbId": 1,
    "cineamoId": "155m",
    "title": "Some Movie Title",
    "lastUpdated": 0,
    "isTmdbSyncSkipped": true,
    "series": true,
    "selectedByCinema": true,
    "adult": true,
    "backdropPath": "backdropPath",
    "genres": [
      {
        "id": 0,
        "name": "name"
      }
    ],
    "homepage": "homepage",
    "imdbId": "imdbId",
    "originalLanguage": "originalLanguage",
    "originalTitle": "Some Original Title",
    "overview": "Some movie overview...",
    "popularity": 0,
    "posterPath": "posterPath",
    "productionCompanies": [
      {
        "name": "name",
        "id": 0,
        "logoPath": "logoPath",
        "originCountry": "originCountry"
      }
    ],
    "productionCountries": [
      {}
    ],
    "releaseDate": "releaseDate",
    "revenue": 0,
    "runtime": 0,
    "firstAirDate": "firstAirDate",
    "status": "status",
    "tagline": "tagline",
    "video": true,
    "voteAverage": 0,
    "voteCount": 0,
    "alternativeTitles": {},
    "credits": {},
    "images": {},
    "videos": {
      "id": 0,
      "results": [
        "string"
      ]
    },
    "translations": {
      "id": 0,
      "translations": 0
    },
    "similar": {
      "page": 0,
      "totalPages": 0,
      "totalResults": 0,
      "results": [
        "string"
      ]
    },
    "releaseDates": {
      "id": 0,
      "results": [
        "string"
      ]
    },
    "noRightsAvailable": true,
    "noRightsTimestamp": 0,
    "thirdParties": {
      "moviePilot": {
        "voteAverage": 0,
        "link": "link",
        "voteCount": 0
      }
    },
    "slug": "some-slug",
    "rentrakTitle": 0,
    "movieAccessibility": {
      "id": 1,
      "movieId": 1,
      "iso31661": "DE",
      "gretaMovieId": "abc123",
      "hasClosedCaption": false,
      "hasAudioDescription": false,
      "hasSoundAmplification": false
    }
  },
  "title": "Custom Movie Title",
  "description": "Custom movie description",
  "posterImageRef": "00000000-0000-0000-0000-000000000000",
  "posterImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/movie-customization-poster",
  "backdropImageRef": "00000000-0000-0000-0000-000000000000",
  "backdropImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/movie-customization-backdrop",
  "iso6393": "deu",
  "preferedTrailerUrl": "https://example.com/trailer.mp4",
  "isActive": true
}'

Example Request Body

{
  "id": 1,
  "createdDatetime": "2022-04-11T04:11:22Z",
  "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"
    }
  },
  "movie": {
    "id": 1,
    "tmdbId": 1,
    "cineamoId": "155m",
    "title": "Some Movie Title",
    "lastUpdated": 0,
    "isTmdbSyncSkipped": true,
    "series": true,
    "selectedByCinema": true,
    "adult": true,
    "backdropPath": "backdropPath",
    "genres": [
      {
        "id": 0,
        "name": "name"
      }
    ],
    "homepage": "homepage",
    "imdbId": "imdbId",
    "originalLanguage": "originalLanguage",
    "originalTitle": "Some Original Title",
    "overview": "Some movie overview...",
    "popularity": 0,
    "posterPath": "posterPath",
    "productionCompanies": [
      {
        "name": "name",
        "id": 0,
        "logoPath": "logoPath",
        "originCountry": "originCountry"
      }
    ],
    "productionCountries": [
      {}
    ],
    "releaseDate": "releaseDate",
    "revenue": 0,
    "runtime": 0,
    "firstAirDate": "firstAirDate",
    "status": "status",
    "tagline": "tagline",
    "video": true,
    "voteAverage": 0,
    "voteCount": 0,
    "alternativeTitles": {},
    "credits": {},
    "images": {},
    "videos": {
      "id": 0,
      "results": [
        "string"
      ]
    },
    "translations": {
      "id": 0,
      "translations": 0
    },
    "similar": {
      "page": 0,
      "totalPages": 0,
      "totalResults": 0,
      "results": [
        "string"
      ]
    },
    "releaseDates": {
      "id": 0,
      "results": [
        "string"
      ]
    },
    "noRightsAvailable": true,
    "noRightsTimestamp": 0,
    "thirdParties": {
      "moviePilot": {
        "voteAverage": 0,
        "link": "link",
        "voteCount": 0
      }
    },
    "slug": "some-slug",
    "rentrakTitle": 0,
    "movieAccessibility": {
      "id": 1,
      "movieId": 1,
      "iso31661": "DE",
      "gretaMovieId": "abc123",
      "hasClosedCaption": false,
      "hasAudioDescription": false,
      "hasSoundAmplification": false
    }
  },
  "title": "Custom Movie Title",
  "description": "Custom movie description",
  "posterImageRef": "00000000-0000-0000-0000-000000000000",
  "posterImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/movie-customization-poster",
  "backdropImageRef": "00000000-0000-0000-0000-000000000000",
  "backdropImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/movie-customization-backdrop",
  "iso6393": "deu",
  "preferedTrailerUrl": "https://example.com/trailer.mp4",
  "isActive": true
}

Example Responses

{
  "id": 1,
  "createdDatetime": "2022-04-11T04:11:22Z",
  "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"
    }
  },
  "movie": {
    "id": 1,
    "tmdbId": 1,
    "cineamoId": "155m",
    "title": "Some Movie Title",
    "lastUpdated": 0,
    "isTmdbSyncSkipped": true,
    "series": true,
    "selectedByCinema": true,
    "adult": true,
    "backdropPath": "backdropPath",
    "genres": [
      {
        "id": 0,
        "name": "name"
      }
    ],
    "homepage": "homepage",
    "imdbId": "imdbId",
    "originalLanguage": "originalLanguage",
    "originalTitle": "Some Original Title",
    "overview": "Some movie overview...",
    "popularity": 0,
    "posterPath": "posterPath",
    "productionCompanies": [
      {
        "name": "name",
        "id": 0,
        "logoPath": "logoPath",
        "originCountry": "originCountry"
      }
    ],
    "productionCountries": [
      {}
    ],
    "releaseDate": "releaseDate",
    "revenue": 0,
    "runtime": 0,
    "firstAirDate": "firstAirDate",
    "status": "status",
    "tagline": "tagline",
    "video": true,
    "voteAverage": 0,
    "voteCount": 0,
    "alternativeTitles": {},
    "credits": {},
    "images": {},
    "videos": {
      "id": 0,
      "results": [
        "string"
      ]
    },
    "translations": {
      "id": 0,
      "translations": 0
    },
    "similar": {
      "page": 0,
      "totalPages": 0,
      "totalResults": 0,
      "results": [
        "string"
      ]
    },
    "releaseDates": {
      "id": 0,
      "results": [
        "string"
      ]
    },
    "noRightsAvailable": true,
    "noRightsTimestamp": 0,
    "thirdParties": {
      "moviePilot": {
        "voteAverage": 0,
        "link": "link",
        "voteCount": 0
      }
    },
    "slug": "some-slug",
    "rentrakTitle": 0,
    "movieAccessibility": {
      "id": 1,
      "movieId": 1,
      "iso31661": "DE",
      "gretaMovieId": "abc123",
      "hasClosedCaption": false,
      "hasAudioDescription": false,
      "hasSoundAmplification": false
    }
  },
  "title": "Custom Movie Title",
  "description": "Custom movie description",
  "posterImageRef": "00000000-0000-0000-0000-000000000000",
  "posterImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/movie-customization-poster",
  "backdropImageRef": "00000000-0000-0000-0000-000000000000",
  "backdropImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/movie-customization-backdrop",
  "iso6393": "deu",
  "preferedTrailerUrl": "https://example.com/trailer.mp4",
  "isActive": true
}

application/json

Delete a cinema movie customization

DELETE

https://api.cineamo.com

/cinemas/{cinemaId}/movie-customizations/{movieId}

Deletes a cinema movie customization. It returns a response code but no response data.

Delete a cinema movie customization › path Parameters

cinemaId

integer · required

movieId

integer · required

Delete a cinema movie customization › Responses

Movie customization was deleted

No data returned

DELETE/cinemas/{cinemaId}/movie-customizations/{movieId}

curl https://api.cineamo.com/cinemas/:cinemaId/movie-customizations/:movieId \
  --request DELETE

Example Responses

No example specified for this content type

List cinema movie customizations

GET

https://api.cineamo.com

/cinemas/{cinemaId}/movie-customizations

Returns a list of MovieCustomization objects for a specific cinema.

List cinema movie customizations › query Parameters

page

integer

perPage

integer

sort

string

order

string

query

string

movieIds

integer[]

List cinema movie customizations › Responses

MovieCustomization list

MovieCustomization

id

integer · readOnly

createdDatetime

string | null · readOnly

readOnly

title

string | null · readOnly

description

string | null · readOnly

posterImageRef

string | null · readOnly

posterImageUrl

string | null · readOnly

backdropImageRef

string | null · readOnly

backdropImageUrl

string | null · readOnly

iso6393

string | null · readOnly

ISO 639-3 language code

Example: deu

preferedTrailerUrl

string | null · readOnly

Custom trailer URL

Example: https://example.com/trailer.mp4

isActive

boolean · readOnly

GET/cinemas/{cinemaId}/movie-customizations

curl https://api.cineamo.com/cinemas/:cinemaId/movie-customizations

Example Responses

{
  "id": 1,
  "createdDatetime": "2022-04-11T04:11:22Z",
  "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"
    }
  },
  "movie": {
    "id": 1,
    "tmdbId": 1,
    "cineamoId": "155m",
    "title": "Some Movie Title",
    "lastUpdated": 0,
    "isTmdbSyncSkipped": true,
    "series": true,
    "selectedByCinema": true,
    "adult": true,
    "backdropPath": "backdropPath",
    "genres": [
      {
        "id": 0,
        "name": "name"
      }
    ],
    "homepage": "homepage",
    "imdbId": "imdbId",
    "originalLanguage": "originalLanguage",
    "originalTitle": "Some Original Title",
    "overview": "Some movie overview...",
    "popularity": 0,
    "posterPath": "posterPath",
    "productionCompanies": [
      {
        "name": "name",
        "id": 0,
        "logoPath": "logoPath",
        "originCountry": "originCountry"
      }
    ],
    "productionCountries": [
      {}
    ],
    "releaseDate": "releaseDate",
    "revenue": 0,
    "runtime": 0,
    "firstAirDate": "firstAirDate",
    "status": "status",
    "tagline": "tagline",
    "video": true,
    "voteAverage": 0,
    "voteCount": 0,
    "alternativeTitles": {},
    "credits": {},
    "images": {},
    "videos": {
      "id": 0,
      "results": [
        "string"
      ]
    },
    "translations": {
      "id": 0,
      "translations": 0
    },
    "similar": {
      "page": 0,
      "totalPages": 0,
      "totalResults": 0,
      "results": [
        "string"
      ]
    },
    "releaseDates": {
      "id": 0,
      "results": [
        "string"
      ]
    },
    "noRightsAvailable": true,
    "noRightsTimestamp": 0,
    "thirdParties": {
      "moviePilot": {
        "voteAverage": 0,
        "link": "link",
        "voteCount": 0
      }
    },
    "slug": "some-slug",
    "rentrakTitle": 0,
    "movieAccessibility": {
      "id": 1,
      "movieId": 1,
      "iso31661": "DE",
      "gretaMovieId": "abc123",
      "hasClosedCaption": false,
      "hasAudioDescription": false,
      "hasSoundAmplification": false
    }
  },
  "title": "Custom Movie Title",
  "description": "Custom movie description",
  "posterImageRef": "00000000-0000-0000-0000-000000000000",
  "posterImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/movie-customization-poster",
  "backdropImageRef": "00000000-0000-0000-0000-000000000000",
  "backdropImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/movie-customization-backdrop",
  "iso6393": "deu",
  "preferedTrailerUrl": "https://example.com/trailer.mp4",
  "isActive": true
}

application/json

List cinema future showings

GET

https://api.cineamo.com

/cinemas/{cinemaId}/showings-future

Returns a list of Showing objects for specific Cinema.

List cinema future showings › query Parameters

sort

string

order

string

query

string

cinemaRoomIds

string

cineamoMovieId

string

Deprecated: use movieId instead (filters by the legacy Cineamo movie id).

movieId

integer

Filter showings by the movie id (Content.movie relation). Takes precedence over cineamoMovieId when both are given.

name

string

contentId

integer

isEventRequest

boolean

isThreeDimensional

boolean

isOriginalLanguage

boolean

showingTagIds

integer[]

hasShowingTags

boolean

language

string

subtitledLanguage

string

countryCode

string

isHighlightAfterDatetime

string

embed

string[]

List cinema future showings › Responses

200

Showings list

Showing[]

Showing

contentId

integer | null · readOnly · required

eventRequestId

integer | null · readOnly · required

name

string · readOnly · required

isThreeDimensional

boolean | null · readOnly · required

isRegularShowtime

boolean | null · readOnly · required

id

integer · readOnly

cinemaRoomId

integer | null · readOnly

startDatetime

string | null · readOnly

endDatetime

string | null · readOnly

state

string | null · readOnly

isDolbyAtmos

boolean | null · readOnly

language

string | null · readOnly

originalLanguage

string | null · readOnly

isOriginalLanguage

boolean | null · readOnly

isDubbed

boolean | null · readOnly

dubbedLanguage

string | null · readOnly

isSubtitled

boolean | null · readOnly

subtitledLanguage

string | null · readOnly

cineamoMovieId

string | null · readOnly

movieId

integer | null · readOnly

onlineTicketUrl

string | null · readOnly

readOnly

CinApi\Cinema\Dto\CinemaDtoInterface | null · readOnly

cinemaId

integer | null · readOnly

readOnly

imageUrl

string | null · readOnly

readOnly

highlightAfterDatetime

string | null · readOnly

highlightText

string | null · readOnly

startSaleDatetime

string | null · readOnly

endSaleDatetime

string | null · readOnly

isImax

boolean | null · readOnly

isDolbyVision

boolean | null · readOnly

isDolbyCinema

boolean | null · readOnly

is4DX

boolean | null · readOnly

isScreenX

boolean | null · readOnly

isLive

boolean | null · readOnly

isHFR

boolean | null · readOnly

isDbox

boolean | null · readOnly

ticketUrls

array | null · readOnly

bookingUrlExternal

string | null · readOnly

showingTagIds

array | null · readOnly

IDs of tags attached to this showing

Example: [1,5,12]

isPremiere

boolean | null · readOnly

protectedColumns

array | null

Property names that will not be overridden during showtime import

Example: ["language","subtitledLanguage","isOriginalLanguage"]

GET/cinemas/{cinemaId}/showings-future

curl https://api.cineamo.com/cinemas/:cinemaId/showings-future

Example Responses

[
  {
    "id": 1,
    "contentId": 1,
    "eventRequestId": 1,
    "cinemaRoomId": 1,
    "name": "1",
    "startDatetime": "2022-04-11T04:11:22Z",
    "endDatetime": "2022-04-11T06:11:22Z",
    "state": "draft",
    "isThreeDimensional": true,
    "isRegularShowtime": true,
    "isDolbyAtmos": true,
    "language": "de",
    "originalLanguage": "en",
    "isOriginalLanguage": true,
    "isDubbed": true,
    "dubbedLanguage": "en",
    "isSubtitled": true,
    "subtitledLanguage": "en",
    "cineamoMovieId": "1",
    "movieId": 1,
    "onlineTicketUrl": "onlineTicketUrl",
    "cinemaRoom": {
      "id": 1,
      "name": 1,
      "position": 1,
      "cinemaId": 1,
      "cinemaSiteId": 1,
      "cinemaRoomShapeId": 1,
      "cinemaRoomShape": {
        "width": 160,
        "depth": 160,
        "height": 160,
        "id": 1
      },
      "seatCount": 1,
      "note": 1,
      "basePrice": 1,
      "isPrivateBookingEnabled": "true",
      "isTheater": 1,
      "isHdmiPort": 1,
      "isVgaPort": 1,
      "isLanPort": 1,
      "isWlanPort": 1,
      "isDisplayportPort": 1,
      "isPowerConnection": 1,
      "isDolbyAtmosReady": 1,
      "isThxReady": 1,
      "is5Point1Sound": true,
      "is7Point1Sound": true,
      "hasDboxSeats": true,
      "hasLeatherSeats": true,
      "hasPartnerSeats": true,
      "hasVipRows": true,
      "hasIncreasedRowSpacing": true,
      "profileImageRef": "00000000-0000-0000-0000-000000000000",
      "profileImageUrl": "https://cdn.cineamo.com/cinema-room-pri",
      "screenId": 1,
      "ffaId": 1,
      "isSyncDisabled": false
    },
    "content": {
      "id": 1,
      "name": "some content name",
      "slug": "some-content-name",
      "category": "movie_series",
      "description": "description",
      "isOwnContent": true,
      "duration": 160,
      "creatorCinemaId": 1,
      "posterImageRef": "00000000-0000-0000-0000-000000000000",
      "posterImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/content-profile",
      "backdropImageRef": "00000000-0000-0000-0000-000000000000",
      "backdropImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/content-backdrop",
      "ageRating": "18",
      "trailerUrl": "https://example.com/trailer.mp4",
      "isRegularEvent": true,
      "hasMarketingAssistantBooked": true,
      "futureShowingsCount": 5,
      "premiereDate": "2022-04-11T04:11:22Z",
      "movie": {
        "id": 1,
        "tmdbId": 1,
        "cineamoId": "155m",
        "title": "Some Movie Title",
        "lastUpdated": 0,
        "isTmdbSyncSkipped": true,
        "series": true,
        "selectedByCinema": true,
        "adult": true,
        "backdropPath": "backdropPath",
        "genres": [
          {
            "id": 0,
            "name": "name"
          }
        ],
        "homepage": "homepage",
        "imdbId": "imdbId",
        "originalLanguage": "originalLanguage",
        "originalTitle": "Some Original Title",
        "overview": "Some movie overview...",
        "popularity": 0,
        "posterPath": "posterPath",
        "productionCompanies": [
          {
            "name": "name",
            "id": 0,
            "logoPath": "logoPath",
            "originCountry": "originCountry"
          }
        ],
        "productionCountries": [
          {}
        ],
        "releaseDate": "releaseDate",
        "revenue": 0,
        "runtime": 0,
        "firstAirDate": "firstAirDate",
        "status": "status",
        "tagline": "tagline",
        "video": true,
        "voteAverage": 0,
        "voteCount": 0,
        "alternativeTitles": {},
        "credits": {},
        "images": {},
        "videos": {
          "id": 0,
          "results": [
            "string"
          ]
        },
        "translations": {
          "id": 0,
          "translations": 0
        },
        "similar": {
          "page": 0,
          "totalPages": 0,
          "totalResults": 0,
          "results": [
            "string"
          ]
        },
        "releaseDates": {
          "id": 0,
          "results": [
            "string"
          ]
        },
        "noRightsAvailable": true,
        "noRightsTimestamp": 0,
        "thirdParties": {
          "moviePilot": {
            "voteAverage": 0,
            "link": "link",
            "voteCount": 0
          }
        },
        "slug": "some-slug",
        "rentrakTitle": 0,
        "movieAccessibility": {
          "id": 1,
          "movieId": 1,
          "iso31661": "DE",
          "gretaMovieId": "abc123",
          "hasClosedCaption": false,
          "hasAudioDescription": false,
          "hasSoundAmplification": false
        }
      },
      "movieId": 123,
      "metrics": {
        "messagesCount": 0,
        "clickedMessagesCount": 0,
        "ticketPurchaseIntentsCount": 0
      }
    },
    "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"
      }
    },
    "cinemaId": 1,
    "eventRequest": {
      "id": 1,
      "ticketSystemId": "1",
      "user": {
        "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"
      },
      "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"
        }
      },
      "name": "Some Event Request",
      "slug": "some-event-request",
      "hospitality": "Some food request",
      "duration": 160,
      "expirationDatetime": "2022-04-11T04:11:22Z",
      "description": "Some description",
      "isPrivate": true,
      "uniqueId": "1",
      "commentCinema": "Some cinema comment",
      "commentInitiator": "Some initiator comment",
      "onlineTicketUrl": "onlineTicketUrl",
      "category": 0,
      "initialComment": "Some init comment",
      "imageUrl": "imageUrl",
      "ticketPrice": "5.99",
      "price": "5.99",
      "isOriginalVoice": true,
      "isThreeDimensional": true,
      "isRegularShowtime": true,
      "isCreatedByCinema": true,
      "cinemaRoom": {
        "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"
        }
      },
      "ageRating": "18",
      "facebookId": "facebookId",
      "createdDatetime": "2022-04-11T04:11:22Z",
      "lastNotificationSent": "2022-04-11T04:11:22Z",
      "finalDatetime": "2022-04-11T04:11:22Z",
      "acceptedByCinemaDatetime": "2022-04-11T04:11:22Z",
      "finalAcceptedTimestamp": "2022-04-11T04:11:22Z",
      "finalDeclinedTimestamp": "2022-04-11T04:11:22Z",
      "personCount": "100",
      "countVisitor": "100",
      "isCinemaMarketing": true,
      "isCorporation": true,
      "state": "initial",
      "declineReason": "Some decline reason",
      "content": {
        "id": 1,
        "name": "some content name",
        "slug": "some-content-name",
        "category": "movie_series",
        "description": "description",
        "isOwnContent": true,
        "duration": 160,
        "creatorCinemaId": 1,
        "posterImageRef": "00000000-0000-0000-0000-000000000000",
        "posterImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/content-profile",
        "backdropImageRef": "00000000-0000-0000-0000-000000000000",
        "backdropImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/content-backdrop",
        "ageRating": "18",
        "trailerUrl": "https://example.com/trailer.mp4",
        "isRegularEvent": true,
        "hasMarketingAssistantBooked": true,
        "futureShowingsCount": 5,
        "premiereDate": "2022-04-11T04:11:22Z",
        "movie": {
          "id": 1,
          "tmdbId": 1,
          "cineamoId": "155m",
          "title": "Some Movie Title",
          "lastUpdated": 0,
          "isTmdbSyncSkipped": true,
          "series": true,
          "selectedByCinema": true,
          "adult": true,
          "backdropPath": "backdropPath",
          "genres": [
            {
              "id": 0,
              "name": "name"
            }
          ],
          "homepage": "homepage",
          "imdbId": "imdbId",
          "originalLanguage": "originalLanguage",
          "originalTitle": "Some Original Title",
          "overview": "Some movie overview...",
          "popularity": 0,
          "posterPath": "posterPath",
          "productionCompanies": [
            {
              "name": "name",
              "id": 0,
              "logoPath": "logoPath",
              "originCountry": "originCountry"
            }
          ],
          "productionCountries": [
            {}
          ],
          "releaseDate": "releaseDate",
          "revenue": 0,
          "runtime": 0,
          "firstAirDate": "firstAirDate",
          "status": "status",
          "tagline": "tagline",
          "video": true,
          "voteAverage": 0,
          "voteCount": 0,
          "alternativeTitles": {},
          "credits": {},
          "images": {},
          "videos": {
            "id": 0,
            "results": [
              "string"
            ]
          },
          "translations": {
            "id": 0,
            "translations": 0
          },
          "similar": {
            "page": 0,
            "totalPages": 0,
            "totalResults": 0,
            "results": [
              "string"
            ]
          },
          "releaseDates": {
            "id": 0,
            "results": [
              "string"
            ]
          },
          "noRightsAvailable": true,
          "noRightsTimestamp": 0,
          "thirdParties": {
            "moviePilot": {
              "voteAverage": 0,
              "link": "link",
              "voteCount": 0
            }
          },
          "slug": "some-slug",
          "rentrakTitle": 0,
          "movieAccessibility": {
            "id": 1,
            "movieId": 1,
            "iso31661": "DE",
            "gretaMovieId": "abc123",
            "hasClosedCaption": false,
            "hasAudioDescription": false,
            "hasSoundAmplification": false
          }
        },
        "movieId": 123,
        "metrics": {
          "messagesCount": 0,
          "clickedMessagesCount": 0,
          "ticketPurchaseIntentsCount": 0
        }
      },
      "isFavorite": true
    },
    "imageUrl": "imageUrl",
    "priceOption": {
      "id": 1,
      "name": "Standard",
      "priceNet": 1,
      "isShowingDefault": "true",
      "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"
        }
      },
      "priceDiscount": {
        "id": 1,
        "name": "Standard",
        "priceChange": -1,
        "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"
          }
        }
      },
      "seatCategory": {
        "id": 1,
        "name": "Standard",
        "priceChange": -1,
        "cinemaId": 1,
        "imageRef": "00000000-0000-0000-0000-000000000000",
        "imageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/seat-category-image",
        "color": "color"
      },
      "priceTotal": 100
    },
    "highlightAfterDatetime": "2022-04-11T04:11:22Z",
    "highlightText": "highlightText",
    "startSaleDatetime": "2022-04-11T06:11:22Z",
    "endSaleDatetime": "2022-04-11T06:11:22Z",
    "isImax": true,
    "isDolbyVision": true,
    "isDolbyCinema": true,
    "is4DX": true,
    "isScreenX": true,
    "isLive": true,
    "isHFR": true,
    "isDbox": true,
    "ticketUrls": [
      "string"
    ],
    "bookingUrlExternal": "bookingUrlExternal",
    "showingTagIds": [
      1,
      5,
      12
    ],
    "isPremiere": true,
    "protectedColumns": [
      "language",
      "subtitledLanguage",
      "isOriginalLanguage"
    ]
  }
]

application/json

Get a cinema advertisement clicks count

GET

https://api.cineamo.com

/cinemas/{cinemaId:\d+}/advertisements/{advertisementId:\d+}/clicks-count

Returns the requested cinema advertisement clicks count.

Get a cinema advertisement clicks count › path Parameters

cinemaId

string · required

advertisementId

string · required

Get a cinema advertisement clicks count › query Parameters

placements

string[]

clients

string[]

deviceTypes

string[]

Get a cinema advertisement clicks count › Responses

200

CinemaAdvertisementClicksCount number

No data returned

GET/cinemas/{cinemaId:\d+}/advertisements/{advertisementId:\d+}/clicks-count

curl 'https://api.cineamo.com/cinemas/:cinemaId:\d+/advertisements/:advertisementId:\d+/clicks-count'

Example Responses

No example specified for this content type

Get a cinema advertisement impressions count

GET

https://api.cineamo.com

/cinemas/{cinemaId:\d+}/advertisements/{advertisementId:\d+}/impressions-count

Returns the requested cinema advertisement impressions count.

Get a cinema advertisement impressions count › path Parameters

cinemaId

string · required

advertisementId

string · required

Get a cinema advertisement impressions count › query Parameters

placements

string[]

clients

string[]

deviceTypes

string[]

Get a cinema advertisement impressions count › Responses

200

CinemaAdvertisementImpressionsCount number

No data returned

GET/cinemas/{cinemaId:\d+}/advertisements/{advertisementId:\d+}/impressions-count

curl 'https://api.cineamo.com/cinemas/:cinemaId:\d+/advertisements/:advertisementId:\d+/impressions-count'

Example Responses

No example specified for this content type

List cinema cinema advertisements

GET

https://api.cineamo.com

/cinemas/{cinemaId:\d+}/advertisements

Returns a list of CinemaAdvertisement objects.

List cinema cinema advertisements › query Parameters

page

integer

perPage

integer

sort

string

order

string

query

string

distributorIds

integer[]

embed

string[]

statuses

string[]

List cinema cinema advertisements › Responses

CinemaCinemaAdvertisement list

cinemaId

integer | null · readOnly

advertisementId

integer | null · readOnly

isDeclined

boolean · readOnly

matchesCinemaShowings

boolean · readOnly

GET/cinemas/{cinemaId:\d+}/advertisements

curl 'https://api.cineamo.com/cinemas/:cinemaId:\d+/advertisements'

Example Responses

{
  "cinemaId": 1,
  "cinema": {
    "id": 1,
    "name": "some cinema name",
    "slug": "some-cinema-name"
  },
  "advertisementId": 1,
  "advertisement": {
    "id": 1,
    "movieCopyright": {
      "id": 1,
      "content": {
        "id": 1,
        "name": "some content name",
        "slug": "some-content-name",
        "category": "movie_series",
        "description": "description",
        "isOwnContent": true,
        "duration": 160,
        "creatorCinemaId": 1,
        "posterImageRef": "00000000-0000-0000-0000-000000000000",
        "posterImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/content-profile",
        "backdropImageRef": "00000000-0000-0000-0000-000000000000",
        "backdropImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/content-backdrop",
        "ageRating": "18",
        "trailerUrl": "https://example.com/trailer.mp4",
        "isRegularEvent": true,
        "hasMarketingAssistantBooked": true,
        "futureShowingsCount": 5,
        "premiereDate": "2022-04-11T04:11:22Z",
        "movie": {
          "id": 1,
          "tmdbId": 1,
          "cineamoId": "155m",
          "title": "Some Movie Title",
          "lastUpdated": 0,
          "isTmdbSyncSkipped": true,
          "series": true,
          "selectedByCinema": true,
          "adult": true,
          "backdropPath": "backdropPath",
          "genres": [
            {
              "id": 0,
              "name": "name"
            }
          ],
          "homepage": "homepage",
          "imdbId": "imdbId",
          "originalLanguage": "originalLanguage",
          "originalTitle": "Some Original Title",
          "overview": "Some movie overview...",
          "popularity": 0,
          "posterPath": "posterPath",
          "productionCompanies": [
            {
              "name": "name",
              "id": 0,
              "logoPath": "logoPath",
              "originCountry": "originCountry"
            }
          ],
          "productionCountries": [
            {}
          ],
          "releaseDate": "releaseDate",
          "revenue": 0,
          "runtime": 0,
          "firstAirDate": "firstAirDate",
          "status": "status",
          "tagline": "tagline",
          "video": true,
          "voteAverage": 0,
          "voteCount": 0,
          "alternativeTitles": {},
          "credits": {},
          "images": {},
          "videos": {
            "id": 0,
            "results": [
              "string"
            ]
          },
          "translations": {
            "id": 0,
            "translations": 0
          },
          "similar": {
            "page": 0,
            "totalPages": 0,
            "totalResults": 0,
            "results": [
              "string"
            ]
          },
          "releaseDates": {
            "id": 0,
            "results": [
              "string"
            ]
          },
          "noRightsAvailable": true,
          "noRightsTimestamp": 0,
          "thirdParties": {
            "moviePilot": {
              "voteAverage": 0,
              "link": "link",
              "voteCount": 0
            }
          },
          "slug": "some-slug",
          "rentrakTitle": 0,
          "movieAccessibility": {
            "id": 1,
            "movieId": 1,
            "iso31661": "DE",
            "gretaMovieId": "abc123",
            "hasClosedCaption": false,
            "hasAudioDescription": false,
            "hasSoundAmplification": false
          }
        },
        "movieId": 123,
        "metrics": {
          "messagesCount": 0,
          "clickedMessagesCount": 0,
          "ticketPurchaseIntentsCount": 0
        }
      },
      "createdDatetime": "2022-011-17T04:11:22Z",
      "isCreatedByDistributor": false,
      "isLicensed": false,
      "internalDistributorMovieId": "1",
      "startDatetime": "2022-011-17T04:11:22Z",
      "endDatetime": "2022-011-17T04:11:22Z",
      "distributor": {
        "id": 1,
        "name": "some cinema name",
        "slug": "some-cinema-name",
        "email": "some@email.com",
        "description": "description",
        "phone": "012345678910",
        "street": "Some Street",
        "postalCode": "12345",
        "city": "Sim City",
        "isActive": "true",
        "isEnabledDefaultConditions": "true",
        "defaultConditionsAlternativeText": "defaultConditionsAlternativeText",
        "imageUrl": "imageUrl",
        "imageRef": "00000000-0000-0000-0000-000000000000",
        "countryCode": "DE"
      },
      "source": "source",
      "eventRequestsCount": 1
    },
    "startDatetime": "2022-04-11T04:11:22Z",
    "endDatetime": "2022-04-11T06:11:22Z",
    "cinemaIds": "[1,2,3]",
    "clickThroughUrl": "some URL",
    "topBannerImageRef": "00000000-0000-0000-0000-000000000000",
    "topBannerImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/advertisement-top-banner-image",
    "topBannerDesktopImageRef": "00000000-0000-0000-0000-000000000000",
    "topBannerDesktopImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/advertisement-top-banner-desktop-image",
    "layerImageRef": "00000000-0000-0000-0000-000000000000",
    "layerImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/advertisement-layer-image",
    "placement": "[\"top_banner\"]",
    "impressionCount": 1,
    "impressionThreshold": 1,
    "clickCount": 1,
    "costPer1kImpressions": 1,
    "maxBudget": 1,
    "status": "scheduled",
    "displayLocations": "[\"ios\", \"web\"]",
    "metricCinemasTotalCount": 1,
    "metricCinemasDeclinedCount": 1,
    "metricCinemasAcceptedCount": 1
  },
  "isDeclined": "true",
  "matchesCinemaShowings": "true"
}

application/json

Get a cinema advertisement by compound ID

GET

https://api.cineamo.com

/cinemas/{cinemaId:\d+}/advertisements/{advertisementId:\d+}

Returns an CinemaAdvertisement object by its compound Id.

Get a cinema advertisement by compound ID › path Parameters

cinemaId

string · required

advertisementId

string · required

Get a cinema advertisement by compound ID › Responses

CinemaAdvertisement details

cinemaId

integer | null · readOnly

advertisementId

integer | null · readOnly

isDeclined

boolean · readOnly

matchesCinemaShowings

boolean · readOnly

GET/cinemas/{cinemaId:\d+}/advertisements/{advertisementId:\d+}

curl 'https://api.cineamo.com/cinemas/:cinemaId:\d+/advertisements/:advertisementId:\d+'

Example Responses

{
  "cinemaId": 1,
  "cinema": {
    "id": 1,
    "name": "some cinema name",
    "slug": "some-cinema-name"
  },
  "advertisementId": 1,
  "advertisement": {
    "id": 1,
    "movieCopyright": {
      "id": 1,
      "content": {
        "id": 1,
        "name": "some content name",
        "slug": "some-content-name",
        "category": "movie_series",
        "description": "description",
        "isOwnContent": true,
        "duration": 160,
        "creatorCinemaId": 1,
        "posterImageRef": "00000000-0000-0000-0000-000000000000",
        "posterImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/content-profile",
        "backdropImageRef": "00000000-0000-0000-0000-000000000000",
        "backdropImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/content-backdrop",
        "ageRating": "18",
        "trailerUrl": "https://example.com/trailer.mp4",
        "isRegularEvent": true,
        "hasMarketingAssistantBooked": true,
        "futureShowingsCount": 5,
        "premiereDate": "2022-04-11T04:11:22Z",
        "movie": {
          "id": 1,
          "tmdbId": 1,
          "cineamoId": "155m",
          "title": "Some Movie Title",
          "lastUpdated": 0,
          "isTmdbSyncSkipped": true,
          "series": true,
          "selectedByCinema": true,
          "adult": true,
          "backdropPath": "backdropPath",
          "genres": [
            {
              "id": 0,
              "name": "name"
            }
          ],
          "homepage": "homepage",
          "imdbId": "imdbId",
          "originalLanguage": "originalLanguage",
          "originalTitle": "Some Original Title",
          "overview": "Some movie overview...",
          "popularity": 0,
          "posterPath": "posterPath",
          "productionCompanies": [
            {
              "name": "name",
              "id": 0,
              "logoPath": "logoPath",
              "originCountry": "originCountry"
            }
          ],
          "productionCountries": [
            {}
          ],
          "releaseDate": "releaseDate",
          "revenue": 0,
          "runtime": 0,
          "firstAirDate": "firstAirDate",
          "status": "status",
          "tagline": "tagline",
          "video": true,
          "voteAverage": 0,
          "voteCount": 0,
          "alternativeTitles": {},
          "credits": {},
          "images": {},
          "videos": {
            "id": 0,
            "results": [
              "string"
            ]
          },
          "translations": {
            "id": 0,
            "translations": 0
          },
          "similar": {
            "page": 0,
            "totalPages": 0,
            "totalResults": 0,
            "results": [
              "string"
            ]
          },
          "releaseDates": {
            "id": 0,
            "results": [
              "string"
            ]
          },
          "noRightsAvailable": true,
          "noRightsTimestamp": 0,
          "thirdParties": {
            "moviePilot": {
              "voteAverage": 0,
              "link": "link",
              "voteCount": 0
            }
          },
          "slug": "some-slug",
          "rentrakTitle": 0,
          "movieAccessibility": {
            "id": 1,
            "movieId": 1,
            "iso31661": "DE",
            "gretaMovieId": "abc123",
            "hasClosedCaption": false,
            "hasAudioDescription": false,
            "hasSoundAmplification": false
          }
        },
        "movieId": 123,
        "metrics": {
          "messagesCount": 0,
          "clickedMessagesCount": 0,
          "ticketPurchaseIntentsCount": 0
        }
      },
      "createdDatetime": "2022-011-17T04:11:22Z",
      "isCreatedByDistributor": false,
      "isLicensed": false,
      "internalDistributorMovieId": "1",
      "startDatetime": "2022-011-17T04:11:22Z",
      "endDatetime": "2022-011-17T04:11:22Z",
      "distributor": {
        "id": 1,
        "name": "some cinema name",
        "slug": "some-cinema-name",
        "email": "some@email.com",
        "description": "description",
        "phone": "012345678910",
        "street": "Some Street",
        "postalCode": "12345",
        "city": "Sim City",
        "isActive": "true",
        "isEnabledDefaultConditions": "true",
        "defaultConditionsAlternativeText": "defaultConditionsAlternativeText",
        "imageUrl": "imageUrl",
        "imageRef": "00000000-0000-0000-0000-000000000000",
        "countryCode": "DE"
      },
      "source": "source",
      "eventRequestsCount": 1
    },
    "startDatetime": "2022-04-11T04:11:22Z",
    "endDatetime": "2022-04-11T06:11:22Z",
    "cinemaIds": "[1,2,3]",
    "clickThroughUrl": "some URL",
    "topBannerImageRef": "00000000-0000-0000-0000-000000000000",
    "topBannerImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/advertisement-top-banner-image",
    "topBannerDesktopImageRef": "00000000-0000-0000-0000-000000000000",
    "topBannerDesktopImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/advertisement-top-banner-desktop-image",
    "layerImageRef": "00000000-0000-0000-0000-000000000000",
    "layerImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/advertisement-layer-image",
    "placement": "[\"top_banner\"]",
    "impressionCount": 1,
    "impressionThreshold": 1,
    "clickCount": 1,
    "costPer1kImpressions": 1,
    "maxBudget": 1,
    "status": "scheduled",
    "displayLocations": "[\"ios\", \"web\"]",
    "metricCinemasTotalCount": 1,
    "metricCinemasDeclinedCount": 1,
    "metricCinemasAcceptedCount": 1
  },
  "isDeclined": "true",
  "matchesCinemaShowings": "true"
}

application/json

Update a cinema advertisement

PATCH

https://api.cineamo.com

/cinemas/{cinemaId}/advertisements/{advertisementId}

Updates an CinemaAdvertisement.

Update a cinema advertisement › path Parameters

cinemaId

string · required

advertisementId

string · required

Update a cinema advertisement › Request Body

cinemaId

integer | null · readOnly

advertisementId

integer | null · readOnly

isDeclined

boolean · readOnly

matchesCinemaShowings

boolean · readOnly

Update a cinema advertisement › Responses

CinemaAdvertisement was updated

cinemaId

integer | null · readOnly

advertisementId

integer | null · readOnly

isDeclined

boolean · readOnly

matchesCinemaShowings

boolean · readOnly

PATCH/cinemas/{cinemaId}/advertisements/{advertisementId}

curl https://api.cineamo.com/cinemas/:cinemaId/advertisements/:advertisementId \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --data '{
  "cinemaId": 1,
  "cinema": {
    "id": 1,
    "name": "some cinema name",
    "slug": "some-cinema-name"
  },
  "advertisementId": 1,
  "advertisement": {
    "id": 1,
    "movieCopyright": {
      "id": 1,
      "content": {
        "id": 1,
        "name": "some content name",
        "slug": "some-content-name",
        "category": "movie_series",
        "description": "description",
        "isOwnContent": true,
        "duration": 160,
        "creatorCinemaId": 1,
        "posterImageRef": "00000000-0000-0000-0000-000000000000",
        "posterImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/content-profile",
        "backdropImageRef": "00000000-0000-0000-0000-000000000000",
        "backdropImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/content-backdrop",
        "ageRating": "18",
        "trailerUrl": "https://example.com/trailer.mp4",
        "isRegularEvent": true,
        "hasMarketingAssistantBooked": true,
        "futureShowingsCount": 5,
        "premiereDate": "2022-04-11T04:11:22Z",
        "movie": {
          "id": 1,
          "tmdbId": 1,
          "cineamoId": "155m",
          "title": "Some Movie Title",
          "lastUpdated": 0,
          "isTmdbSyncSkipped": true,
          "series": true,
          "selectedByCinema": true,
          "adult": true,
          "backdropPath": "backdropPath",
          "genres": [
            {
              "id": 0,
              "name": "name"
            }
          ],
          "homepage": "homepage",
          "imdbId": "imdbId",
          "originalLanguage": "originalLanguage",
          "originalTitle": "Some Original Title",
          "overview": "Some movie overview...",
          "popularity": 0,
          "posterPath": "posterPath",
          "productionCompanies": [
            {
              "name": "name",
              "id": 0,
              "logoPath": "logoPath",
              "originCountry": "originCountry"
            }
          ],
          "productionCountries": [
            {}
          ],
          "releaseDate": "releaseDate",
          "revenue": 0,
          "runtime": 0,
          "firstAirDate": "firstAirDate",
          "status": "status",
          "tagline": "tagline",
          "video": true,
          "voteAverage": 0,
          "voteCount": 0,
          "alternativeTitles": {},
          "credits": {},
          "images": {},
          "videos": {
            "id": 0,
            "results": [
              "string"
            ]
          },
          "translations": {
            "id": 0,
            "translations": 0
          },
          "similar": {
            "page": 0,
            "totalPages": 0,
            "totalResults": 0,
            "results": [
              "string"
            ]
          },
          "releaseDates": {
            "id": 0,
            "results": [
              "string"
            ]
          },
          "noRightsAvailable": true,
          "noRightsTimestamp": 0,
          "thirdParties": {
            "moviePilot": {
              "voteAverage": 0,
              "link": "link",
              "voteCount": 0
            }
          },
          "slug": "some-slug",
          "rentrakTitle": 0,
          "movieAccessibility": {
            "id": 1,
            "movieId": 1,
            "iso31661": "DE",
            "gretaMovieId": "abc123",
            "hasClosedCaption": false,
            "hasAudioDescription": false,
            "hasSoundAmplification": false
          }
        },
        "movieId": 123,
        "metrics": {
          "messagesCount": 0,
          "clickedMessagesCount": 0,
          "ticketPurchaseIntentsCount": 0
        }
      },
      "createdDatetime": "2022-011-17T04:11:22Z",
      "isCreatedByDistributor": false,
      "isLicensed": false,
      "internalDistributorMovieId": "1",
      "startDatetime": "2022-011-17T04:11:22Z",
      "endDatetime": "2022-011-17T04:11:22Z",
      "distributor": {
        "id": 1,
        "name": "some cinema name",
        "slug": "some-cinema-name",
        "email": "some@email.com",
        "description": "description",
        "phone": "012345678910",
        "street": "Some Street",
        "postalCode": "12345",
        "city": "Sim City",
        "isActive": "true",
        "isEnabledDefaultConditions": "true",
        "defaultConditionsAlternativeText": "defaultConditionsAlternativeText",
        "imageUrl": "imageUrl",
        "imageRef": "00000000-0000-0000-0000-000000000000",
        "countryCode": "DE"
      },
      "source": "source",
      "eventRequestsCount": 1
    },
    "startDatetime": "2022-04-11T04:11:22Z",
    "endDatetime": "2022-04-11T06:11:22Z",
    "cinemaIds": "[1,2,3]",
    "clickThroughUrl": "some URL",
    "topBannerImageRef": "00000000-0000-0000-0000-000000000000",
    "topBannerImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/advertisement-top-banner-image",
    "topBannerDesktopImageRef": "00000000-0000-0000-0000-000000000000",
    "topBannerDesktopImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/advertisement-top-banner-desktop-image",
    "layerImageRef": "00000000-0000-0000-0000-000000000000",
    "layerImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/advertisement-layer-image",
    "placement": "[\"top_banner\"]",
    "impressionCount": 1,
    "impressionThreshold": 1,
    "clickCount": 1,
    "costPer1kImpressions": 1,
    "maxBudget": 1,
    "status": "scheduled",
    "displayLocations": "[\"ios\", \"web\"]",
    "metricCinemasTotalCount": 1,
    "metricCinemasDeclinedCount": 1,
    "metricCinemasAcceptedCount": 1
  },
  "isDeclined": "true",
  "matchesCinemaShowings": "true"
}'

Example Request Body

{
  "cinemaId": 1,
  "cinema": {
    "id": 1,
    "name": "some cinema name",
    "slug": "some-cinema-name"
  },
  "advertisementId": 1,
  "advertisement": {
    "id": 1,
    "movieCopyright": {
      "id": 1,
      "content": {
        "id": 1,
        "name": "some content name",
        "slug": "some-content-name",
        "category": "movie_series",
        "description": "description",
        "isOwnContent": true,
        "duration": 160,
        "creatorCinemaId": 1,
        "posterImageRef": "00000000-0000-0000-0000-000000000000",
        "posterImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/content-profile",
        "backdropImageRef": "00000000-0000-0000-0000-000000000000",
        "backdropImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/content-backdrop",
        "ageRating": "18",
        "trailerUrl": "https://example.com/trailer.mp4",
        "isRegularEvent": true,
        "hasMarketingAssistantBooked": true,
        "futureShowingsCount": 5,
        "premiereDate": "2022-04-11T04:11:22Z",
        "movie": {
          "id": 1,
          "tmdbId": 1,
          "cineamoId": "155m",
          "title": "Some Movie Title",
          "lastUpdated": 0,
          "isTmdbSyncSkipped": true,
          "series": true,
          "selectedByCinema": true,
          "adult": true,
          "backdropPath": "backdropPath",
          "genres": [
            {
              "id": 0,
              "name": "name"
            }
          ],
          "homepage": "homepage",
          "imdbId": "imdbId",
          "originalLanguage": "originalLanguage",
          "originalTitle": "Some Original Title",
          "overview": "Some movie overview...",
          "popularity": 0,
          "posterPath": "posterPath",
          "productionCompanies": [
            {
              "name": "name",
              "id": 0,
              "logoPath": "logoPath",
              "originCountry": "originCountry"
            }
          ],
          "productionCountries": [
            {}
          ],
          "releaseDate": "releaseDate",
          "revenue": 0,
          "runtime": 0,
          "firstAirDate": "firstAirDate",
          "status": "status",
          "tagline": "tagline",
          "video": true,
          "voteAverage": 0,
          "voteCount": 0,
          "alternativeTitles": {},
          "credits": {},
          "images": {},
          "videos": {
            "id": 0,
            "results": [
              "string"
            ]
          },
          "translations": {
            "id": 0,
            "translations": 0
          },
          "similar": {
            "page": 0,
            "totalPages": 0,
            "totalResults": 0,
            "results": [
              "string"
            ]
          },
          "releaseDates": {
            "id": 0,
            "results": [
              "string"
            ]
          },
          "noRightsAvailable": true,
          "noRightsTimestamp": 0,
          "thirdParties": {
            "moviePilot": {
              "voteAverage": 0,
              "link": "link",
              "voteCount": 0
            }
          },
          "slug": "some-slug",
          "rentrakTitle": 0,
          "movieAccessibility": {
            "id": 1,
            "movieId": 1,
            "iso31661": "DE",
            "gretaMovieId": "abc123",
            "hasClosedCaption": false,
            "hasAudioDescription": false,
            "hasSoundAmplification": false
          }
        },
        "movieId": 123,
        "metrics": {
          "messagesCount": 0,
          "clickedMessagesCount": 0,
          "ticketPurchaseIntentsCount": 0
        }
      },
      "createdDatetime": "2022-011-17T04:11:22Z",
      "isCreatedByDistributor": false,
      "isLicensed": false,
      "internalDistributorMovieId": "1",
      "startDatetime": "2022-011-17T04:11:22Z",
      "endDatetime": "2022-011-17T04:11:22Z",
      "distributor": {
        "id": 1,
        "name": "some cinema name",
        "slug": "some-cinema-name",
        "email": "some@email.com",
        "description": "description",
        "phone": "012345678910",
        "street": "Some Street",
        "postalCode": "12345",
        "city": "Sim City",
        "isActive": "true",
        "isEnabledDefaultConditions": "true",
        "defaultConditionsAlternativeText": "defaultConditionsAlternativeText",
        "imageUrl": "imageUrl",
        "imageRef": "00000000-0000-0000-0000-000000000000",
        "countryCode": "DE"
      },
      "source": "source",
      "eventRequestsCount": 1
    },
    "startDatetime": "2022-04-11T04:11:22Z",
    "endDatetime": "2022-04-11T06:11:22Z",
    "cinemaIds": "[1,2,3]",
    "clickThroughUrl": "some URL",
    "topBannerImageRef": "00000000-0000-0000-0000-000000000000",
    "topBannerImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/advertisement-top-banner-image",
    "topBannerDesktopImageRef": "00000000-0000-0000-0000-000000000000",
    "topBannerDesktopImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/advertisement-top-banner-desktop-image",
    "layerImageRef": "00000000-0000-0000-0000-000000000000",
    "layerImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/advertisement-layer-image",
    "placement": "[\"top_banner\"]",
    "impressionCount": 1,
    "impressionThreshold": 1,
    "clickCount": 1,
    "costPer1kImpressions": 1,
    "maxBudget": 1,
    "status": "scheduled",
    "displayLocations": "[\"ios\", \"web\"]",
    "metricCinemasTotalCount": 1,
    "metricCinemasDeclinedCount": 1,
    "metricCinemasAcceptedCount": 1
  },
  "isDeclined": "true",
  "matchesCinemaShowings": "true"
}

Example Responses

{
  "cinemaId": 1,
  "cinema": {
    "id": 1,
    "name": "some cinema name",
    "slug": "some-cinema-name"
  },
  "advertisementId": 1,
  "advertisement": {
    "id": 1,
    "movieCopyright": {
      "id": 1,
      "content": {
        "id": 1,
        "name": "some content name",
        "slug": "some-content-name",
        "category": "movie_series",
        "description": "description",
        "isOwnContent": true,
        "duration": 160,
        "creatorCinemaId": 1,
        "posterImageRef": "00000000-0000-0000-0000-000000000000",
        "posterImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/content-profile",
        "backdropImageRef": "00000000-0000-0000-0000-000000000000",
        "backdropImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/content-backdrop",
        "ageRating": "18",
        "trailerUrl": "https://example.com/trailer.mp4",
        "isRegularEvent": true,
        "hasMarketingAssistantBooked": true,
        "futureShowingsCount": 5,
        "premiereDate": "2022-04-11T04:11:22Z",
        "movie": {
          "id": 1,
          "tmdbId": 1,
          "cineamoId": "155m",
          "title": "Some Movie Title",
          "lastUpdated": 0,
          "isTmdbSyncSkipped": true,
          "series": true,
          "selectedByCinema": true,
          "adult": true,
          "backdropPath": "backdropPath",
          "genres": [
            {
              "id": 0,
              "name": "name"
            }
          ],
          "homepage": "homepage",
          "imdbId": "imdbId",
          "originalLanguage": "originalLanguage",
          "originalTitle": "Some Original Title",
          "overview": "Some movie overview...",
          "popularity": 0,
          "posterPath": "posterPath",
          "productionCompanies": [
            {
              "name": "name",
              "id": 0,
              "logoPath": "logoPath",
              "originCountry": "originCountry"
            }
          ],
          "productionCountries": [
            {}
          ],
          "releaseDate": "releaseDate",
          "revenue": 0,
          "runtime": 0,
          "firstAirDate": "firstAirDate",
          "status": "status",
          "tagline": "tagline",
          "video": true,
          "voteAverage": 0,
          "voteCount": 0,
          "alternativeTitles": {},
          "credits": {},
          "images": {},
          "videos": {
            "id": 0,
            "results": [
              "string"
            ]
          },
          "translations": {
            "id": 0,
            "translations": 0
          },
          "similar": {
            "page": 0,
            "totalPages": 0,
            "totalResults": 0,
            "results": [
              "string"
            ]
          },
          "releaseDates": {
            "id": 0,
            "results": [
              "string"
            ]
          },
          "noRightsAvailable": true,
          "noRightsTimestamp": 0,
          "thirdParties": {
            "moviePilot": {
              "voteAverage": 0,
              "link": "link",
              "voteCount": 0
            }
          },
          "slug": "some-slug",
          "rentrakTitle": 0,
          "movieAccessibility": {
            "id": 1,
            "movieId": 1,
            "iso31661": "DE",
            "gretaMovieId": "abc123",
            "hasClosedCaption": false,
            "hasAudioDescription": false,
            "hasSoundAmplification": false
          }
        },
        "movieId": 123,
        "metrics": {
          "messagesCount": 0,
          "clickedMessagesCount": 0,
          "ticketPurchaseIntentsCount": 0
        }
      },
      "createdDatetime": "2022-011-17T04:11:22Z",
      "isCreatedByDistributor": false,
      "isLicensed": false,
      "internalDistributorMovieId": "1",
      "startDatetime": "2022-011-17T04:11:22Z",
      "endDatetime": "2022-011-17T04:11:22Z",
      "distributor": {
        "id": 1,
        "name": "some cinema name",
        "slug": "some-cinema-name",
        "email": "some@email.com",
        "description": "description",
        "phone": "012345678910",
        "street": "Some Street",
        "postalCode": "12345",
        "city": "Sim City",
        "isActive": "true",
        "isEnabledDefaultConditions": "true",
        "defaultConditionsAlternativeText": "defaultConditionsAlternativeText",
        "imageUrl": "imageUrl",
        "imageRef": "00000000-0000-0000-0000-000000000000",
        "countryCode": "DE"
      },
      "source": "source",
      "eventRequestsCount": 1
    },
    "startDatetime": "2022-04-11T04:11:22Z",
    "endDatetime": "2022-04-11T06:11:22Z",
    "cinemaIds": "[1,2,3]",
    "clickThroughUrl": "some URL",
    "topBannerImageRef": "00000000-0000-0000-0000-000000000000",
    "topBannerImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/advertisement-top-banner-image",
    "topBannerDesktopImageRef": "00000000-0000-0000-0000-000000000000",
    "topBannerDesktopImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/advertisement-top-banner-desktop-image",
    "layerImageRef": "00000000-0000-0000-0000-000000000000",
    "layerImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/advertisement-layer-image",
    "placement": "[\"top_banner\"]",
    "impressionCount": 1,
    "impressionThreshold": 1,
    "clickCount": 1,
    "costPer1kImpressions": 1,
    "maxBudget": 1,
    "status": "scheduled",
    "displayLocations": "[\"ios\", \"web\"]",
    "metricCinemasTotalCount": 1,
    "metricCinemasDeclinedCount": 1,
    "metricCinemasAcceptedCount": 1
  },
  "isDeclined": "true",
  "matchesCinemaShowings": "true"
}

application/json

Create a replace cinema configuration

PUT

https://api.cineamo.com

/cinemas/{cinemaId}/configuration

Create or fully replace a cinema configuration (PUT semantics — full replacement)

Create a replace cinema configuration › path Parameters

cinemaId

string · required

Create a replace cinema configuration › Request Body

id

integer | null · readOnly

minimalInitialEventVisitor

integer | null · readOnly

requestTimeoutAnswer

integer | null · readOnly

isCatering

boolean | null · readOnly

ticketSystem

string | null · readOnly

ticketSystemId

string | null · readOnly

ticketUrlTemplate

string | null · readOnly

facebookAccessToken

string | null · readOnly

hasMarketingAssistantBooked

boolean | null · readOnly

visitorThreshold1

integer | null · readOnly

visitorThreshold2

integer | null · readOnly

isProgramSuggestionEnabled

boolean | null · readOnly

isPrivateBookingEnabled

boolean | null · readOnly

isActive

boolean | null · readOnly

isOnlineTicketingEnabled

boolean · readOnly

onlineTicketing

object | null · readOnly

isKOSCustomer

boolean · readOnly

isInterestSystemActivated

boolean · readOnly

isGiftCardRedemptionEnabled

boolean · readOnly

isWebsiteCustomer

boolean · readOnly

websiteConfiguration

object | null · readOnly

ticketUrlTemplateIosAppendix

string | null · readOnly

ticketUrlTemplateAndroidAppendix

string | null · readOnly

ticketUrlTemplateWebAppendix

string | null · readOnly

ticketUrlTemplateCinemaWebsiteAppendix

string | null · readOnly

domain

string | null · readOnly

pulseTenantId

string | null · readOnly

Create a replace cinema configuration › Responses

CinemaConfiguration was replaced

id

integer | null · readOnly

minimalInitialEventVisitor

integer | null · readOnly

requestTimeoutAnswer

integer | null · readOnly

isCatering

boolean | null · readOnly

ticketSystem

string | null · readOnly

ticketSystemId

string | null · readOnly

ticketUrlTemplate

string | null · readOnly

facebookAccessToken

string | null · readOnly

hasMarketingAssistantBooked

boolean | null · readOnly

visitorThreshold1

integer | null · readOnly

visitorThreshold2

integer | null · readOnly

isProgramSuggestionEnabled

boolean | null · readOnly

isPrivateBookingEnabled

boolean | null · readOnly

isActive

boolean | null · readOnly

isOnlineTicketingEnabled

boolean · readOnly

onlineTicketing

object | null · readOnly

isKOSCustomer

boolean · readOnly

isInterestSystemActivated

boolean · readOnly

isGiftCardRedemptionEnabled

boolean · readOnly

isWebsiteCustomer

boolean · readOnly

websiteConfiguration

object | null · readOnly

ticketUrlTemplateIosAppendix

string | null · readOnly

ticketUrlTemplateAndroidAppendix

string | null · readOnly

ticketUrlTemplateWebAppendix

string | null · readOnly

ticketUrlTemplateCinemaWebsiteAppendix

string | null · readOnly

domain

string | null · readOnly

pulseTenantId

string | null · readOnly

PUT/cinemas/{cinemaId}/configuration

curl https://api.cineamo.com/cinemas/:cinemaId/configuration \
  --request PUT \
  --header 'Content-Type: application/json' \
  --data '{
  "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"
}'

Example Request Body

{
  "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"
}

Example Responses

{
  "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"
}

application/json

Configuration a cinema

PATCH

https://api.cineamo.com

/cinemas/{cinemaId}/configuration

Partial update of a cinema configuration by cinemaId

Configuration a cinema › path Parameters

cinemaId

string · required

Configuration a cinema › Request Body

id

integer | null · readOnly

minimalInitialEventVisitor

integer | null · readOnly

requestTimeoutAnswer

integer | null · readOnly

isCatering

boolean | null · readOnly

ticketSystem

string | null · readOnly

ticketSystemId

string | null · readOnly

ticketUrlTemplate

string | null · readOnly

facebookAccessToken

string | null · readOnly

hasMarketingAssistantBooked

boolean | null · readOnly

visitorThreshold1

integer | null · readOnly

visitorThreshold2

integer | null · readOnly

isProgramSuggestionEnabled

boolean | null · readOnly

isPrivateBookingEnabled

boolean | null · readOnly

isActive

boolean | null · readOnly

isOnlineTicketingEnabled

boolean · readOnly

onlineTicketing

object | null · readOnly

isKOSCustomer

boolean · readOnly

isInterestSystemActivated

boolean · readOnly

isGiftCardRedemptionEnabled

boolean · readOnly

isWebsiteCustomer

boolean · readOnly

websiteConfiguration

object | null · readOnly

ticketUrlTemplateIosAppendix

string | null · readOnly

ticketUrlTemplateAndroidAppendix

string | null · readOnly

ticketUrlTemplateWebAppendix

string | null · readOnly

ticketUrlTemplateCinemaWebsiteAppendix

string | null · readOnly

domain

string | null · readOnly

pulseTenantId

string | null · readOnly

Configuration a cinema › Responses

CinemaConfiguration was updated