Subscription

V2

The subscription endpoints provide access to Opt-In/Opt-out of subscription-based communications


Endpoints

Verb Endpoint Description
GET /v2/subscriptions?[email-address={email-address} | phone-number={phone-number} | audience={guest | stubs}] Returns subscription items available based upon the search criteria. At least one query parameter is required and only the first is recognized.
GET /v2/subscriptions/{subscription-name} Returns subscription for the given subscription name.
GET /v2/subscriber-profile/subscriptions?[email-address={email-address} | phone-number={phone-number} Returns subscription for the given subscription based on email or phone.
POST /v2/subscriptions/{subscription-name}/{channel-type}/{email-address | phone-number} Opt-in a subscription.
GET /v2/subscriptions/{subscription-name}/{channel-type}/{email-address | phone-number} Gets the membership status for a subscription.
DELETE /v2/subscriptions/{subscription-name}/{channel-type}/{email-address | phone-number} Opt-out from a subscription.
DELETE /v2/subscriptions/[email-address-{email-address} | phone-number-{phone-number}] Opt-out from all subscriptions for email or sms.

Subscription Route Values (Required)

  • You must supply a subscription-name route value when retrieving a specific subscription. The subscription-name is the publicly-used unique identifier for the desired subscription.
    • If an unknown value is used, a 404 error is returned.
  • You must supply a channel-type route value. The channel-type defines which subscription channel to use when opting-in, opting-out or checking the subscription status..
    • If an unknown value is used, a 404 error is returned.
    • Options Include:
      • email
      • sms
      • smsConfirm
  • You must supply a email-address route value when retrieving subscriptions for a specific user or when opting-in or opting-out of an email subscription. The email-address is a user's email address..
    • If an unknown or ill-formatted value is used, a 404 error is returned.
  • You must supply a phone-number route value when opting-in or opting-out of an sms subscription. The phone-number is a user's phone number.
    • If an unknown or ill-formatted value is used, a 404 error is returned.

Subscription Query Parameters

  • You may optionally supply a email-address query string parameter to return subscriptions available to the given email address. Subscriptions will include all available channels with any known contact information..
  • You may optionally supply a phone-number query string parameter to return subscriptions available to the given phone number. Subscriptions will include all available channels with any known contact information..
  • You may optionally supply a audience query string parameter to return subscriptions for a particular audience. Subscriptions and their channels will be returned without any contact information.
    • Options Include:
      • stubs
      • guest

Subscription Properties

Name Description
pageSize The number of results included for each page, up to a maximum of 100. Defaults to 10.
pageNumber The page number returned.
count The total number of results available across all pages.
_embedded.Subscription A list of Subscription Representations returned.

Subscription Links

Relation Description Verbs Templated
self The current list of subscription results. GET No
previous The previous page of subscription results. GET No
next The next page of subscription results. GET No
https://api.amctheatres.com/rels/v2/subscriptions-optout-all-email Opt-out of all email and sms subscriptions using email identifier. DELETE No
https://api.amctheatres.com/rels/v2/subscriptions-optout-all-sms Opt-out of all email and sms subscriptions using phone number identifier. DELETE No

Subscription


Subscription Properties

Name Description
description Description of subscription
name Publicly-used unique identifier for the given subscription
_embedded.Channels A list of Channel Representations returned.


Subscription Links

Relation Description Methods Templated
self The current subscription representation. GET No

Channel


Channel Properties

Name Description
audience Audience of subscription
  • guest
  • stubs
contactIdentifier Contact identification for subscription whether it be an email address or phone number.
isContactEnrolled Returns whether the contact identifier is enrolled in the given subscription
type Type of subscription.
  • email
  • sms
  • smsConfirm
confirmed Indicates whether the susbcriber has confirmed this channel (only applies to SMS).


Channel Links

Relation Description Methods Templated
self The current subscription channel representation. GET, POST, DELETE No

Examples

Returns all subscription items available for email address.
GET  https://api.amctheatres.com/v2/subscriptions?email-address=developer@amctheatres.com

Response

{
  "pageSize": 3,
  "pageNumber": 1,
  "count": 5,
  "_links": {
    "self": {
      "href": "http://api.amctheatres.com/v2/subscriptions?email-address=developer@amctheatres.com&page-number=1&page-size=3",
      "templated": false
    },
    "next": {
      "href": "http://api.amctheatres.com/v2/subscriptions?email-address=developer@amctheatres.com&page-number=2&page-size=3",
      "templated": false
    }
  },
  "_embedded": {
    "subscriptions": [
      {
        "description": "Amc's weekly wrap-up newsletter",
        "name": "amc-weekly-wrap-up",
        "channels": [
          {
            "audience": "stubs",
            "isContactEnrolled": true,
            "type": "email",
            "contactIdentifier": "developer@amctheatres",
            "_links": {
              "self": {
                "href": "api.amctheatres.com/v2/subscriptions/amc-weekly-wrap-up/email/developer@amctheatres",
                "templated": false
              }
            }
          }
        ],
        "_links": {
          "self": {
            "href": "api.amctheatres.com/v2/subscriptions/amc-weekly-wrap-up",
            "templated": false
          }
        }
      },
      {
        "description": "5-hour Member Alert List",
        "name": "amc-stubs-5hour-alert",
        "channels": [
          {
            "audience": "stubs",
            "isContactEnrolled": true,
            "type": "sms",
            "contactIdentifier": "9135551212",
            "confirmed": true,
            "_links": {
              "self": {
                "href": "api.amctheatres.com/v2/subscriptions/amc-stubs-5hour-alert/sms/9135551212",
                "templated": false
              }
            }
          },
          {
            "audience": "stubs",
            "isContactEnrolled": false,
            "type": "email",
            "contactIdentifier": "developer@amctheatres",
            "_links": {
              "self": {
                "href": "api.amctheatres.com/v2/subscriptions/amc-stubs-5hour-alert/email/developer@amctheatres",
                "templated": false
              }
            }
          }
        ],
        "_links": {
          "self": {
            "href": "api.amctheatres.com/v2/subscriptions/amc-stubs-5hour-alert",
            "templated": false
          }
        }
      },
      {
        "description": "Upcoming and What's New!",
        "name": "upcoming-whats-new",
        "channels": [
          {
            "audience": "stubs",
            "isContactEnrolled": true,
            "type": "email",
            "contactIdentifier": "developer@amctheatres",
            "_links": {
              "self": {
                "href": "api.amctheatres.com/v2/subscriptions/upcoming-whats-new/email/developer@amctheatres",
                "templated": false
              }
            }
          }
        ],
        "_links": {
          "self": {
            "href": "api.amctheatres.com/v2/subscriptions/upcoming-whats-new",
            "templated": false
          }
        }
      }
    ]
  }
}
Returns all subscription items available for a guest.
GET  https://api.amctheatres.com/v2/subscriptions?audience=guest

Response

{
  "pageSize": 3,
  "pageNumber": 2,
  "count": 7,
  "_links": {
    "self": {
      "href": "http://api.amctheatres.com/v2/subscriptions?audience=stubs&page-number=2&page-size=3",
      "templated": false
    },
    "previous": {
      "href": "http://api.amctheatres.com/v2/subscriptions?audience=stubs&page-number=1&page-size=3",
      "templated": false
    },
    "next": {
      "href": "http://api.amctheatres.com/v2/subscriptions?audience=stubs&page-number=3&page-size=3",
      "templated": false
    }
  },
  "_embedded": {
    "subscriptions": [
      {
        "description": "Amc's weekly wrap-up newsletter",
        "name": "amc-weekly-wrap-up",
        "channels": [
          {
            "audience": "guest",
            "type": "email",
            "_links": {
              "self": {
                "href": "api.amctheatres.com/v2/subscriptions/amc-weekly-wrap-up/email",
                "templated": false
              }
            }
          }
        ],
        "_links": {
          "self": {
            "href": "api.amctheatres.com/v2/subscriptions/amc-weekly-wrap-up",
            "templated": false
          }
        }
      },
      {
        "description": "Join Stubs Program and Save",
        "name": "amc-guest-subscribe",
        "channels": [
          {
            "audience": "guest",
            "type": "sms",
            "_links": {
              "self": {
                "href": "api.amctheatres.com/v2/subscriptions/amc-stubs-subscribe/sms",
                "templated": false
              }
            }
          },
          {
            "audience": "guest",
            "type": "email",
            "_links": {
              "self": {
                "href": "api.amctheatres.com/v2/subscriptions/amc-stubs-subscribe/email",
                "templated": false
              }
            }
          }
        ],
        "_links": {
          "self": {
            "href": "api.amctheatres.com/v2/subscriptions/amc-stubs-subscribe",
            "templated": false
          }
        }
      },
      {
        "description": "Upcoming and What's New!",
        "name": "upcoming-whats-new",
        "channels": [
          {
            "audience": "guest",
            "type": "email",
            "_links": {
              "self": {
                "href": "api.amctheatres.com/v2/subscriptions/upcoming-whats-new/email",
                "templated": false
              }
            }
          }
        ],
        "_links": {
          "self": {
            "href": "api.amctheatres.com/v2/subscriptions/upcoming-whats-new",
            "templated": false
          }
        }
      }
    ]
  }
}
Returns all subscription items available for phone number.
GET  https://api.amctheatres.com/v2/subscriptions?phone-number=9135551212

Response

{
  "pageSize": 10,
  "pageNumber": 1,
  "count": 6,
  "_links": {
    "self": {
      "href": "http://api.amctheatres.com/v2/subscriptions?phone-number=9135551212&page-number=1&page-size=10",
      "templated": false
    }
  },
  "_embedded": {
    "subscriptions": [
      {
        "description": "Send me the latest movie news in the AMC newsletter",
        "name": "stubs-newsletter",
        "_embedded": {
          "channels": [
            {
              "audience": "stubs",
              "contactIdentifier": "amcDeveloper@amctheatres.com",
              "isContactEnrolled": false,
              "type": "email",
              "_links": {
                "self": {
                  "href": "http://api.amctheatres.com/v2/subscriptions/stubs-newsletter/email/amcDeveloper@amctheatres.com",
                  "templated": false
                }
              }
            }
          ]
        },
        "_links": {
          "self": {
            "href": "http://api.amctheatres.com/v2/subscriptions/stubs-newsletter",
            "templated": false
          }
        }
      },
      {
        "description": "Tell me about exclusive AMC promotions and offers",
        "name": "stubs-offers",
        "_embedded": {
          "channels": [
            {
              "audience": "stubs",
              "contactIdentifier": "amcDeveloper@amctheatres.com",
              "isContactEnrolled": false,
              "type": "email",
              "_links": {
                "self": {
                  "href": "http://api.amctheatres.com/v2/subscriptions/stubs-offers/email/amcDeveloper@amctheatres.com",
                  "templated": false
                }
              }
            },
            {
              "audience": "stubs",
              "contactIdentifier": "9135551212",
              "isContactEnrolled": false,
              "type": "sms",
              "_links": {
                "self": {
                  "href": "http://api.amctheatres.com/v2/subscriptions/stubs-offers/sms/9135551212",
                  "templated": false
                }
              }
            }
          ]
        },
        "_links": {
          "self": {
            "href": "http://api.amctheatres.com/v2/subscriptions/stubs-offers",
            "templated": false
          }
        }
      },
      {
        "description": "Let me know when I receive an AMC Stubs rewards",
        "name": "stubs-rewards",
        "_embedded": {
          "channels": [
            {
              "audience": "stubs",
              "contactIdentifier": "amcDeveloper@amctheatres.com",
              "isContactEnrolled": false,
              "type": "email",
              "_links": {
                "self": {
                  "href": "http://api.amctheatres.com/v2/subscriptions/stubs-rewards/email/amcDeveloper@amctheatres.com",
                  "templated": false
                }
              }
            },
            {
              "audience": "stubs",
              "contactIdentifier": "9135551212",
              "isContactEnrolled": false,
              "type": "sms",
              "confirmed": true,
              "_links": {
                "self": {
                  "href": "http://api.amctheatres.com/v2/subscriptions/stubs-rewards/sms/9135551212",
                  "templated": false
                }
              }
            }
          ]
        },
        "_links": {
          "self": {
            "href": "http://api.amctheatres.com/v2/subscriptions/stubs-rewards",
            "templated": false
          }
        }
      },
      {
        "description": "Keep me in the loop with AMC Stubs account updates",
        "name": "stubs-updates",
        "_embedded": {
          "channels": [
            {
              "audience": "stubs",
              "contactIdentifier": "amcDeveloper@amctheatres.com",
              "isContactEnrolled": false,
              "type": "email",
              "_links": {
                "self": {
                  "href": "http://api.amctheatres.com/v2/subscriptions/stubs-updates/email/amcDeveloper@amctheatres.com",
                  "templated": false
                }
              }
            }
          ]
        },
        "_links": {
          "self": {
            "href": "http://api.amctheatres.com/v2/subscriptions/stubs-updates",
            "templated": false
          }
        }
      }
    ]
  }
}
Return subscription for subscription name.
GET  https://api.amctheatres.com/v2/subscriptions/amc-weekly-wrap-up

Response

{
  "description": "Amc's weekly wrap-up newsletter",
  "name": "amc-weekly-wrap-up",
  "channels": [
    {
      "audience": "stubs",
      "type": "email",
      "_links": {
        "self": {
          "href": "api.amctheatres.com/v2/subscriptions/amc-weekly-wrap-up/email",
          "templated": false
        }
      }
    },
    {
      "audience": "guest",
      "type": "sms",
      "_links": {
        "self": {
          "href": "api.amctheatres.com/v2/subscriptions/amc-weekly-wrap-up/sms",
          "templated": false
        }
      }
    }
  ],
  "_links": {
    "self": {
      "href": "api.amctheatres.com/v2/subscriptions/amc-weekly-wrap-up",
      "templated": false
    }
  }
}
Return subscription from subscriber profile by email address.
GET  https://api.amctheatres.com/v2/subscriber-profile/subscriptions?email=customer@amctheatres.com

Response

{
  "pageSize": 10,
  "pageNumber": 1,
  "count": 1,
  "_links": {
    "self": {
      "href": "http://devweb.homeoffice.amc.corp:4000/v2/subscriptions?email-address=dev3rmd@yahoo.com&page-number=1&page-size=10",
      "templated": false
    }
  },
  "_embedded": {
    "subscribers": [
      {
        "subscriberProfileId": 1234,
        "loyaltyAccountId": 123456789123456,
        "accountId": 5829,
        "emailAddressText": "acmdeveloper.com",
        "mobilePhoneNumber": "9138675309",
        "activeIndicator": true,
        "accountStatusDescription": "Active",
        "accountStatusName": "Active",
        "firstName": "f",
        "lastName": "l",
        "birthDate": "1993-02-06T00:00:00Z",
        "favoriteTheatreNumber": 38,
        "favoriteTheatreShortName": "AMC Town Center 20",
        "preferredSmsSubscriberProfileIndicator": false,
        "creationDate": "0001-01-01T00:00:00Z"
      }
    ]
  }
}
Return subscription from subscriber profile by phone number.
GET  https://api.amctheatres.com/v2/subscriber-profile/subscriptions?phone-number=9138675309

Response

{
  "pageSize": 10,
  "pageNumber": 1,
  "count": 1,
  "_links": {
    "self": {
      "href": "http://devweb.homeoffice.amc.corp:4000/v2/subscriptions?email-address=dev3rmd@yahoo.com&page-number=1&page-size=10",
      "templated": false
    }
  },
  "_embedded": {
    "subscribers": [
      {
        "subscriberProfileId": 1234,
        "loyaltyAccountId": 123456789123456,
        "accountId": 5829,
        "emailAddressText": "acmdeveloper.com",
        "mobilePhoneNumber": "9138675309",
        "activeIndicator": true,
        "accountStatusDescription": "Active",
        "accountStatusName": "Active",
        "firstName": "f",
        "lastName": "l",
        "birthDate": "1993-02-06T00:00:00Z",
        "favoriteTheatreNumber": 38,
        "favoriteTheatreShortName": "AMC Town Center 20",
        "preferredSmsSubscriberProfileIndicator": false,
        "creationDate": "0001-01-01T00:00:00Z"
      }
    ]
  }
}
Opt-in a subscription that uses an email.
POST  https://api.amctheatres.com/v2/subscriptions/amc-email-signup/email/customer@amctheatres.com

Response

HTTP/1.1 201 Created
Location: https://api.amctheatres.com/subscriptions/amc-email-signup/email/customer@amctheatres.com
Opt-in a subscription that uses sms.
POST  https://api.amctheatres.com/v2/subscriptions/sms-general/sms/9135551212

Response

HTTP/1.1 201 Created
Location: https://api.amctheatres.com/subscriptions/sms-general/sms/9135551212
Gets the membership status for an email subscription.
GET  https://api.amctheatres.com/v2/subscriptions/amc-email-signup/email/customer@amctheatres.com

Response

{
  "audience": "guest",
  "isContactEnrolled": false,
  "type": "email",
  "contactIdentifier": "customer@amctheaters.com",
  "_links": {
    "self": {
      "href": "api.amctheatres.com/v2/subscriptions/upcoming-whats-new/email/customer@amctheaters.com",
      "templated": false
    }
  }
}
Gets the membership status for an sms subscription.
GET  https://api.amctheatres.com/v2/subscriptions/sms-general/sms/9135551212

Response

{
  "audience": "stubs",
  "isContactEnrolled": true,
  "type": "sms",
  "contactIdentifier": "9135551212",
  "_links": {
    "self": {
      "href": "api.amctheatres.com/v2/subscriptions/amc-stubs-5hour-alert/sms/9135551212",
      "templated": false
    }
  }
}
Opt-out membership from an email subscription.
DELETE  https://api.amctheatres.com/v2/subscriptions/amc-email-signup/email/customer@amctheatres.com

Response

HTTP/1.1 200 OK
Opt-out membership from an sms subscription.
DELETE  https://api.amctheatres.com/v2/subscriptions/sms-general/sms/9135551212

Response

HTTP/1.1 200 OK
Opt-out membership from all email subscriptions using email identifier.
DELETE  https://api.amctheatres.com/v2/subscriptions/email-address-customer@amctheatres.com

Response

HTTP/1.1 200 OK
Opt-out membership from all sms subscriptions using phone number identifier.
DELETE  https://api.amctheatres.com/v2/subscriptions/phone-number-9135551212

Response

HTTP/1.1 200 OK