All API methods require an HTTP
User-Agent header and a token to execute.
All requests without a user-agent header will fail with a 403 Forbidden HTTP response status code.
A maximum of 240 requests will be processed per minute. All requests exceeding this limit will return an HTTP response status code 429.
A token is obtained by calling the authenticate
method.
Please check out the authentication method's documentation for instructions on its use.
If you wish to use the Meetingmax API to integrate with us, credentials must first be created by the Meetingmax licensee via the MCP application interface.
https://mmxreservations.com/api/v102
The Reservation Attendee Integration is a way to provide customer details to the Meetingmax system prior to them beginning the reservation process. Systems that wish to use the Reservation Attendee Integration will need to leverage the Meetingmax API in order to provide the customer details and to generate the unique URL that the system would send customers to in order to book their reservation.
When a customer has already provided their contact details in your own event management system, you can streamline their process when making their reservation by providing Meetingmax their contact information.
Once the customer data has been successfully inserted into the Meetingmax system, you can then generate a special URL based on their attendee identifier. When the customer goes to this URL, they will then be able to go through the reservation process, except that their contact information will already be loaded into the personal contact fields based on what was provided earlier.
This method assigns a token to be used for all other methods. Tokens are only active for 30 minutes, after which a new token must be acquired.
required |
This is the value provided to you within the MCP under the API tab. |
required |
The Meetingmax licensee number to create a token for. |
https://mmxreservations.com/api/v102/authenticate
$ curl https://mmxreservations.com/api/v102/authenticate /
-d key=ABC123 /
-d systemIdentifier=1
{
"token": "qt4oectadqdc6g4lalhezzk1pa5aa6iv"
}
Events are core to Meetingmax. You can use the API to retrieve event information including the event name, address and start/end dates.
This method retrieves the details for a given event.
required |
The token provided by the authenticate method. |
required |
The event ID to retrieve data for. |
https://mmxreservations.com/api/v102/getevent
$ curl https://mmxreservations.com/api/v102/getevent /
-d token=qt4oectadqdc6g4lalhezzk1pa5aa6iv /
-d eventId=14
{
"eventId": 14,
"name": "Stanley Cup Finals",
"city": "Vancouver",
"state": "BC",
"address": "800 Griffiths Way",
"zip": "V6B 6G1",
"startDate": "2020-02-04T00:00:00+00:00",
"endDate": "2020-02-08T00:00:00+00:00",
"cutOffDate": "2020-02-03T00:00:00+00:00"
}
This method will return all group codes for the specified event.
required |
The token provided by the authenticate method. |
required |
The event ID to retrieve data for. |
https://mmxreservations.com/api/v102/getgroupcodes
This method registers a question for an event or a default question for all events.
required |
The token provided by the authenticate method. |
required |
The event ID the question will be registered for. Provide an event ID of 0 to register a default question for all events. |
required |
A numeric question ID assigned to the question in your system. This ID will be provided back when requesting answers to this question. |
required |
The question that will be presented to the user during the reservation process. |
required |
A string representing the type of input element to be provided to the user used to answer the question. Allowed types are: |
required for type 2 |
Options are only required when a select element is chosen for the type. The option list to display in the select element must be provided in JSON format. For example, provide |
required |
A boolean |
https://mmxreservations.com/api/v102/posteventquestion
This method will retrieve the questions that have been set for an event or set as a default for all events. Providing an eventId of 0 will return only the default questions.
required |
The token provided by the authenticate method. |
required |
This is the event ID that the questions were made for. Providing an event ID of 0 will return questions that would be displayed to all events. |
https://mmxreservations.com/api/v102/geteventquestions
This method provides the room pickup for a given event broken down into hotels and room types.
required |
The token provided by the authenticate method. |
required |
The event ID to retrieve the room pickup information for. |
https://mmxreservations.com/api/v102/getpickup
This method allows you to provide actual pickup numbers for hotels on specific dates. These numbers can then be compared internally with the Meetingmax pickup numbers to highlight any discrepancies.
NOTE: Because of the complexity of providing actualized values as an array, you may want to consider providing those values within a JSON payload in the body of the request.
required |
The token provided by the authenticate method. |
required |
The event ID to set actualized numbers for. |
required |
The hotel ID the actualized numbers are for. |
required |
An array containing |
https://mmxreservations.com/api/v102/posteventhotelactualized
You may interact and retrieve information about your current hotel selection using the hotel methods here.
This method retrieves the details of hotels that are currently assigned to an event.
required |
The token provided by the authenticate method. |
required |
The event ID to retrieve data for. |
optional default: false |
A boolean, if true, will respond with the Simpleview identifier for each hotel listed. |
optional |
This integer will filter the results by whichever hotel ID is provided. |
optional |
A string containing the hotel name to filter the results on. |
optional |
String representing the city of the hotels to filter results on. |
optional |
String representing the state or province to filter the hotel results on. |
optional |
This is a string representing the current status of the hotels you would like returned as a result. By default, all statuses will be returned. Allowed statuses are: |
https://mmxreservations.com/api/v102/gethotels
The shopping view allows your visitors to get a sense of what hotels are available before committing to making a reservation for an event.
This method retrieves the hotels to display in the shopping view. Omitting the dates will list all the hotels that have been added to the event.
The hotels in the event must have the Show Hotel Under Shopping View checkbox selected in order to be included in the list.
When dates are provided, inventory is checked for the main block, and only hotels with inventory will be included. All rooms available for the dates (and their rates) will be included.
required |
The token provided by the authenticate method. |
required |
The event ID to retrieve data for. |
optional |
The check-in date for the availability search. Format must be |
optional |
The check-out date for the availability search. Format must be |
optional default: full |
This is a string used to return a condensed version or the full set of data. Allowed scopes are: |
optional default: false |
When true, include results for any hotels that are past cut-off. |
https://mmxreservations.com/api/v102/getshoppingviewhotels
When a customer books one or more rooms in the Meetingmax system, a new reservation object is created. Reservations objects can be looked up through the API method below.
This method retrieves the details for reservations.
A result set larger than 1000 records will be
paginated accordingly, and require the optional page
parameter.
required |
The token provided by the authenticate method. |
required |
The event ID to retrieve data for. |
optional default: false |
A boolean, when true, will provide additional information regarding the reservation contact (such as their address, company name, and preferred guest number). |
optional default: false |
If true, will provide additional event information for the reservation. |
optional default: false |
If true, will provide additional hotel information for the reservation. |
optional default: false |
If true, will provide additional sub-block information for the reservation. |
optional default: false |
This is a boolean value, when true, it will provide any custom fields associated with the current reservation in the results. |
optional default: false |
A boolean, if true, will respond with the Simpleview identifier for each hotel listed. |
optional default: 1 |
An integer representing the current page of results to return. |
optional |
An integer representing a specific reservation to return information on. |
optional |
This integer will filter the results by whichever hotel ID is provided. |
optional |
A string containing the contact's email address that the results will be filtered on. |
optional |
A string containing the contact's last name that the results will be filtered on. |
optional |
A string containing the guest's last name that the results will be filtered on. |
optional |
This is an optional string containing the confirmation number assigned by the hotel to filter the results on. |
optional |
A string containing the group code (assigned to a particular sub-block) to filter the results on. |
optional |
Reservations you would like returned as a result. By default, all statuses will be returned. Allowed statuses are: |
optional |
A string representing the status of a room in a given reservation. By default, all room statuses are allowed. Allowed statuses are: |
optional |
A string containing the company name to filter the results for. |
optional |
The value of label1 to filter the results on. |
optional |
The value of label2 to filter the results on. |
optional |
This is the attendee ID that was provided to the system when the attendee was added to the system (prior to the reservation being created) and by providing this value the results will be filtered on any reservations this attendee is attached to. |
optional |
Only fetch reservations with modifications since the given timestamp. Timestamp must be in the format: |
https://mmxreservations.com/api/v102/getreservation
This method retrieves the number of pages in the reservation result set paginated every 1000 records.
required |
The token provided by the authenticate method. |
required |
The event ID to retrieve data for. |
optional |
An integer representing a specific reservation to return information on. |
optional |
This integer will filter the results by whichever hotel ID is provided. |
optional |
A string containing the contact's email address that the results will be filtered on. |
optional |
A string containing the contact's last name that the results will be filtered on. |
optional |
A string containing the guest's last name that the results will be filtered on. |
optional |
This is an optional string containing the confirmation number assigned by the hotel to filter the results on. |
optional |
A string containing the group code (assigned to a particular sub-block) to filter the results on. |
optional |
This is a specific string representing the status of the reservations you would like returned as a result. By default, all statuses will be returned. Allowed statuses are: |
optional |
A string representing the status of a room in a given reservation. By default, all room statuses are allowed. Allowed statuses are: |
optional |
A string containing the company name to filter the results for. |
optional |
The value of label1 to filter the results on. |
optional |
The value of label2 to filter the results on. |
optional |
This is the attendee ID that was provided to the system when the attendee was added to the system (prior to the reservation being created) and by providing this value the results will be filtered on any reservations this attendee is attached to. |
optional |
Only fetch reservations with modifications since the given timestamp. Timestamp must be in the format: |
https://mmxreservations.com/api/v102/getreservationpagecount
This method generates the link to make a reservation for an event. If the attendee ID and registration system event ID are provided, that attendee's data will be automatically populated in the reservation process.
required |
The token provided by the authenticate method. |
optional |
The event ID to generate the link for. If not provided, a link to the event selection page will be returned. |
optional; required if providing registrationEventId |
The reference to the attendee to automatically populate fields in the registration process with. If providing the attendee ID you must also provide the registration event ID. |
optional; required if providing attendeeId |
The registration system's event ID that is associated with the provided attendee ID. |
https://mmxreservations.com/api/v102/geteventlink
This method generates the link to make a reservation for an event specific to a group code for its special inventory.
required |
The token provided by the authenticate method. |
required |
The event ID to create the registration link for. |
required |
The group code that will be used to generate the reservation link for. This will allow access to its special inventory. |
required |
The reference to the attendee to automatically populate fields in the registration process with. |
required |
The registration system's event ID that is associated with the provided attendee ID. |
https://mmxreservations.com/api/v102/getgroupcodelink
Retrieves the link to edit a particular reservation based on the provided reservation number.
required |
The token provided by the authenticate method. |
required |
The reservation number to retrieve the link for. |
https://mmxreservations.com/api/v102/geteditreservationlink
Due to the General Data Protection Regulation (GDPR) the Mailing List Opt-in functionality is no longer available.
https://mmxreservations.com/api/v102/postmailinglistoptin
Due to the General Data Protection Regulation (GDPR) the Mailing List Opt-in functionality is no longer available.
https://mmxreservations.com/api/v102/getmailinglistoptin
Due to the General Data Protection Regulation (GDPR) the Mailing List Opt-in functionality is no longer available.
https://mmxreservations.com/api/v102/getmailinglistoptinpagecount
This method allows you to add additional fields to be associated with a reservation or attendee.
required |
The token provided by the authenticate method. |
required |
This is a string representing the name of the custom field to be added. It will also appear within the MCP's advanced search form as a field name. |
optional |
Providing the event ID will associate the custom field with that particular event and not allow it to be displayed for reservations of other events. |
https://mmxreservations.com/api/v102/postcustomfield
This method returns all the custom fields registered for all events.
If an event ID is provided, only those custom fields specific to that event will be returned.
required |
The token provided by the authenticate method. |
required |
If provided, the results will be filtered on the event ID specified here. |
https://mmxreservations.com/api/v102/getcustomfields
This method will register a value to an existing custom field for an attendee or reservation.
This method requires either the reservation ID or the registration system event ID and the attendee ID.
required |
The token provided by the authenticate method. |
required |
The ID of the custom field to register a value for. |
required |
The value to register for the specified custom field. |
required if not providing attendeeId and registrationEventId |
This is the reservation ID of the reservation to apply the custom field value to. |
required if not providing reservationId |
This is the attendee ID to apply the custom field value to. |
required if not providing reservationId |
This is the registration system's event ID (external to the Meetingmax system) to apply the custom field value to. |
https://mmxreservations.com/api/v102/postcustomfieldvalue
This method generates a link to transfer a given reservation to a new attendee.
required |
The token provided by the authenticate method. |
required |
The reservation ID to generate the link for. |
required |
The reference to the attendee that you wish to transfer the reservation to. |
required |
The registration system's event ID that is associated with the provided attendee ID. |
https://mmxreservations.com/api/v102/gettransferlink
$ curl https://mmxreservations.com/api/v102/gettransferlink /
-d token=qt4oectadqdc6g4lalhezzk1pa5aa6iv /
-d reservationId=1234 /
-d attendeeId=1 /
-d registrationEventId=1
{
"url": "https:\/\/mmxreservations.com\/development123\/admin\/reservation\/transfer\/reservationId\/1234\/attendeeId\/1\/registrationEventId\/1"
}
Attendees are those who end up making the reservations for your event. You can get attendee information and anything presented to attendees (like questions) through this API.
This method creates an attendee in the Meetingmax system which is then used to pre-populate fields during the registration process. This method is also used to perform updates on existing attendees (as long as the attendee ID and registration event ID match a record in the system).
Due to the Meetingmax personal information policy, the data provided through this API call will be scrubbed from the system 90 days after the event it's attached to has ended, or 90 days after the last time that this record has been updated.
required |
The token provided by the authenticate method. |
required |
The attendee ID that is assigned to the registration. This ID is an external value that is used to reference the attendee in original system. |
required |
This is the event ID assigned to the registration in the registration system. This ID is an external value provided by the registration system and should not be confused with a Meetingmax event ID. |
optional default: false |
When updating an existing attendee, this parameter can be used to push the data to the linked reservation, if one exists. |
optional |
The email address for the contact. |
optional |
The contact's credit card email address (use a comma-separated list for more than one). |
optional |
The salutation for the contact. |
optional |
The first name for the contact. |
optional |
The last name for the contact. |
optional |
The company name for the contact. |
optional |
First line of the contact's address. |
optional |
Second line of the contact's address. |
optional |
The city for the contact. |
optional |
The state or province for the contact. |
optional |
The zip or postal code for the contact. |
optional |
The country for the contact. This can be its full name, or be in either ISO2 or ISO3 format. |
optional |
The phone number for the contact. |
https://mmxreservations.com/api/v102/postattendee
This method will retrieve answers provided by customers during the reservation process for the any event questions provided.
required |
The token provided by the authenticate method. |
required |
The event ID to retrieve data for. |
optional default: 1 |
An integer representing the current page of results to return. |
https://mmxreservations.com/api/v102/getattendeeanswers
This method retrieves the number of pages in the result set paginated every 1000 records.
required |
The token provided by the authenticate method. |
required |
The event ID to retrieve data for. |
https://mmxreservations.com/api/v102/getattendeeanswerspagecount