Cineamo Documentation

Cineamo API

Server

Newsletter config, sections, campaigns, subscribers and public opt-in.

POST

https://api.cineamo.com

/cinemas/{cinemaId}/newsletter/campaigns/{campaignId}/approve

Approve a draft campaign for scheduled sending.

cinemaId

integer · required

campaignId

integer · required

Campaign approved

No data returned

POST/cinemas/{cinemaId}/newsletter/campaigns/{campaignId}/approve

curl https://api.cineamo.com/cinemas/:cinemaId/newsletter/campaigns/:campaignId/approve \
  --request POST

Example Responses

No example specified for this content type

GET

https://api.cineamo.com

/cinemas/{cinemaId}/newsletter/campaigns

List newsletter campaigns for a cinema.

cinemaId

integer · required

page

integer

perPage

integer

sort

string

order

string

cinemaIds

integer[]

statuses

string[]

types

string[]

200

Campaign list

No data returned

GET/cinemas/{cinemaId}/newsletter/campaigns

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

Example Responses

No example specified for this content type

POST

https://api.cineamo.com

/cinemas/{cinemaId}/newsletter/campaigns

Create a new newsletter campaign for a cinema.

cinemaId

integer · required

subject

string · required

targetType

string · required

type

string

content

string

Campaign created

No data returned

POST/cinemas/{cinemaId}/newsletter/campaigns

curl https://api.cineamo.com/cinemas/:cinemaId/newsletter/campaigns \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "manual",
  "subject": "Our latest news",
  "content": "<p>Hello!</p>",
  "targetType": "all"
}'

Example Request Body

{
  "type": "manual",
  "subject": "Our latest news",
  "content": "<p>Hello!</p>",
  "targetType": "all"
}

Example Responses

No example specified for this content type

GET

https://api.cineamo.com

/cinemas/{cinemaId}/newsletter/campaigns/{campaignId}

Get a single newsletter campaign for a cinema.

cinemaId

integer · required

campaignId

integer · required

locale

string · enum

Language the movie titles and posters in sectionsSnapshot are resolved into. Defaults to what a send would use for this cinema (its forced newsletter language, else its country default).

Enum values:

Campaign data

No data returned

GET/cinemas/{cinemaId}/newsletter/campaigns/{campaignId}

curl https://api.cineamo.com/cinemas/:cinemaId/newsletter/campaigns/:campaignId

Example Responses

No example specified for this content type

DELETE

https://api.cineamo.com

/cinemas/{cinemaId}/newsletter/campaigns/{campaignId}

Delete a draft newsletter campaign.

cinemaId

integer · required

campaignId

integer · required

Campaign deleted

No data returned

DELETE/cinemas/{cinemaId}/newsletter/campaigns/{campaignId}

curl https://api.cineamo.com/cinemas/:cinemaId/newsletter/campaigns/:campaignId \
  --request DELETE

Example Responses

No example specified for this content type

PATCH

https://api.cineamo.com

/cinemas/{cinemaId}/newsletter/campaigns/{campaignId}

Update a draft newsletter campaign for a cinema.

cinemaId

integer · required

campaignId

integer · required

subject

string

content

string

endingContent

string

hasProgramOverviewButton

boolean

previewText

string

targetType

string

Campaign updated

No data returned

PATCH/cinemas/{cinemaId}/newsletter/campaigns/{campaignId}

curl https://api.cineamo.com/cinemas/:cinemaId/newsletter/campaigns/:campaignId \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --data '{
  "subject": "Our latest news",
  "content": "<p>Hello!</p>",
  "endingContent": "See you next week!",
  "hasProgramOverviewButton": true,
  "previewText": "A short preview",
  "targetType": "all"
}'

Example Request Body

{
  "subject": "Our latest news",
  "content": "<p>Hello!</p>",
  "endingContent": "See you next week!",
  "hasProgramOverviewButton": true,
  "previewText": "A short preview",
  "targetType": "all"
}

Example Responses

No example specified for this content type

POST

https://api.cineamo.com

/cinemas/{cinemaId}/newsletter/campaigns/{campaignId}/send

Trigger sending of a newsletter campaign. Without a body the campaign goes to all sendable subscribers of the cinema; with a recipient selection the FILTER (sections, tags, query) is resolved against the sendable subscribers at send time — only the manual exceptions travel as ids (excludeSubscriberIds, includeSubscriberIds), so the payload stays small regardless of audience size.

cinemaId

integer · required

campaignId

integer · required

query

string

Free-text filter over email / first name / last name

sections

string[]

Subscribers of at least one of these newsletter sections (new_releases, weekly_program, highlights, specials); subscribers without explicit topics match every section

tagIds

integer[]

Subscribers carrying these subscriber tags (see tagMatch)

excludeTagIds

integer[]

Subscribers carrying at least one of these tags are dropped

tagMatch

string · enum

How multiple tagIds combine: at least one tag (any, default) or every tag (all)

Enum values:

any

all

excludeSubscriberIds

integer[]

Manual per-subscriber exclusions on top of the filter

includeSubscriberIds

integer[]

Pinned subscribers, added even when they do not match the filter (all ids must be sendable subscribers of the cinema)

Campaign send triggered

No data returned

POST/cinemas/{cinemaId}/newsletter/campaigns/{campaignId}/send

curl https://api.cineamo.com/cinemas/:cinemaId/newsletter/campaigns/:campaignId/send \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "query": "query",
  "sections": [
    "string"
  ],
  "tagIds": [
    0
  ],
  "excludeTagIds": [
    0
  ],
  "tagMatch": "any",
  "excludeSubscriberIds": [
    0
  ],
  "includeSubscriberIds": [
    0
  ]
}'

Example Request Body

{
  "query": "query",
  "sections": [
    "string"
  ],
  "tagIds": [
    0
  ],
  "excludeTagIds": [
    0
  ],
  "tagMatch": "any",
  "excludeSubscriberIds": [
    0
  ],
  "includeSubscriberIds": [
    0
  ]
}

Example Responses

No example specified for this content type

POST

https://api.cineamo.com

/cinemas/{cinemaId}/newsletter/campaigns/{campaignId}/skip

Skip a draft campaign so it will not be sent.

cinemaId

integer · required

campaignId

integer · required

Campaign skipped

No data returned

POST/cinemas/{cinemaId}/newsletter/campaigns/{campaignId}/skip

curl https://api.cineamo.com/cinemas/:cinemaId/newsletter/campaigns/:campaignId/skip \
  --request POST

Example Responses

No example specified for this content type

GET

https://api.cineamo.com

/cinemas/{cinemaId}/newsletter/config

Get newsletter configuration for a cinema.

cinemaId

integer · required

Newsletter config

NewsletterConfig

id

integer · readOnly · required

cinemaId

integer · readOnly

isEnabled

boolean

isAutoSend

boolean

sendDay

string

sendTime

string

draftLeadHours

integer

senderName

string | null

senderEmail

string | null

replyToEmail

string | null

isApprovalRequired

boolean

defaultLanguage

string · enum

Enum values:

automatic

deu

eng

Example: automatic

cinemaWeekStartDay

string

cinemaWeekEndDay

string

welcomeTextDe

string | null

welcomeTextEn

string | null

endingTextDe

string | null

endingTextEn

string | null

GET/cinemas/{cinemaId}/newsletter/config

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

Example Responses

{
  "id": 0,
  "cinemaId": 0,
  "isEnabled": true,
  "isAutoSend": true,
  "sendDay": "tuesday",
  "sendTime": "10:00",
  "draftLeadHours": 24,
  "senderName": "Kino Newsletter",
  "senderEmail": "newsletter@cinema.de",
  "replyToEmail": "info@cinema.de",
  "isApprovalRequired": true,
  "defaultLanguage": "automatic",
  "cinemaWeekStartDay": "monday",
  "cinemaWeekEndDay": "sunday",
  "welcomeTextDe": "Hallo liebe Kinofreunde!",
  "welcomeTextEn": "Hello movie lovers!",
  "endingTextDe": "Bis bald im Kino!",
  "endingTextEn": "See you at the movies!"
}

application/json

PUT

https://api.cineamo.com

/cinemas/{cinemaId}/newsletter/config

Create or update newsletter configuration for a cinema.

cinemaId

integer · required

NewsletterConfig

id

integer · readOnly · required

cinemaId

integer · readOnly

isEnabled

boolean

isAutoSend

boolean

sendDay

string

sendTime

string

draftLeadHours

integer

senderName

string | null

senderEmail

string | null

replyToEmail

string | null

isApprovalRequired

boolean

defaultLanguage

string · enum

Enum values:

automatic

deu

eng

Example: automatic

cinemaWeekStartDay

string

cinemaWeekEndDay

string

welcomeTextDe

string | null

welcomeTextEn

string | null

endingTextDe

string | null

endingTextEn

string | null

Config updated

No data returned

PUT/cinemas/{cinemaId}/newsletter/config

curl https://api.cineamo.com/cinemas/:cinemaId/newsletter/config \
  --request PUT \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 0,
  "cinemaId": 0,
  "isEnabled": true,
  "isAutoSend": true,
  "sendDay": "tuesday",
  "sendTime": "10:00",
  "draftLeadHours": 24,
  "senderName": "Kino Newsletter",
  "senderEmail": "newsletter@cinema.de",
  "replyToEmail": "info@cinema.de",
  "isApprovalRequired": true,
  "defaultLanguage": "automatic",
  "cinemaWeekStartDay": "monday",
  "cinemaWeekEndDay": "sunday",
  "welcomeTextDe": "Hallo liebe Kinofreunde!",
  "welcomeTextEn": "Hello movie lovers!",
  "endingTextDe": "Bis bald im Kino!",
  "endingTextEn": "See you at the movies!"
}'

Example Request Body

{
  "id": 0,
  "cinemaId": 0,
  "isEnabled": true,
  "isAutoSend": true,
  "sendDay": "tuesday",
  "sendTime": "10:00",
  "draftLeadHours": 24,
  "senderName": "Kino Newsletter",
  "senderEmail": "newsletter@cinema.de",
  "replyToEmail": "info@cinema.de",
  "isApprovalRequired": true,
  "defaultLanguage": "automatic",
  "cinemaWeekStartDay": "monday",
  "cinemaWeekEndDay": "sunday",
  "welcomeTextDe": "Hallo liebe Kinofreunde!",
  "welcomeTextEn": "Hello movie lovers!",
  "endingTextDe": "Bis bald im Kino!",
  "endingTextEn": "See you at the movies!"
}

Example Responses

No example specified for this content type

GET

https://api.cineamo.com

/cinemas/{cinemaId}/newsletter/sections

List newsletter sections for a cinema.

cinemaId

integer · required

page

integer

perPage

integer

sort

string

order

string

configId

integer

200

NewsletterSection list

No data returned

GET/cinemas/{cinemaId}/newsletter/sections

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

Example Responses

No example specified for this content type

POST

https://api.cineamo.com

/cinemas/{cinemaId}/newsletter/sections

Create a new newsletter section for a cinema.

cinemaId

integer · required

config

integer · required

type

string · required

position

integer · required

cinema

integer · required

customContent

string | null

NewsletterSection created

No data returned

POST/cinemas/{cinemaId}/newsletter/sections

curl https://api.cineamo.com/cinemas/:cinemaId/newsletter/sections \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "config": 1,
  "type": "custom_text",
  "position": 0,
  "customContent": "customContent",
  "cinema": 1
}'

Example Request Body

{
  "config": 1,
  "type": "custom_text",
  "position": 0,
  "customContent": "customContent",
  "cinema": 1
}

Example Responses

No example specified for this content type

GET

https://api.cineamo.com

/cinemas/{cinemaId}/newsletter/sections/{newsletterSectionId}

Get a single newsletter section.

cinemaId

integer · required

newsletterSectionId

integer · required

NewsletterSection data

No data returned

GET/cinemas/{cinemaId}/newsletter/sections/{newsletterSectionId}

curl https://api.cineamo.com/cinemas/:cinemaId/newsletter/sections/:newsletterSectionId

Example Responses

No example specified for this content type

DELETE

https://api.cineamo.com

/cinemas/{cinemaId}/newsletter/sections/{newsletterSectionId}

Delete a newsletter section.

cinemaId

integer · required

newsletterSectionId

integer · required

NewsletterSection deleted

No data returned

DELETE/cinemas/{cinemaId}/newsletter/sections/{newsletterSectionId}

curl https://api.cineamo.com/cinemas/:cinemaId/newsletter/sections/:newsletterSectionId \
  --request DELETE

Example Responses

No example specified for this content type

PATCH

https://api.cineamo.com

/cinemas/{cinemaId}/newsletter/sections/{newsletterSectionId}

Update a newsletter section.

cinemaId

integer · required

newsletterSectionId

integer · required

type

string

position

integer

customContent

string | null

NewsletterSection updated

No data returned

PATCH/cinemas/{cinemaId}/newsletter/sections/{newsletterSectionId}

curl https://api.cineamo.com/cinemas/:cinemaId/newsletter/sections/:newsletterSectionId \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "custom_text",
  "position": 0,
  "customContent": "customContent"
}'

Example Request Body

{
  "type": "custom_text",
  "position": 0,
  "customContent": "customContent"
}

Example Responses

No example specified for this content type

Get a confirm

GET

https://api.cineamo.com

/newsletter/confirm/{token}

Confirm a newsletter subscription via DOI token.

Get a confirm › path Parameters

token

string · required

Get a confirm › Responses

Subscription confirmed

NewsletterSubscriber

id

integer · readOnly · required

cinemaId

integer · readOnly

email

string · readOnly

firstName

string | null

lastName

string | null

locale

string | null

doiStatus

string

doiConfirmedAt

string | null

unsubscribedAt

string | null

createdAt

string | null

object[] · readOnly

GET/newsletter/confirm/{token}

curl https://api.cineamo.com/newsletter/confirm/:token

Example Responses

{
  "id": 0,
  "cinemaId": 0,
  "email": "email",
  "firstName": "firstName",
  "lastName": "lastName",
  "locale": "locale",
  "doiStatus": "confirmed",
  "doiConfirmedAt": "2024-01-15T10:00:00Z",
  "unsubscribedAt": "2024-01-15T10:00:00Z",
  "createdAt": "2024-01-15T10:00:00Z",
  "tags": [
    {
      "id": 0,
      "name": "name",
      "color": "color"
    }
  ]
}

application/json

Post confirm

POST

https://api.cineamo.com

/newsletter/confirm/{token}

Confirm a newsletter subscription via DOI token (POST variant, RFC-safe).

Post confirm › path Parameters

token

string · required

Post confirm › Responses

Subscription confirmed

NewsletterSubscriber

id

integer · readOnly · required

cinemaId

integer · readOnly

email

string · readOnly

firstName

string | null

lastName

string | null

locale

string | null

doiStatus

string

doiConfirmedAt

string | null

unsubscribedAt

string | null

createdAt

string | null

object[] · readOnly

POST/newsletter/confirm/{token}

curl https://api.cineamo.com/newsletter/confirm/:token \
  --request POST

Example Responses

{
  "id": 0,
  "cinemaId": 0,
  "email": "email",
  "firstName": "firstName",
  "lastName": "lastName",
  "locale": "locale",
  "doiStatus": "confirmed",
  "doiConfirmedAt": "2024-01-15T10:00:00Z",
  "unsubscribedAt": "2024-01-15T10:00:00Z",
  "createdAt": "2024-01-15T10:00:00Z",
  "tags": [
    {
      "id": 0,
      "name": "name",
      "color": "color"
    }
  ]
}

application/json

POST

https://api.cineamo.com

/newsletter/subscribe

Subscribe to a cinema newsletter. Sends a DOI confirmation email.

cinemaId

integer

email

string

firstName

string | null

lastName

string | null

locale

string | null

object[]

Subscriber created, DOI email sent

NewsletterSubscriber

id

integer · readOnly · required

cinemaId

integer · readOnly

email

string · readOnly

firstName

string | null

lastName

string | null

locale

string | null

doiStatus

string

doiConfirmedAt

string | null

unsubscribedAt

string | null

createdAt

string | null

object[] · readOnly

POST/newsletter/subscribe

curl https://api.cineamo.com/newsletter/subscribe \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "cinemaId": 42,
  "email": "user@example.com",
  "firstName": "Max",
  "lastName": "Mustermann",
  "locale": "de",
  "subscriptions": [
    {
      "type": "weekly_news",
      "referenceId": "42"
    }
  ]
}'

Example Request Body

{
  "cinemaId": 42,
  "email": "user@example.com",
  "firstName": "Max",
  "lastName": "Mustermann",
  "locale": "de",
  "subscriptions": [
    {
      "type": "weekly_news",
      "referenceId": "42"
    }
  ]
}

Example Responses

{
  "id": 0,
  "cinemaId": 0,
  "email": "email",
  "firstName": "firstName",
  "lastName": "lastName",
  "locale": "locale",
  "doiStatus": "confirmed",
  "doiConfirmedAt": "2024-01-15T10:00:00Z",
  "unsubscribedAt": "2024-01-15T10:00:00Z",
  "createdAt": "2024-01-15T10:00:00Z",
  "tags": [
    {
      "id": 0,
      "name": "name",
      "color": "color"
    }
  ]
}

application/json

List subscriber status

GET

https://api.cineamo.com

/cinemas/{cinemaId}/newsletter/subscriber-status

Get newsletter subscription status for an anonymous visitor (by Pulse cookie).

List subscriber status › path Parameters

cinemaId

integer · required

List subscriber status › query Parameters

anonymousId

string · required

List subscriber status › Responses

200

Subscriber status

No data returned

GET/cinemas/{cinemaId}/newsletter/subscriber-status

curl 'https://api.cineamo.com/cinemas/:cinemaId/newsletter/subscriber-status?anonymousId=<string>'

Example Responses

No example specified for this content type

GET

https://api.cineamo.com

/cinemas/{cinemaId}/newsletter/subscribers

List newsletter subscribers for a cinema.

cinemaId

integer · required

page

integer

perPage

integer

sort

string

order

string

query

string

statuses

string[]

tagIds

integer[]

Only subscribers carrying these subscriber tags (see tagMatch)

excludeTagIds

integer[]

Drop subscribers carrying at least one of these subscriber tags

tagMatch

string · enum

How multiple tagIds combine: at least one tag (any, default) or every tag (all)

Enum values:

any

all

sections

string[]

Only subscribers subscribed to at least one of these newsletter sections (new_releases, weekly_program, highlights, specials); subscribers without any explicit topics match every section (they receive everything)

excludeUnsubscribed

boolean

Drop unsubscribed rows (sendable-only view)

200

Subscriber list

No data returned

GET/cinemas/{cinemaId}/newsletter/subscribers

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

Example Responses

No example specified for this content type

GET

https://api.cineamo.com

/cinemas/{cinemaId}/newsletter/subscribers/{subscriberId}

Get a single newsletter subscriber.

cinemaId

integer · required

subscriberId

integer · required

Subscriber

No data returned

GET/cinemas/{cinemaId}/newsletter/subscribers/{subscriberId}

curl https://api.cineamo.com/cinemas/:cinemaId/newsletter/subscribers/:subscriberId

Example Responses

No example specified for this content type

DELETE

https://api.cineamo.com

/cinemas/{cinemaId}/newsletter/subscribers/{subscriberId}

Unsubscribe (soft-delete) a newsletter subscriber.

cinemaId

integer · required

subscriberId

integer · required

Subscriber unsubscribed

No data returned

DELETE/cinemas/{cinemaId}/newsletter/subscribers/{subscriberId}

curl https://api.cineamo.com/cinemas/:cinemaId/newsletter/subscribers/:subscriberId \
  --request DELETE

Example Responses

No example specified for this content type

Look up an unsubscribe token

GET

https://api.cineamo.com

/newsletter/unsubscribe/{token}

Reads the subscriber for a one-click unsubscribe token. Does NOT unsubscribe — a link/mail prefetch must not mutate state; the POST variant performs the opt-out.

Look up an unsubscribe token › path Parameters

token

string · required

Look up an unsubscribe token › Responses

Successfully unsubscribed

NewsletterSubscriber

id

integer · readOnly · required

cinemaId

integer · readOnly

email

string · readOnly

firstName

string | null

lastName

string | null

locale

string | null

doiStatus

string

doiConfirmedAt

string | null

unsubscribedAt

string | null

createdAt

string | null

object[] · readOnly

GET/newsletter/unsubscribe/{token}

curl https://api.cineamo.com/newsletter/unsubscribe/:token

Example Responses

{
  "id": 0,
  "cinemaId": 0,
  "email": "email",
  "firstName": "firstName",
  "lastName": "lastName",
  "locale": "locale",
  "doiStatus": "confirmed",
  "doiConfirmedAt": "2024-01-15T10:00:00Z",
  "unsubscribedAt": "2024-01-15T10:00:00Z",
  "createdAt": "2024-01-15T10:00:00Z",
  "tags": [
    {
      "id": 0,
      "name": "name",
      "color": "color"
    }
  ]
}

application/json

Post unsubscribe

POST

https://api.cineamo.com

/newsletter/unsubscribe/{token}

Unsubscribe from a newsletter via one-click unsubscribe token (POST variant, RFC-safe).

Post unsubscribe › path Parameters

token

string · required

Post unsubscribe › Responses

Successfully unsubscribed

NewsletterSubscriber

id

integer · readOnly · required

cinemaId

integer · readOnly

email

string · readOnly

firstName

string | null

lastName

string | null

locale

string | null

doiStatus

string

doiConfirmedAt

string | null

unsubscribedAt

string | null

createdAt

string | null

object[] · readOnly

POST/newsletter/unsubscribe/{token}

curl https://api.cineamo.com/newsletter/unsubscribe/:token \
  --request POST

Example Responses

{
  "id": 0,
  "cinemaId": 0,
  "email": "email",
  "firstName": "firstName",
  "lastName": "lastName",
  "locale": "locale",
  "doiStatus": "confirmed",
  "doiConfirmedAt": "2024-01-15T10:00:00Z",
  "unsubscribedAt": "2024-01-15T10:00:00Z",
  "createdAt": "2024-01-15T10:00:00Z",
  "tags": [
    {
      "id": 0,
      "name": "name",
      "color": "color"
    }
  ]
}

application/json

GET

https://api.cineamo.com

/cinemas/{cinemaId}/newsletter/subscriber-tags

List the custom newsletter subscriber tags of a cinema. Tags are cinema-scoped: only the tags of the addressed cinema are returned.

cinemaId

integer · required

page

integer

perPage

integer

sort

string

order

string

query

string

200

NewsletterSubscriberTag list

No data returned

GET/cinemas/{cinemaId}/newsletter/subscriber-tags

curl https://api.cineamo.com/cinemas/:cinemaId/newsletter/subscriber-tags

Example Responses

No example specified for this content type

POST

https://api.cineamo.com

/cinemas/{cinemaId}/newsletter/subscriber-tags

Create a custom newsletter subscriber tag for a cinema. The tag is always created for the cinema addressed in the path.

cinemaId

integer · required

name

string · required

color

string | null

NewsletterSubscriberTag created

No data returned

POST/cinemas/{cinemaId}/newsletter/subscriber-tags

curl https://api.cineamo.com/cinemas/:cinemaId/newsletter/subscriber-tags \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "VIP",
  "color": "#ff9900"
}'

Example Request Body

{
  "name": "VIP",
  "color": "#ff9900"
}

Example Responses

No example specified for this content type

GET

https://api.cineamo.com

/subscriber-tags/{subscriberTagId}

Get a single newsletter subscriber tag. Cinema staff can only access tags of their own cinema.

subscriberTagId

integer · required

NewsletterSubscriberTag

No data returned

GET/subscriber-tags/{subscriberTagId}

curl https://api.cineamo.com/subscriber-tags/:subscriberTagId

Example Responses

No example specified for this content type

DELETE

https://api.cineamo.com

/subscriber-tags/{subscriberTagId}

Delete a newsletter subscriber tag. All relations of the tag to subscribers are removed. Cinema staff can only delete tags of their own cinema.

subscriberTagId

integer · required

NewsletterSubscriberTag deleted

No data returned

DELETE/subscriber-tags/{subscriberTagId}

curl https://api.cineamo.com/subscriber-tags/:subscriberTagId \
  --request DELETE

Example Responses

No example specified for this content type

PATCH

https://api.cineamo.com

/subscriber-tags/{subscriberTagId}

Rename or recolor a newsletter subscriber tag. Cinema staff can only update tags of their own cinema.

subscriberTagId

integer · required

name

string

color

string | null

NewsletterSubscriberTag updated

No data returned

PATCH/subscriber-tags/{subscriberTagId}

curl https://api.cineamo.com/subscriber-tags/:subscriberTagId \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "VIP",
  "color": "#ff9900"
}'

Example Request Body

{
  "name": "VIP",
  "color": "#ff9900"
}

Example Responses

No example specified for this content type

Set the tags of a subscriber

PUT

https://api.cineamo.com

/newsletter/subscribers/{subscriberId}/tags

Sets the subscriber's tag relations to exactly the given collection (collection-PUT like PUT /carts/{cartUuid}/seat-locks): missing tags are assigned, absent ones removed, an empty collection clears the subscriber. All tags must belong to the subscriber's cinema. Cinema staff can only tag subscribers of their own cinema.

Set the tags of a subscriber › path Parameters

subscriberId

integer · required

Set the tags of a subscriber › Request Body

object[]

tagId

integer · required

Set the tags of a subscriber › Responses

The resulting tag set with change counts

No data returned

PUT/newsletter/subscribers/{subscriberId}/tags

curl https://api.cineamo.com/newsletter/subscribers/:subscriberId/tags \
  --request PUT \
  --header 'Content-Type: application/json' \
  --data '[
  {
    "tagId": 1
  }
]'

Example Request Body

[
  {
    "tagId": 1
  }
]

Example Responses

No example specified for this content type

PUT

https://api.cineamo.com

/cinemas/{cinemaId}/newsletter/preferences

Batch-replace topic subscriptions for an anonymous visitor (public, no auth).

cinemaId

integer · required

anonymousId

string

object[]

Preferences updated

No data returned

PUT/cinemas/{cinemaId}/newsletter/preferences

curl https://api.cineamo.com/cinemas/:cinemaId/newsletter/preferences \
  --request PUT \
  --header 'Content-Type: application/json' \
  --data '{
  "anonymousId": "anonymousId",
  "topics": [
    {
      "type": "showing_tag",
      "referenceId": "referenceId"
    }
  ]
}'

Example Request Body

{
  "anonymousId": "anonymousId",
  "topics": [
    {
      "type": "showing_tag",
      "referenceId": "referenceId"
    }
  ]
}

Example Responses

No example specified for this content type

PUT

https://api.cineamo.com

/newsletter/subscription

Subscribe to a topic (bell follow). Auto-creates subscriber from logged-in user.

cinema

integer

type

string

referenceId

string | null

Already subscribed

No data returned

PUT/newsletter/subscription

curl https://api.cineamo.com/newsletter/subscription \
  --request PUT \
  --header 'Content-Type: application/json' \
  --data '{
  "cinema": 0,
  "type": "showing_tag",
  "referenceId": "referenceId"
}'

Example Request Body

{
  "cinema": 0,
  "type": "showing_tag",
  "referenceId": "referenceId"
}

Example Responses

No example specified for this content type

DELETE

https://api.cineamo.com

/newsletter/subscription

Unsubscribe from a topic (remove bell follow).

cinema

integer

type

string

referenceId

string | null

Unsubscribed

No data returned

DELETE/newsletter/subscription

curl https://api.cineamo.com/newsletter/subscription \
  --request DELETE \
  --header 'Content-Type: application/json' \
  --data '{
  "cinema": 0,
  "type": "showing_tag",
  "referenceId": "referenceId"
}'

Example Request Body

{
  "cinema": 0,
  "type": "showing_tag",
  "referenceId": "referenceId"
}

Example Responses

No example specified for this content type

GET

https://api.cineamo.com

/cinemas/{cinemaId}/newsletter/subscribers/{subscriberId}/subscriptions

List subscriptions for a newsletter subscriber.

cinemaId

integer · required

subscriberId

integer · required

page

integer

perPage

integer

Subscription list

No data returned

GET/cinemas/{cinemaId}/newsletter/subscribers/{subscriberId}/subscriptions

curl https://api.cineamo.com/cinemas/:cinemaId/newsletter/subscribers/:subscriberId/subscriptions

Example Responses

No example specified for this content type

PUT

https://api.cineamo.com

/cinemas/{cinemaId}/newsletter/subscription

Subscribe to a topic by anonymous_id (public, no auth).

cinemaId

integer · required

anonymousId

string

type

string

referenceId

string | null

Already subscribed

No data returned

PUT/cinemas/{cinemaId}/newsletter/subscription

curl https://api.cineamo.com/cinemas/:cinemaId/newsletter/subscription \
  --request PUT \
  --header 'Content-Type: application/json' \
  --data '{
  "anonymousId": "anonymousId",
  "type": "showing_tag",
  "referenceId": "referenceId"
}'

Example Request Body

{
  "anonymousId": "anonymousId",
  "type": "showing_tag",
  "referenceId": "referenceId"
}

Example Responses

No example specified for this content type

DELETE

https://api.cineamo.com

/cinemas/{cinemaId}/newsletter/subscription

Unsubscribe from a topic by anonymous_id (public, no auth).

cinemaId

integer · required

anonymousId

string

type

string

referenceId

string | null

Unsubscribed

No data returned

DELETE/cinemas/{cinemaId}/newsletter/subscription

curl https://api.cineamo.com/cinemas/:cinemaId/newsletter/subscription \
  --request DELETE \
  --header 'Content-Type: application/json' \
  --data '{
  "anonymousId": "anonymousId",
  "type": "showing_tag",
  "referenceId": "referenceId"
}'

Example Request Body

{
  "anonymousId": "anonymousId",
  "type": "showing_tag",
  "referenceId": "referenceId"
}

Example Responses

No example specified for this content type

GET

https://api.cineamo.com

/newsletter/subscriptions/{subscriptionId:\d+}

Get a single newsletter subscription.

subscriptionId

integer · required

Subscription data

NewsletterSubscription

id

integer · readOnly · required

subscriberId

integer · readOnly

type

string

referenceId

string | null

GET/newsletter/subscriptions/{subscriptionId:\d+}

curl 'https://api.cineamo.com/newsletter/subscriptions/:subscriptionId:\d+'

Example Responses

{
  "id": 0,
  "subscriberId": 0,
  "type": "showing_tag",
  "referenceId": "referenceId"
}

application/json

GET

https://api.cineamo.com

/cinemas/{cinemaId}/newsletter/subscription-stats

Get subscriber counts per subscription type.

cinemaId

integer · required

200

Subscription stats

totalConfirmed

integer

totalPending

integer

generalSubscribers

integer

object

GET/cinemas/{cinemaId}/newsletter/subscription-stats

curl https://api.cineamo.com/cinemas/:cinemaId/newsletter/subscription-stats

Example Responses

{
  "totalConfirmed": 0,
  "totalPending": 0,
  "generalSubscribers": 0,
  "byType": {
    "key": 0
  }
}

application/json

Create a resend

POST

https://api.cineamo.com

/newsletter/webhooks/resend

Receive Resend.com webhook events for newsletter delivery tracking.

Create a resend › Request Body

type

string

created_at

string

object

Create a resend › Responses

200

Event processed

No data returned

POST/newsletter/webhooks/resend

curl https://api.cineamo.com/newsletter/webhooks/resend \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "email.delivered",
  "created_at": "2026-01-01T00:00:00.000Z",
  "data": {
    "email_id": "56761188-7520-42d8-8898-ff6fc54ce618",
    "from": "Cinema <news@cinema.com>",
    "to": "[\"subscriber@example.com\"]",
    "subject": "Weekly Newsletter"
  }
}'

Example Request Body

{
  "type": "email.delivered",
  "created_at": "2026-01-01T00:00:00.000Z",
  "data": {
    "email_id": "56761188-7520-42d8-8898-ff6fc54ce618",
    "from": "Cinema <news@cinema.com>",
    "to": "[\"subscriber@example.com\"]",
    "subject": "Weekly Newsletter"
  }
}

Example Responses

No example specified for this content type

Upload Notifications

Newsletter

Approve newsletter campaign

Approve newsletter campaign › path Parameters

Approve newsletter campaign › Responses

List newsletter campaigns

List newsletter campaigns › path Parameters

List newsletter campaigns › query Parameters

List newsletter campaigns › Responses

Create a newsletter campaign

Create a newsletter campaign › path Parameters

Create a newsletter campaign › Request Body

Create a newsletter campaign › Responses

Get a newsletter campaign

Get a newsletter campaign › path Parameters

Get a newsletter campaign › query Parameters

Get a newsletter campaign › Responses

Delete a newsletter campaign

Delete a newsletter campaign › path Parameters

Delete a newsletter campaign › Responses

Update a newsletter campaign

Update a newsletter campaign › path Parameters

Update a newsletter campaign › Request Body

Update a newsletter campaign › Responses

Send newsletter campaign

Send newsletter campaign › path Parameters

Send newsletter campaign › Request Body optional

Send newsletter campaign › Responses

Skip newsletter campaign

Skip newsletter campaign › path Parameters

Skip newsletter campaign › Responses

Get a newsletter config

Get a newsletter config › path Parameters

Get a newsletter config › Responses

Create or update a newsletter config

Create or update a newsletter config › path Parameters

Create or update a newsletter config › Request Body

Create or update a newsletter config › Responses

List newsletter sections

List newsletter sections › path Parameters

List newsletter sections › query Parameters

List newsletter sections › Responses

Create a newsletter section

Create a newsletter section › path Parameters

Create a newsletter section › Request Body

Create a newsletter section › Responses

Get a newsletter section

Get a newsletter section › path Parameters

Get a newsletter section › Responses

Delete a newsletter section

Delete a newsletter section › path Parameters

Delete a newsletter section › Responses

Update a newsletter section

Update a newsletter section › path Parameters

Update a newsletter section › Request Body

Update a newsletter section › Responses

Get a confirm

Get a confirm › path Parameters

Get a confirm › Responses

Post confirm

Post confirm › path Parameters

Post confirm › Responses

Create a subscribe

Create a subscribe › Request Body

Create a subscribe › Responses

List subscriber status

List subscriber status › path Parameters

List subscriber status › query Parameters

List subscriber status › Responses

List newsletter subscribers

List newsletter subscribers › path Parameters

List newsletter subscribers › query Parameters

List newsletter subscribers › Responses

Get a newsletter subscriber

Get a newsletter subscriber › path Parameters

Get a newsletter subscriber › Responses

Delete a newsletter subscriber

Delete a newsletter subscriber › path Parameters

Delete a newsletter subscriber › Responses

Look up an unsubscribe token

Look up an unsubscribe token › path Parameters