Messages

Server

Direct messages.

Get a message

GET

https://api.cineamo.com

/messages/{messageId}

Returns the requested message.

Get a message › path Parameters

messageId

integer · required

Get a message › Responses

Message details

No data returned

Delete a message

DELETE

https://api.cineamo.com

/messages/{messageId}

Deletes a message. Returns an empty response.

Delete a message › path Parameters

messageId

integer · required

Delete a message › Responses

Message was deleted

No data returned

Update a message

PATCH

https://api.cineamo.com

/messages/{messageId}

Updates a message. Returns the updated message.

Update a message › path Parameters

messageId

integer · required

Update a message › Request Body

Message

id

integer · readOnly

CinApi\User\Dto\UserDtoInterface | null

isRead

boolean | null · readOnly

isReceivedClient

boolean | null · readOnly

isClicked

boolean | null · readOnly

isDeleted

boolean | null · readOnly

createdDatetime

string | null · readOnly

type

string · readOnly

eventName

string · readOnly

context

string · readOnly

path

string · readOnly

symbol

string · readOnly

title

string · readOnly

text

string · readOnly

data

string · readOnly

endpoint

string · readOnly

adapter

string | null · readOnly

imageUrl

string | null · readOnly

scheduledDatetime

string | null · readOnly

movieId

string | null · readOnly

Update a message › Responses

Message was updated

Message

id

integer · readOnly

CinApi\User\Dto\UserDtoInterface | null

isRead

boolean | null · readOnly

isReceivedClient

boolean | null · readOnly

isClicked

boolean | null · readOnly

isDeleted

boolean | null · readOnly

createdDatetime

string | null · readOnly

type

string · readOnly

eventName

string · readOnly

context

string · readOnly

path

string · readOnly

symbol

string · readOnly

title

string · readOnly

text

string · readOnly

data

string · readOnly

endpoint

string · readOnly

adapter

string | null · readOnly

imageUrl

string | null · readOnly

scheduledDatetime

string | null · readOnly

movieId

string | null · readOnly

PATCH/messages/{messageId}

curl https://api.cineamo.com/messages/:messageId \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 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"
  },
  "isRead": "true",
  "isReceivedClient": "true",
  "isClicked": "true",
  "isDeleted": "true",
  "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"
    }
  },
  "type": "broadcast",
  "eventName": "Cineamo\\Model\\Request\\Statistics\\RequestStatistics.like",
  "context": "request_1109445",
  "path": "request/1109445/",
  "symbol": "default",
  "title": "Event gelikt!",
  "text": "event gelikt von anderem user",
  "data": "",
  "endpoint": "/de/request/display/1109445",
  "adapter": "",
  "imageUrl": "https://image.tmdb.org/t/p/original/some-image.jpg",
  "scheduledDatetime": "2022-04-11T04:11:22Z",
  "movieId": "123m"
}'

Example Request Body

{
  "id": 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"
  },
  "isRead": "true",
  "isReceivedClient": "true",
  "isClicked": "true",
  "isDeleted": "true",
  "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"
    }
  },
  "type": "broadcast",
  "eventName": "Cineamo\\Model\\Request\\Statistics\\RequestStatistics.like",
  "context": "request_1109445",
  "path": "request/1109445/",
  "symbol": "default",
  "title": "Event gelikt!",
  "text": "event gelikt von anderem user",
  "data": "",
  "endpoint": "/de/request/display/1109445",
  "adapter": "",
  "imageUrl": "https://image.tmdb.org/t/p/original/some-image.jpg",
  "scheduledDatetime": "2022-04-11T04:11:22Z",
  "movieId": "123m"
}

json

Example Responses

{
  "id": 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"
  },
  "isRead": "true",
  "isReceivedClient": "true",
  "isClicked": "true",
  "isDeleted": "true",
  "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"
    }
  },
  "type": "broadcast",
  "eventName": "Cineamo\\Model\\Request\\Statistics\\RequestStatistics.like",
  "context": "request_1109445",
  "path": "request/1109445/",
  "symbol": "default",
  "title": "Event gelikt!",
  "text": "event gelikt von anderem user",
  "data": "",
  "endpoint": "/de/request/display/1109445",
  "adapter": "",
  "imageUrl": "https://image.tmdb.org/t/p/original/some-image.jpg",
  "scheduledDatetime": "2022-04-11T04:11:22Z",
  "movieId": "123m"
}

json

application/json

List messages

GET

https://api.cineamo.com

/messages

Returns a list of messages objects.

List messages › Responses

200

Message list

No data returned

Update a messages list by user ID

PATCH

https://api.cineamo.com

/messages

Updates a messages list by user ID. Returns the updated messages list by user ID.

Update a messages list by user ID › Request Body

Message

id

integer · readOnly

CinApi\User\Dto\UserDtoInterface | null

isRead

boolean | null · readOnly

isReceivedClient

boolean | null · readOnly

isClicked

boolean | null · readOnly

isDeleted

boolean | null · readOnly

createdDatetime

string | null · readOnly

type

string · readOnly

eventName

string · readOnly

context

string · readOnly

path

string · readOnly

symbol

string · readOnly

title

string · readOnly

text

string · readOnly

data

string · readOnly

endpoint

string · readOnly

adapter

string | null · readOnly

imageUrl

string | null · readOnly

scheduledDatetime

string | null · readOnly

movieId

string | null · readOnly

Update a messages list by user ID › Responses

Messages list was updated

Message

id

integer · readOnly

CinApi\User\Dto\UserDtoInterface | null

isRead

boolean | null · readOnly

isReceivedClient

boolean | null · readOnly

isClicked

boolean | null · readOnly

isDeleted

boolean | null · readOnly

createdDatetime

string | null · readOnly

type

string · readOnly

eventName

string · readOnly

context

string · readOnly

path

string · readOnly

symbol

string · readOnly

title

string · readOnly

text

string · readOnly

data

string · readOnly

endpoint

string · readOnly

adapter

string | null · readOnly

imageUrl

string | null · readOnly

scheduledDatetime

string | null · readOnly

movieId

string | null · readOnly

PATCH/messages

curl https://api.cineamo.com/messages \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 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"
  },
  "isRead": "true",
  "isReceivedClient": "true",
  "isClicked": "true",
  "isDeleted": "true",
  "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"
    }
  },
  "type": "broadcast",
  "eventName": "Cineamo\\Model\\Request\\Statistics\\RequestStatistics.like",
  "context": "request_1109445",
  "path": "request/1109445/",
  "symbol": "default",
  "title": "Event gelikt!",
  "text": "event gelikt von anderem user",
  "data": "",
  "endpoint": "/de/request/display/1109445",
  "adapter": "",
  "imageUrl": "https://image.tmdb.org/t/p/original/some-image.jpg",
  "scheduledDatetime": "2022-04-11T04:11:22Z",
  "movieId": "123m"
}'

Example Request Body

{
  "id": 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"
  },
  "isRead": "true",
  "isReceivedClient": "true",
  "isClicked": "true",
  "isDeleted": "true",
  "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"
    }
  },
  "type": "broadcast",
  "eventName": "Cineamo\\Model\\Request\\Statistics\\RequestStatistics.like",
  "context": "request_1109445",
  "path": "request/1109445/",
  "symbol": "default",
  "title": "Event gelikt!",
  "text": "event gelikt von anderem user",
  "data": "",
  "endpoint": "/de/request/display/1109445",
  "adapter": "",
  "imageUrl": "https://image.tmdb.org/t/p/original/some-image.jpg",
  "scheduledDatetime": "2022-04-11T04:11:22Z",
  "movieId": "123m"
}

json

Example Responses

{
  "id": 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"
  },
  "isRead": "true",
  "isReceivedClient": "true",
  "isClicked": "true",
  "isDeleted": "true",
  "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"
    }
  },
  "type": "broadcast",
  "eventName": "Cineamo\\Model\\Request\\Statistics\\RequestStatistics.like",
  "context": "request_1109445",
  "path": "request/1109445/",
  "symbol": "default",
  "title": "Event gelikt!",
  "text": "event gelikt von anderem user",
  "data": "",
  "endpoint": "/de/request/display/1109445",
  "adapter": "",
  "imageUrl": "https://image.tmdb.org/t/p/original/some-image.jpg",
  "scheduledDatetime": "2022-04-11T04:11:22Z",
  "movieId": "123m"
}

json

application/json

Comments Threads

Update a message

PATCH

https://api.cineamo.com

/messages/{messageId}

Updates a message. Returns the updated message.

Update a message › path Parameters

messageId

integer · required

Update a message › Request Body

Message

id

integer · readOnly

CinApi\User\Dto\UserDtoInterface | null

isRead

boolean | null · readOnly

isReceivedClient

boolean | null · readOnly

isClicked

boolean | null · readOnly

isDeleted

boolean | null · readOnly

createdDatetime

string | null · readOnly

type

string · readOnly

eventName

string · readOnly

context

string · readOnly

path

string · readOnly

symbol

string · readOnly

title

string · readOnly

text

string · readOnly

data

string · readOnly

endpoint

string · readOnly

adapter

string | null · readOnly

imageUrl

string | null · readOnly

scheduledDatetime

string | null · readOnly

movieId

string | null · readOnly

Update a message › Responses

Message was updated

Message

id

integer · readOnly

CinApi\User\Dto\UserDtoInterface | null

isRead

boolean | null · readOnly

isReceivedClient

boolean | null · readOnly

isClicked

boolean | null · readOnly

isDeleted

boolean | null · readOnly

createdDatetime

string | null · readOnly

type

string · readOnly

eventName

string · readOnly

context

string · readOnly

path

string · readOnly

symbol

string · readOnly

title

string · readOnly

text

string · readOnly

data

string · readOnly

endpoint

string · readOnly

adapter

string | null · readOnly

imageUrl

string | null · readOnly

scheduledDatetime

string | null · readOnly

movieId

string | null · readOnly

Update a messages list by user ID

PATCH

https://api.cineamo.com

/messages

Updates a messages list by user ID. Returns the updated messages list by user ID.

Update a messages list by user ID › Request Body

Message

id

integer · readOnly

CinApi\User\Dto\UserDtoInterface | null

isRead

boolean | null · readOnly

isReceivedClient

boolean | null · readOnly

isClicked

boolean | null · readOnly

isDeleted

boolean | null · readOnly

createdDatetime

string | null · readOnly

type

string · readOnly

eventName

string · readOnly

context

string · readOnly

path

string · readOnly

symbol

string · readOnly

title

string · readOnly

text

string · readOnly

data

string · readOnly

endpoint

string · readOnly

adapter

string | null · readOnly

imageUrl

string | null · readOnly

scheduledDatetime

string | null · readOnly

movieId

string | null · readOnly

Update a messages list by user ID › Responses

Messages list was updated

Message

id

integer · readOnly

CinApi\User\Dto\UserDtoInterface | null

isRead

boolean | null · readOnly

isReceivedClient

boolean | null · readOnly

isClicked

boolean | null · readOnly

isDeleted

boolean | null · readOnly

createdDatetime

string | null · readOnly

type

string · readOnly

eventName

string · readOnly

context

string · readOnly

path

string · readOnly

symbol

string · readOnly

title

string · readOnly

text

string · readOnly

data

string · readOnly

endpoint

string · readOnly

adapter

string | null · readOnly

imageUrl

string | null · readOnly

scheduledDatetime

string | null · readOnly

movieId

string | null · readOnly