Events

Events (Meetings & Shows) (v1-2025-04-18)

The Meetings & Shows, or Events, API is used to manage all aspects of events from recurring webinars to annual trade shows. From this API you can access Registrants, Speakers, and Abstracts as well as update the details of your events themselves.

Like most of the other Rhythm apps, the Events API includes endpoints for Query Definitions. These endpoints are commonly used to retrieve saved queries, which can then be executed using the Query endpoints of the System API.

Download OpenAPI description

events-v1.json

events-v1.yaml

Servers

Mock server

https://docs.api.rhythmsoftware.com/_mock/apis/events/events-v1/

https://events.api.rhythmsoftware.com/

Abstract Approval Processes

Operations

Abstract Decision Processes

Operations

Abstract Review Processes

Operations

Abstract Review Rounds

Operations

Abstract Reviews

Operations

Abstract Settings

Operations

Abstract Submission Processes

Operations

Abstract Types

Operations

Abstracts

Operations

Coupons

Operations

Events

Operations

Exhibitor Add On Products

Operations

Exhibitor Booth Fees

Operations

Exhibitor Booth Types

Operations

Exhibitor Booths

Operations

Exhibitor Categories

Operations

Exhibitor Contact Types

Operations

Exhibitor Priority Point Types

Operations

Exhibitor Reg Processes

Operations

Creates a new exhibitor reg process record that does not already exist.

Request

This method will auto-generate an ID and create a new exhibitor reg process. If an ID is specified for the exhibitor reg process, an error will be thrown.

Path

tenantIdstringrequired

The id of the tenant being accessed.

Bodyapplication/jsonrequired

The exhibitor reg process that you would like to be saved.

add_on_rulesArray of objectsnon-emptyrequired

add_on_rules[].booth_number_restrictionsBooth Number Restrictions (object)(Booth Number Restrictions)

One of:

add_on_rules[].custom_error_messagestring(Custom Error Message)

Optional message to show when restriction is not met

add_on_rules[].expression_restrictionExpression Restriction (object)(Expression Restriction)

One of:

add_on_rules[].idstring(ID)required

add_on_rules[].organization_restrictionsobject(Organization Restrictions)

add_on_rules[].priority_point_restrictionsobject(Priority Point Restrictions)

add_on_rules[].restrict_by_number_of_boothsboolean(Restrict By Number Of Booths)

If true, this rule takes into account the number of booths selected

add_on_rules[].restrict_by_priority_pointsboolean(Restrict By Priority Points)

If true, then we want to restrict b priority points

add_on_rules[].restrict_by_square_footageboolean(Restrict By Square Footage)

add_on_rules[].restrict_to_specific_organizationsboolean(Restrict To Specific Organizations)

If true, only specific organizations have this rule applied to them

add_on_rules[].restriction_typestring(Restriction Type)

Enum"expression""simple"

add_on_rules[].simple_restrictionSimple Restriction (object)(Simple Restriction)

One of:

add_on_rules[].square_footage_restrictionsSquare Footage Restrictions (object)(Square Footage Restrictions)

One of:

booth_hold_timenumber(float)(Booth Hold Time)[ 1 .. 60 ]

The amount of time a booth should be held once selected during a checkout process

booth_type_pricesArray of objectsnon-emptyrequired

booth_type_prices[].booth_fee_idstring(Booth Fee)required

The booth fee associated with this type

booth_type_prices[].booth_type_idstring(Booth Type)required

The booth type

checkout_settingsobject(Checkout Settings)required

checkout_settings.allow_customer_to_choose_installment_planboolean(Allow Customer To Choose Installment Plan)

If true, the customer can choose their installment plan

checkout_settings.bank_account_idstring(Bank Account)required

The default bank account that the store should use to receive payments

checkout_settings.bill_my_organization_optionsobject(Bill My Organization Options)

checkout_settings.bill_my_parent_organization_optionsobject(Bill My Parent Organization Options)

checkout_settings.business_unit_idstring(Business Unit)required

The business unit of the store

checkout_settings.cancellation_fee_product_idstring(Cancellation Fee Product)

The ID of the product used for cancellation fees

checkout_settings.checkout_donation_optionsCheckout Donation Options (object)(Checkout Donation Options)

One of:

checkout_settings.credit_card_minimum_range_endnumber(float)(Credit Card Minimum Range End)

If set, the maximum amount for which credit cards can be taken

checkout_settings.credit_card_minimum_range_startnumber(float)(Credit Card Minimum Range Start)

If set, the minimum amount for which credit cards can be taken

checkout_settings.credit_card_modestring(Credit Card Mode)

Determines whether or not credit cards are accepted

Enum"disabled""enabled""range"

checkout_settings.credit_card_processing_fee_modestring(Credit Card Processing Fee Mode)

Determines how credit card processing fees should be handled

Enum"charge""do not charge""prompt user"

checkout_settings.credit_card_processing_fee_optionsCredit Card Processing Fee Options (object)(Credit Card Processing Fee Options)

One of:

checkout_settings.disable_electronic_payment_vaultingboolean(Disable Electronic Payment Vaulting)

If set, in the portal people are not allowed to save credit cards

checkout_settings.enable_bill_my_organizationboolean(Enable Bill My Organization)

If set, the user has the option to bill their organization

checkout_settings.enable_bill_my_parent_organizationboolean(Enable Bill My Parent Organization)

If set, the user has the option to bill their organization's parent organization

checkout_settings.enable_donations_at_checkoutboolean(Enable Donations At Checkout)

If selected, users will be prompted to make a donation upon checking out

checkout_settings.enable_electronic_checksboolean(Enable Electronic Checks)

If set, electronic checks are allowed

checkout_settings.enable_pay_laterboolean(Enable Pay Later)

If set, pay later is enabled on this checkout regardless of product settings... if not, the product settings are observed

checkout_settings.enable_payroll_deductionboolean(Enable Payroll Deduction)

If set, payroll deduction is allowed

checkout_settings.enable_split_paymentsboolean(Enable Split Payments)

If set, users are allowed to split payments

checkout_settings.installment_plan_optionsArray of objectsnon-empty

One of:

non-empty

checkout_settings.invoice_payment_terms_idstring(Invoice Payment Terms)

The payment terms for invoices; if left blank, default is used

checkout_settings.invoice_template_idstring(Invoice Template)

The template to use for invoices created during this process

checkout_settings.merchant_account_idstring(Merchant Account)required

The merchant account that the store should use to receive payments

checkout_settings.pay_later_optionsobject(Pay Later Options)

checkout_settings.restocking_fee_product_idstring(Restocking Fee Product)

The ID of the product used for restocking fees

checkout_settings.special_instructionsstring(Special Instructions)

Instructions shown to the user

checkout_settings.use_pro_forma_invoicesboolean(Use Pro Forma Invoices)

Whether to use pro forma invoices when user elects to pay later

close_datestring(date-time)(Close Date)required

The date at which the process is closed and no longer available

confirmation_emailobject(Confirmation Email)required

The email to send when the application is received

confirmation_email.bccstring(Bcc)

Anyone that should be bcc'ed on the email

confirmation_email.bodystring(Body)required

The email body

confirmation_email.ccstring(Cc)

Anyone that should be cc'ed on the email

confirmation_email.fromstring(From)

From email address

confirmation_email.from_namestring(From Name)

From name

confirmation_email.reply_tostring(Reply To)

The reply to

confirmation_email.subjectstring(Subject)required

The email subject

contact_form_optionsobject(Contact Form Options)required

contact_form_options.contact_form_idstring(Contact Form)^rolodex-contacts__.*required

The default contact form to present to the user to verify the contact info before proceeding

contact_form_options.htmlstring(Html)

Text to show on the top of the form

custom_confirmation_page_htmlstring(Custom Confirmation Page Html)required

The custom confirmation page HTML

custom_field_valuesArray of objects(Custom Field Values)

descriptionstring(Description)

Description of the process

display_in_portal_asstring(Display In Portal As)

How this process should appear in the portal

display_ordernumber(float)(Display Order)

The display order

eligibility_criteriaobject(Eligibility Criteria)required

The criteria to use

eligibility_criteria.advanced_rule_error_messagestring(Advanced Rule Error Message)

The error message to show when the advanced rule fails

eligibility_criteria.advanced_rulesobject(Advanced Rules)

eligibility_criteria.age_restrictionsobject(Age Restrictions)

eligibility_criteria.award_optionsobject(Award Options)

eligibility_criteria.award_recipientsboolean(Award Recipients)

If set, only people who have received awards

eligibility_criteria.by_locationboolean(By Location)

If true, then filter by location

eligibility_criteria.certificantsboolean(Certificants)

If set, only people with specific certifications

eligibility_criteria.certification_optionsCertification Options (object)(Certification Options)

One of:

eligibility_criteria.committee_member_optionsCommittee Member Options (object)(Committee Member Options)

One of:

eligibility_criteria.committee_membersboolean(Committee Members)

If set, active members who belong to a committee can purchase

eligibility_criteria.custom_logic_optionsCustom Logic Options (object)(Custom Logic Options)

One of:

eligibility_criteria.customer_typestring(Customer Type)

Enum"contact""organization"

eligibility_criteria.donor_optionsobject(Donor Options)

eligibility_criteria.donorsboolean(Donors)

If true, only donors

eligibility_criteria.enable_advanced_rulesboolean(Enable Advanced Rules)

Enable advanced JSON rules

eligibility_criteria.enable_age_restrictionsboolean(Enable Age Restrictions)

Age registrations

eligibility_criteria.enable_custom_logicboolean(Enable Custom Logic)

If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion

eligibility_criteria.enable_entitlement_restrictionsboolean(Enable Entitlement Restrictions)

If set, then you must have certain entitlements

eligibility_criteria.enable_expressionboolean(Enable Expression)

Whether or not to enable an expression for evaluation

eligibility_criteria.enable_organization_restrictionsboolean(Enable Organization Restrictions)

If set, you can restrict organizations

eligibility_criteria.enable_status_restrictionboolean(Enable Status Restriction)

If set, you can restrict by status

eligibility_criteria.entitlement_restrictionsArray of objects

eligibility_criteria.event_registration_optionsobject(Event Registration Options)

eligibility_criteria.event_registrationsboolean(Event Registrations)

If set, only people who have registered for events

eligibility_criteria.expressionstring(Expression)

The expression

eligibility_criteria.expression_error_messagestring(Expression Error Message)

The error message to show when the expression fails

eligibility_criteria.locationLocation (object)(Location)

One of:

eligibility_criteria.logic_operatorstring(Logic Operator)

Enum"and""not"

eligibility_criteria.member_optionsMember Options (object)(Member Options)

One of:

eligibility_criteria.membersboolean(Members)

If set, active members can purchase this

eligibility_criteria.non_membersboolean(Non Members)

If set, only nonmembers can purchase

eligibility_criteria.organization_restrictionsobject(Organization Restrictions)

eligibility_criteria.status_restrictionsArray of Status Restrictions (strings)(Status Restrictions)non-empty

The statuses

One of:

The statuses

non-empty

eligibility_criteria.use_organization_for_eligibilityboolean(Use Organization For Eligibility)

If checked, a person's organization is used to check for eligibility, rather than the person themselves

enable_add_on_rulesboolean(Enable Add On Rules)

If set, you can define rules about how many adds on can or should be selected

enable_confirmation_emailboolean(Enable Confirmation Email)

Whether or not an email should be sent when the application is received

enable_custom_confirmation_page_htmlboolean(Enable Custom Confirmation Page Html)

enable custom text to show on the confirmation page

enable_eligibility_criteriaboolean(Enable Eligibility Criteria)

If set, only certain people can register with this type

event_idstring(Event)required

The event

form_idstring(Form)events-exhibitor-registrations__.*required

The registration form

idstring(ID)required

The unique, string identifier of this exhibitor reg process

is_activeboolean(Is Active)

Whether or not this exhibitor reg process is active

namestring(Name)required

The name of the exhibitor reg process

open_datestring(date-time)(Open Date)required

The date at which the process is open

organization_form_optionsobject(Organization Form Options)required

organization_form_options.htmlstring(Html)

Text to show on the top of the form

organization_form_options.organization_form_idstring(Organization Form)^rolodex-organizations__.*required

The default organization form to present to the user to verify the organization info before proceeding

override_checkout_settingsboolean(Override Checkout Settings)

Whether or not to override POC settings

priority_point_restrictionobject(Priority Point Restriction)required

priority_point_restriction.maximumnumber(float)(Maximum)

The maximum number of points

priority_point_restriction.minimumnumber(float)(Minimum)

The minimum number of points

priority_point_restriction.priority_point_type_idstring(Priority Point Type)required

The type of priority point

restrict_by_priority_pointsboolean(Restrict By Priority Points)

If true, this process is only available to people with a certain number of priority points

selectable_in_portalboolean(Selectable In Portal)

Whether this type can be chosen in the portal

selection_modestring(Selection Mode)required

Determines how the user will select booths for this floor

Enum"select booth types""select booths""virtual show floor"

show_contact_formboolean(Show Contact Form)

Whether or not to show a contact form

show_organization_formboolean(Show Organization Form)

Whether or not to show an organization form

sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/events/events-v1/exhibitorRegProcesses/{tenantId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "add_on_rules": [
      {
        "booth_number_restrictions": {
          "range_end": 0.1,
          "range_start": 0.1
        },
        "custom_error_message": "string",
        "expression_restriction": {
          "expression": "string"
        },
        "id": "string",
        "organization_restrictions": {
          "organization_ids": [
            "string"
          ],
          "restriction_type": "all except specified"
        },
        "priority_point_restrictions": {
          "priority_point_type_id": "string",
          "range_end": 0.1,
          "range_start": 0.1
        },
        "restrict_by_number_of_booths": true,
        "restrict_by_priority_points": true,
        "restrict_by_square_footage": true,
        "restrict_to_specific_organizations": true,
        "restriction_type": "expression",
        "simple_restriction": {
          "add_on_product_ids": [
            "string"
          ],
          "maximum_quantity": 0.1,
          "minimum_quantity": 0.1
        },
        "square_footage_restrictions": {
          "range_end": 0.1,
          "range_start": 0.1
        }
      }
    ],
    "booth_hold_time": 1,
    "booth_type_prices": [
      {
        "booth_fee_id": "string",
        "booth_type_id": "string"
      }
    ],
    "checkout_settings": {
      "allow_customer_to_choose_installment_plan": true,
      "bank_account_id": "string",
      "bill_my_organization_options": {
        "billing_address": "do not show",
        "purchase_order_number": "do not show",
        "reference_number": "string"
      },
      "bill_my_parent_organization_options": {
        "billing_address": "do not show",
        "purchase_order_number": "do not show",
        "reference_number": "string"
      },
      "business_unit_id": "string",
      "cancellation_fee_product_id": "string",
      "checkout_donation_options": {
        "simple_checkout_donation_options": {
          "allow_user_to_specify_custom_amount": true,
          "donation_ask_text": "string",
          "donation_denominations": [
            0.1
          ],
          "donation_information": "string",
          "donation_product_id": "string",
          "override_donation_denominations": true,
          "suggested_donation": 0.1
        },
        "type": "simple"
      },
      "credit_card_minimum_range_end": 0.1,
      "credit_card_minimum_range_start": 0.1,
      "credit_card_mode": "disabled",
      "credit_card_processing_fee_mode": "charge",
      "credit_card_processing_fee_options": {
        "fee_percentage": 0.1,
        "maximum_fee": 0.1,
        "minimum_fee": 0.1,
        "product_id": "string",
        "prompt_sub_text": "string",
        "prompt_text": "string"
      },
      "disable_electronic_payment_vaulting": true,
      "enable_bill_my_organization": true,
      "enable_bill_my_parent_organization": true,
      "enable_donations_at_checkout": true,
      "enable_electronic_checks": true,
      "enable_pay_later": true,
      "enable_payroll_deduction": true,
      "enable_split_payments": true,
      "installment_plan_options": {
        "0": {
          "additional_cost": 0.1,
          "installment_plan_id": "string",
          "is_default": true
        }
      },
      "invoice_payment_terms_id": "string",
      "invoice_template_id": "string",
      "merchant_account_id": "string",
      "pay_later_options": {
        "billing_address": "do not show",
        "purchase_order_number": "do not show",
        "reference_number": "string"
      },
      "restocking_fee_product_id": "string",
      "special_instructions": "string",
      "use_pro_forma_invoices": true
    },
    "close_date": "2019-08-24T14:15:22Z",
    "confirmation_email": {
      "bcc": "string",
      "body": "string",
      "cc": "string",
      "from": "string",
      "from_name": "string",
      "reply_to": "string",
      "subject": "string"
    },
    "contact_form_options": {
      "contact_form_id": "string",
      "html": "string"
    },
    "custom_confirmation_page_html": "string",
    "custom_field_values": [
      {
        "boolean_value": true,
        "custom_field_id": "string",
        "file_url_value": "string",
        "list_value": [
          "string"
        ],
        "numeric_value": 0.1,
        "string_value": "string",
        "table_value": [
          {}
        ]
      }
    ],
    "description": "string",
    "display_in_portal_as": "string",
    "display_order": 0.1,
    "eligibility_criteria": {
      "advanced_rule_error_message": "string",
      "advanced_rules": {},
      "age_restrictions": {
        "maximum_age": 0.1,
        "minimum_age": 0.1
      },
      "award_options": {
        "award_ids": [
          "string"
        ],
        "award_type_ids": [
          "string"
        ],
        "logic_operator": "and"
      },
      "award_recipients": true,
      "by_location": true,
      "certificants": true,
      "certification_options": {
        "logic_operator": "and",
        "program_ids": [
          "string"
        ]
      },
      "committee_member_options": {
        "committee_ids": [
          "string"
        ],
        "committee_position_ids": [
          "string"
        ],
        "committee_type_ids": [
          "string"
        ],
        "logic_operator": "and"
      },
      "committee_members": true,
      "custom_logic_options": {
        "lambda_function_id": "string"
      },
      "customer_type": "contact",
      "donor_options": {
        "donor_club_ids": [
          "string"
        ],
        "logic_operator": "and"
      },
      "donors": true,
      "enable_advanced_rules": true,
      "enable_age_restrictions": true,
      "enable_custom_logic": true,
      "enable_entitlement_restrictions": true,
      "enable_expression": true,
      "enable_organization_restrictions": true,
      "enable_status_restriction": true,
      "entitlement_restrictions": [
        {
          "quantity": 0.1,
          "type_id": "string"
        }
      ],
      "event_registration_options": {
        "event_ids": [
          "string"
        ],
        "logic_operator": "and",
        "registration_category_ids": [
          "string"
        ]
      },
      "event_registrations": true,
      "expression": "string",
      "expression_error_message": "string",
      "location": {
        "countries": [
          "string"
        ],
        "negate_logic": true
      },
      "logic_operator": "and",
      "member_options": {
        "chapter_member_options": {
          "chapter_ids": [
            "string"
          ],
          "chapter_type_ids": [
            "string"
          ],
          "logic_operator": "and"
        },
        "chapter_members": true,
        "member_package_ids": [
          "string"
        ],
        "member_status_reason_ids": [
          "string"
        ],
        "member_statuses": [
          "active"
        ],
        "member_type_ids": [
          "string"
        ],
        "section_member_options": {
          "logic_operator": "and",
          "section_ids": [
            "string"
          ],
          "section_type_ids": [
            "string"
          ]
        },
        "section_members": true
      },
      "members": true,
      "non_members": true,
      "organization_restrictions": {
        "contact_role_ids": [
          "string"
        ],
        "organization_type_ids": [
          "string"
        ]
      },
      "status_restrictions": {
        "0": "string"
      },
      "use_organization_for_eligibility": true
    },
    "enable_add_on_rules": true,
    "enable_confirmation_email": true,
    "enable_custom_confirmation_page_html": true,
    "enable_eligibility_criteria": true,
    "event_id": "string",
    "form_id": "string",
    "id": "string",
    "is_active": true,
    "name": "string",
    "open_date": "2019-08-24T14:15:22Z",
    "organization_form_options": {
      "html": "string",
      "organization_form_id": "string"
    },
    "override_checkout_settings": true,
    "priority_point_restriction": {
      "maximum": 0.1,
      "minimum": 0.1,
      "priority_point_type_id": "string"
    },
    "restrict_by_priority_points": true,
    "selectable_in_portal": true,
    "selection_mode": "select booth types",
    "show_contact_form": true,
    "show_organization_form": true,
    "sys_bulk_load_at": "string",
    "sys_bulk_load_id": "string",
    "sys_bulk_load_pk": "string",
    "sys_bulk_load_record_no": 0.1,
    "sys_bulk_load_source_file": "string",
    "sys_calculated_field_error": "string",
    "sys_calculated_field_errors": [
      {
        "error": "string",
        "field": "string"
      }
    ],
    "sys_configuration_snapshot_id": "string",
    "sys_created_at": "2019-08-24T14:15:22Z",
    "sys_created_by_id": "string",
    "sys_deleted_by_id": "string",
    "sys_directive": "string",
    "sys_external_id": "string",
    "sys_has_files_in_s3": true,
    "sys_last_bulk_data_operation_id": "string",
    "sys_last_bulk_data_operation_sys_version": "string",
    "sys_last_modified_at": "2019-08-24T14:15:22Z",
    "sys_last_modified_by_id": "string",
    "sys_last_security_context": {},
    "sys_locked": true,
    "sys_snapshot_base_version": 0.1,
    "sys_version": 0.1
  }'

Responses

The exhibitor reg process was saved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json