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.
curl -i -X GET \
'https://docs.api.rhythmsoftware.com/_mock/apis/events/events-v1/registrationProcesses/{tenantId}?exclusiveStartKey=string&fields=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'The registration processeswere retrieved successfully.
Whether registrants can cancel registrations in the portal
Whether registrants can edit their registrations
If true, the customer can choose their installment plan
The default bank account that the store should use to receive payments
The ID of the product used for cancellation fees
If set, the maximum amount for which credit cards can be taken
If set, the minimum amount for which credit cards can be taken
Determines whether or not credit cards are accepted
Determines how credit card processing fees should be handled
If set, in the portal people are not allowed to save credit cards
If set, the user has the option to bill their organization
If set, the user has the option to bill their organization's parent organization
If selected, users will be prompted to make a donation upon checking out
If set, electronic checks are allowed
If set, pay later is enabled on this checkout regardless of product settings... if not, the product settings are observed
If set, payroll deduction is allowed
If set, users are allowed to split payments
The payment terms for invoices; if left blank, default is used
The template to use for invoices created during this process
The merchant account that the store should use to receive payments
The ID of the product used for restocking fees
The email to send when the application is received
The custom confirmation page HTML
Deadline for cancelling registrations; if not set, the registration close date is used
The change fee used when registrations are being edited
Deadline for editing registrations; if not set, the registration close date is used
Whether or not an email should be sent when the application is received
enable custom text to show on the confirmation page
Whether or not this process is available in the portal
The form to use for group registration
Whether or not to override POC settings
If this record was loaded via bulk, the timestamp when the record was processed
If this record was loaded via bulk, the ID of the bulk load process
If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
If this record was loaded via bulk, the record number in the source file
If this record was loaded via bulk, the source file
The error associated with the calculated field
If a snapshot was restored/applies to this record, the ID of the snapshot
The date/time that this record was created, expressed in ISO-8601 date format
The ID of the user that deleted (or last tried to delete) this object
Means for passing directive information into an object processing logic
If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
If this record was last touched by a bulk data operation, the ID of that operation
If this record was last touched by a bulk data operation, the sys_version at the time of that operation
The date/time that this record record was last modified, expressed in ISO-8601 date format
The ID of the user that last modified this record
The security context of the last insert, modify, or delete performed on this item
The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
A number representing the version of this record in the database
[ { "allow_registrants_to_cancel_registrations": true, "allow_registrants_to_edit_registrations": true, "checkout_settings": { … }, "confirmation_email": { … }, "contact_form_options": { … }, "custom_confirmation_page_html": "string", "custom_field_values": [ … ], "deadline_for_cancelling_registrations": "2019-08-24T14:15:22Z", "description": "string", "display_order": 0.1, "edit_registration_options": { … }, "enable_confirmation_email": true, "enable_custom_confirmation_page_html": true, "enable_online_registration": true, "event_id": "string", "form_id": "string", "group_registration_form_id": "string", "guest_registration_options": { … }, "id": "string", "is_active": true, "name": "string", "online_registration_options": { … }, "organization_form_options": { … }, "override_checkout_settings": true, "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": [ … ], "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 } ]
The registration process that you would like to be saved.
Whether registrants can cancel registrations in the portal
Whether registrants can edit their registrations
If true, the customer can choose their installment plan
The default bank account that the store should use to receive payments
The ID of the product used for cancellation fees
If set, the maximum amount for which credit cards can be taken
If set, the minimum amount for which credit cards can be taken
Determines whether or not credit cards are accepted
Determines how credit card processing fees should be handled
If set, in the portal people are not allowed to save credit cards
If set, the user has the option to bill their organization
If set, the user has the option to bill their organization's parent organization
If selected, users will be prompted to make a donation upon checking out
If set, electronic checks are allowed
If set, pay later is enabled on this checkout regardless of product settings... if not, the product settings are observed
If set, payroll deduction is allowed
If set, users are allowed to split payments
The payment terms for invoices; if left blank, default is used
The template to use for invoices created during this process
The merchant account that the store should use to receive payments
The ID of the product used for restocking fees
The email to send when the application is received
The custom confirmation page HTML
Deadline for cancelling registrations; if not set, the registration close date is used
The change fee used when registrations are being edited
Deadline for editing registrations; if not set, the registration close date is used
Whether or not an email should be sent when the application is received
enable custom text to show on the confirmation page
Whether or not this process is available in the portal
The form to use for group registration
Whether or not to override POC settings
If this record was loaded via bulk, the timestamp when the record was processed
If this record was loaded via bulk, the ID of the bulk load process
If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
If this record was loaded via bulk, the record number in the source file
If this record was loaded via bulk, the source file
The error associated with the calculated field
If a snapshot was restored/applies to this record, the ID of the snapshot
The date/time that this record was created, expressed in ISO-8601 date format
The ID of the user that deleted (or last tried to delete) this object
Means for passing directive information into an object processing logic
If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
If this record was last touched by a bulk data operation, the ID of that operation
If this record was last touched by a bulk data operation, the sys_version at the time of that operation
The date/time that this record record was last modified, expressed in ISO-8601 date format
The ID of the user that last modified this record
The security context of the last insert, modify, or delete performed on this item
The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
curl -i -X POST \
'https://docs.api.rhythmsoftware.com/_mock/apis/events/events-v1/registrationProcesses/{tenantId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"allow_registrants_to_cancel_registrations": true,
"allow_registrants_to_edit_registrations": true,
"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
},
"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": [
{}
]
}
],
"deadline_for_cancelling_registrations": "2019-08-24T14:15:22Z",
"description": "string",
"display_order": 0.1,
"edit_registration_options": {
"change_fee_id": "string",
"deadline": "2019-08-24T14:15:22Z",
"edit_form_id": "string"
},
"enable_confirmation_email": true,
"enable_custom_confirmation_page_html": true,
"enable_online_registration": true,
"event_id": "string",
"form_id": "string",
"group_registration_form_id": "string",
"guest_registration_options": {
"do_not_save_guests_as_contacts": true,
"guest_registration_type_ids": [
"string"
],
"maximum_number_of_guests": 0.1,
"quick_add_contact_options": {}
},
"id": "string",
"is_active": true,
"name": "string",
"online_registration_options": {
"close_date": "2019-08-24T14:15:22Z",
"open_date": "2019-08-24T14:15:22Z"
},
"organization_form_options": {
"html": "string",
"organization_form_id": "string"
},
"override_checkout_settings": true,
"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
}'The registration process was saved successfully.
Whether registrants can cancel registrations in the portal
Whether registrants can edit their registrations
If true, the customer can choose their installment plan
The default bank account that the store should use to receive payments
The ID of the product used for cancellation fees
If set, the maximum amount for which credit cards can be taken
If set, the minimum amount for which credit cards can be taken
Determines whether or not credit cards are accepted
Determines how credit card processing fees should be handled
If set, in the portal people are not allowed to save credit cards
If set, the user has the option to bill their organization
If set, the user has the option to bill their organization's parent organization
If selected, users will be prompted to make a donation upon checking out
If set, electronic checks are allowed
If set, pay later is enabled on this checkout regardless of product settings... if not, the product settings are observed
If set, payroll deduction is allowed
If set, users are allowed to split payments
The payment terms for invoices; if left blank, default is used
The template to use for invoices created during this process
The merchant account that the store should use to receive payments
The ID of the product used for restocking fees
The email to send when the application is received
The custom confirmation page HTML
Deadline for cancelling registrations; if not set, the registration close date is used
The change fee used when registrations are being edited
Deadline for editing registrations; if not set, the registration close date is used
Whether or not an email should be sent when the application is received
enable custom text to show on the confirmation page
Whether or not this process is available in the portal
The form to use for group registration
Whether or not to override POC settings
If this record was loaded via bulk, the timestamp when the record was processed
If this record was loaded via bulk, the ID of the bulk load process
If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
If this record was loaded via bulk, the record number in the source file
If this record was loaded via bulk, the source file
The error associated with the calculated field
If a snapshot was restored/applies to this record, the ID of the snapshot
The date/time that this record was created, expressed in ISO-8601 date format
The ID of the user that deleted (or last tried to delete) this object
Means for passing directive information into an object processing logic
If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
If this record was last touched by a bulk data operation, the ID of that operation
If this record was last touched by a bulk data operation, the sys_version at the time of that operation
The date/time that this record record was last modified, expressed in ISO-8601 date format
The ID of the user that last modified this record
The security context of the last insert, modify, or delete performed on this item
The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
{ "allow_registrants_to_cancel_registrations": true, "allow_registrants_to_edit_registrations": true, "checkout_settings": { "allow_customer_to_choose_installment_plan": true, "bank_account_id": "string", "bill_my_organization_options": { … }, "bill_my_parent_organization_options": { … }, "business_unit_id": "string", "cancellation_fee_product_id": "string", "checkout_donation_options": { … }, "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": { … }, "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": { … }, "invoice_payment_terms_id": "string", "invoice_template_id": "string", "merchant_account_id": "string", "pay_later_options": { … }, "restocking_fee_product_id": "string", "special_instructions": "string", "use_pro_forma_invoices": true }, "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": [ { … } ], "deadline_for_cancelling_registrations": "2019-08-24T14:15:22Z", "description": "string", "display_order": 0.1, "edit_registration_options": { "change_fee_id": "string", "deadline": "2019-08-24T14:15:22Z", "edit_form_id": "string" }, "enable_confirmation_email": true, "enable_custom_confirmation_page_html": true, "enable_online_registration": true, "event_id": "string", "form_id": "string", "group_registration_form_id": "string", "guest_registration_options": { "do_not_save_guests_as_contacts": true, "guest_registration_type_ids": [ … ], "maximum_number_of_guests": 0.1, "quick_add_contact_options": {} }, "id": "string", "is_active": true, "name": "string", "online_registration_options": { "close_date": "2019-08-24T14:15:22Z", "open_date": "2019-08-24T14:15:22Z" }, "organization_form_options": { "html": "string", "organization_form_id": "string" }, "override_checkout_settings": true, "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": [ { … } ], "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 }
curl -i -X POST \
'https://docs.api.rhythmsoftware.com/_mock/apis/events/events-v1/registrationProcesses/{tenantId}/batch' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"operations": [
{
"id": null,
"object": {},
"operation": "create",
"patch_directives": {
"0": {
"op": "add",
"path": "string",
"value": "string"
}
},
"payload": {
"abstract": {
"approval_process_id": "string",
"average_score": 0.1,
"body": "string",
"bucket_id": null,
"city": "string",
"co_author_1": {
"email_address": "string",
"first_name": "string",
"last_name": "string",
"phone_number": "string",
"speaker_type_id": "string"
},
"co_author_2": {
"email_address": "string",
"first_name": "string",
"last_name": "string",
"phone_number": "string",
"speaker_type_id": "string"
},
"co_author_3": {
"email_address": "string",
"first_name": "string",
"last_name": "string",
"phone_number": "string",
"speaker_type_id": "string"
},
"co_author_4": {
"email_address": "string",
"first_name": "string",
"last_name": "string",
"phone_number": "string",
"speaker_type_id": "string"
},
"co_author_5": {
"email_address": "string",
"first_name": "string",
"last_name": "string",
"phone_number": "string",
"speaker_type_id": "string"
},
"co_authors": {
"0": {
"co_author_contact_id": "string",
"co_author_contact_info": {},
"speaker_type_id": "string"
}
},
"country": "string",
"custom_field_values": [
{
"boolean_value": true,
"custom_field_id": "string",
"file_url_value": "string",
"list_value": [
null
],
"numeric_value": 0.1,
"string_value": "string",
"table_value": [
{}
]
}
],
"date": "2019-08-24T14:15:22Z",
"email_address": "string",
"event_id": "string",
"first_name": "string",
"has_co_authors": true,
"id": null,
"job_title": "string",
"last_name": "string",
"last_review_status_change": "2019-08-24T14:15:22Z",
"main_presenter_id": "string",
"max_contact_submissions": 0.1,
"name": "string",
"notes": "string",
"number": 0.1,
"organization_id": "string",
"override_bucket_assignment": true,
"pending_console_review": true,
"presenter_info": {
"contact_info": {},
"email_presenter": true
},
"process_id": "string",
"review_process_id": "string",
"review_round_id": null,
"review_status": "accepted",
"reviewer_recommendation": "string",
"reviews_assigned": true,
"room_ids": [
"string"
],
"round_id": "string",
"round_scores": [
{
"round_id": "string",
"score": 0.1
}
],
"session_has_been_generated": true,
"session_track_ids": [
"string"
],
"state": "string",
"status": "accepted",
"submission_space_id": "string",
"submitter_id": "string",
"submitting_on_behalf_of_presenter": 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": null,
"sys_created_by_id": null,
"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": null,
"sys_last_modified_by_id": null,
"sys_last_security_context": {},
"sys_locked": true,
"sys_snapshot_base_version": 0.1,
"sys_version": 0.1,
"title": "string",
"total_score": 0.1,
"type_id": "string"
},
"allow_duplicates": true,
"main_presenter_speaker_type_id": "string",
"make_co_authors_speakers": true,
"new_status": "accepted",
"suppress_email_notifications": true,
"type_id": "string"
}
}
]
}'{ "error_count": 0.1, "results": [ { … } ], "success_count": 0.1 }
curl -i -X GET \
'https://docs.api.rhythmsoftware.com/_mock/apis/events/events-v1/registrationProcesses/{tenantId}/event/{event_id}?exclusiveStartKey=string&fields=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'{ "Count": 0, "Items": [ { … } ], "LastEvaluatedKey": "string" }
curl -i -X DELETE \
'https://docs.api.rhythmsoftware.com/_mock/apis/events/events-v1/registrationProcesses/{tenantId}/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'"string"
curl -i -X GET \
'https://docs.api.rhythmsoftware.com/_mock/apis/events/events-v1/registrationProcesses/{tenantId}/{id}?consistentRead=string&fields=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'The registration process was retrieved successfully.
Whether registrants can cancel registrations in the portal
Whether registrants can edit their registrations
If true, the customer can choose their installment plan
The default bank account that the store should use to receive payments
The ID of the product used for cancellation fees
If set, the maximum amount for which credit cards can be taken
If set, the minimum amount for which credit cards can be taken
Determines whether or not credit cards are accepted
Determines how credit card processing fees should be handled
If set, in the portal people are not allowed to save credit cards
If set, the user has the option to bill their organization
If set, the user has the option to bill their organization's parent organization
If selected, users will be prompted to make a donation upon checking out
If set, electronic checks are allowed
If set, pay later is enabled on this checkout regardless of product settings... if not, the product settings are observed
If set, payroll deduction is allowed
If set, users are allowed to split payments
The payment terms for invoices; if left blank, default is used
The template to use for invoices created during this process
The merchant account that the store should use to receive payments
The ID of the product used for restocking fees
The email to send when the application is received
The custom confirmation page HTML
Deadline for cancelling registrations; if not set, the registration close date is used
The change fee used when registrations are being edited
Deadline for editing registrations; if not set, the registration close date is used
Whether or not an email should be sent when the application is received
enable custom text to show on the confirmation page
Whether or not this process is available in the portal
The form to use for group registration
Whether or not to override POC settings
If this record was loaded via bulk, the timestamp when the record was processed
If this record was loaded via bulk, the ID of the bulk load process
If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
If this record was loaded via bulk, the record number in the source file
If this record was loaded via bulk, the source file
The error associated with the calculated field
If a snapshot was restored/applies to this record, the ID of the snapshot
The date/time that this record was created, expressed in ISO-8601 date format
The ID of the user that deleted (or last tried to delete) this object
Means for passing directive information into an object processing logic
If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
If this record was last touched by a bulk data operation, the ID of that operation
If this record was last touched by a bulk data operation, the sys_version at the time of that operation
The date/time that this record record was last modified, expressed in ISO-8601 date format
The ID of the user that last modified this record
The security context of the last insert, modify, or delete performed on this item
The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
{ "allow_registrants_to_cancel_registrations": true, "allow_registrants_to_edit_registrations": true, "checkout_settings": { "allow_customer_to_choose_installment_plan": true, "bank_account_id": "string", "bill_my_organization_options": { … }, "bill_my_parent_organization_options": { … }, "business_unit_id": "string", "cancellation_fee_product_id": "string", "checkout_donation_options": { … }, "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": { … }, "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": { … }, "invoice_payment_terms_id": "string", "invoice_template_id": "string", "merchant_account_id": "string", "pay_later_options": { … }, "restocking_fee_product_id": "string", "special_instructions": "string", "use_pro_forma_invoices": true }, "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": [ { … } ], "deadline_for_cancelling_registrations": "2019-08-24T14:15:22Z", "description": "string", "display_order": 0.1, "edit_registration_options": { "change_fee_id": "string", "deadline": "2019-08-24T14:15:22Z", "edit_form_id": "string" }, "enable_confirmation_email": true, "enable_custom_confirmation_page_html": true, "enable_online_registration": true, "event_id": "string", "form_id": "string", "group_registration_form_id": "string", "guest_registration_options": { "do_not_save_guests_as_contacts": true, "guest_registration_type_ids": [ … ], "maximum_number_of_guests": 0.1, "quick_add_contact_options": {} }, "id": "string", "is_active": true, "name": "string", "online_registration_options": { "close_date": "2019-08-24T14:15:22Z", "open_date": "2019-08-24T14:15:22Z" }, "organization_form_options": { "html": "string", "organization_form_id": "string" }, "override_checkout_settings": true, "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": [ { … } ], "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 }
curl -i -X PATCH \
'https://docs.api.rhythmsoftware.com/_mock/apis/events/events-v1/registrationProcesses/{tenantId}/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '[
{
"op": "add",
"path": "string",
"value": "string"
}
]'The registration process was patched successfully.
Whether registrants can cancel registrations in the portal
Whether registrants can edit their registrations
If true, the customer can choose their installment plan
The default bank account that the store should use to receive payments
The ID of the product used for cancellation fees
If set, the maximum amount for which credit cards can be taken
If set, the minimum amount for which credit cards can be taken
Determines whether or not credit cards are accepted
Determines how credit card processing fees should be handled
If set, in the portal people are not allowed to save credit cards
If set, the user has the option to bill their organization
If set, the user has the option to bill their organization's parent organization
If selected, users will be prompted to make a donation upon checking out
If set, electronic checks are allowed
If set, pay later is enabled on this checkout regardless of product settings... if not, the product settings are observed
If set, payroll deduction is allowed
If set, users are allowed to split payments
The payment terms for invoices; if left blank, default is used
The template to use for invoices created during this process
The merchant account that the store should use to receive payments
The ID of the product used for restocking fees
The email to send when the application is received
The custom confirmation page HTML
Deadline for cancelling registrations; if not set, the registration close date is used
The change fee used when registrations are being edited
Deadline for editing registrations; if not set, the registration close date is used
Whether or not an email should be sent when the application is received
enable custom text to show on the confirmation page
Whether or not this process is available in the portal
The form to use for group registration
Whether or not to override POC settings
If this record was loaded via bulk, the timestamp when the record was processed
If this record was loaded via bulk, the ID of the bulk load process
If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
If this record was loaded via bulk, the record number in the source file
If this record was loaded via bulk, the source file
The error associated with the calculated field
If a snapshot was restored/applies to this record, the ID of the snapshot
The date/time that this record was created, expressed in ISO-8601 date format
The ID of the user that deleted (or last tried to delete) this object
Means for passing directive information into an object processing logic
If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
If this record was last touched by a bulk data operation, the ID of that operation
If this record was last touched by a bulk data operation, the sys_version at the time of that operation
The date/time that this record record was last modified, expressed in ISO-8601 date format
The ID of the user that last modified this record
The security context of the last insert, modify, or delete performed on this item
The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
{ "allow_registrants_to_cancel_registrations": true, "allow_registrants_to_edit_registrations": true, "checkout_settings": { "allow_customer_to_choose_installment_plan": true, "bank_account_id": "string", "bill_my_organization_options": { … }, "bill_my_parent_organization_options": { … }, "business_unit_id": "string", "cancellation_fee_product_id": "string", "checkout_donation_options": { … }, "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": { … }, "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": { … }, "invoice_payment_terms_id": "string", "invoice_template_id": "string", "merchant_account_id": "string", "pay_later_options": { … }, "restocking_fee_product_id": "string", "special_instructions": "string", "use_pro_forma_invoices": true }, "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": [ { … } ], "deadline_for_cancelling_registrations": "2019-08-24T14:15:22Z", "description": "string", "display_order": 0.1, "edit_registration_options": { "change_fee_id": "string", "deadline": "2019-08-24T14:15:22Z", "edit_form_id": "string" }, "enable_confirmation_email": true, "enable_custom_confirmation_page_html": true, "enable_online_registration": true, "event_id": "string", "form_id": "string", "group_registration_form_id": "string", "guest_registration_options": { "do_not_save_guests_as_contacts": true, "guest_registration_type_ids": [ … ], "maximum_number_of_guests": 0.1, "quick_add_contact_options": {} }, "id": "string", "is_active": true, "name": "string", "online_registration_options": { "close_date": "2019-08-24T14:15:22Z", "open_date": "2019-08-24T14:15:22Z" }, "organization_form_options": { "html": "string", "organization_form_id": "string" }, "override_checkout_settings": true, "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": [ { … } ], "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 }
The updated registration process that will be saved.
Whether registrants can cancel registrations in the portal
Whether registrants can edit their registrations
If true, the customer can choose their installment plan
The default bank account that the store should use to receive payments
The ID of the product used for cancellation fees
If set, the maximum amount for which credit cards can be taken
If set, the minimum amount for which credit cards can be taken
Determines whether or not credit cards are accepted
Determines how credit card processing fees should be handled
If set, in the portal people are not allowed to save credit cards
If set, the user has the option to bill their organization
If set, the user has the option to bill their organization's parent organization
If selected, users will be prompted to make a donation upon checking out
If set, electronic checks are allowed
If set, pay later is enabled on this checkout regardless of product settings... if not, the product settings are observed
If set, payroll deduction is allowed
If set, users are allowed to split payments
The payment terms for invoices; if left blank, default is used
The template to use for invoices created during this process
The merchant account that the store should use to receive payments
The ID of the product used for restocking fees
The email to send when the application is received
The custom confirmation page HTML
Deadline for cancelling registrations; if not set, the registration close date is used
The change fee used when registrations are being edited
Deadline for editing registrations; if not set, the registration close date is used
Whether or not an email should be sent when the application is received
enable custom text to show on the confirmation page
Whether or not this process is available in the portal
The form to use for group registration
Whether or not to override POC settings
If this record was loaded via bulk, the timestamp when the record was processed
If this record was loaded via bulk, the ID of the bulk load process
If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
If this record was loaded via bulk, the record number in the source file
If this record was loaded via bulk, the source file
The error associated with the calculated field
If a snapshot was restored/applies to this record, the ID of the snapshot
The date/time that this record was created, expressed in ISO-8601 date format
The ID of the user that deleted (or last tried to delete) this object
Means for passing directive information into an object processing logic
If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
If this record was last touched by a bulk data operation, the ID of that operation
If this record was last touched by a bulk data operation, the sys_version at the time of that operation
The date/time that this record record was last modified, expressed in ISO-8601 date format
The ID of the user that last modified this record
The security context of the last insert, modify, or delete performed on this item
The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
curl -i -X PUT \
'https://docs.api.rhythmsoftware.com/_mock/apis/events/events-v1/registrationProcesses/{tenantId}/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"allow_registrants_to_cancel_registrations": true,
"allow_registrants_to_edit_registrations": true,
"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
},
"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": [
{}
]
}
],
"deadline_for_cancelling_registrations": "2019-08-24T14:15:22Z",
"description": "string",
"display_order": 0.1,
"edit_registration_options": {
"change_fee_id": "string",
"deadline": "2019-08-24T14:15:22Z",
"edit_form_id": "string"
},
"enable_confirmation_email": true,
"enable_custom_confirmation_page_html": true,
"enable_online_registration": true,
"event_id": "string",
"form_id": "string",
"group_registration_form_id": "string",
"guest_registration_options": {
"do_not_save_guests_as_contacts": true,
"guest_registration_type_ids": [
"string"
],
"maximum_number_of_guests": 0.1,
"quick_add_contact_options": {}
},
"id": "string",
"is_active": true,
"name": "string",
"online_registration_options": {
"close_date": "2019-08-24T14:15:22Z",
"open_date": "2019-08-24T14:15:22Z"
},
"organization_form_options": {
"html": "string",
"organization_form_id": "string"
},
"override_checkout_settings": true,
"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
}'The registration process was updated successfully.
Whether registrants can cancel registrations in the portal
Whether registrants can edit their registrations
If true, the customer can choose their installment plan
The default bank account that the store should use to receive payments
The ID of the product used for cancellation fees
If set, the maximum amount for which credit cards can be taken
If set, the minimum amount for which credit cards can be taken
Determines whether or not credit cards are accepted
Determines how credit card processing fees should be handled
If set, in the portal people are not allowed to save credit cards
If set, the user has the option to bill their organization
If set, the user has the option to bill their organization's parent organization
If selected, users will be prompted to make a donation upon checking out
If set, electronic checks are allowed
If set, pay later is enabled on this checkout regardless of product settings... if not, the product settings are observed
If set, payroll deduction is allowed
If set, users are allowed to split payments
The payment terms for invoices; if left blank, default is used
The template to use for invoices created during this process
The merchant account that the store should use to receive payments
The ID of the product used for restocking fees
The email to send when the application is received
The custom confirmation page HTML
Deadline for cancelling registrations; if not set, the registration close date is used
The change fee used when registrations are being edited
Deadline for editing registrations; if not set, the registration close date is used
Whether or not an email should be sent when the application is received
enable custom text to show on the confirmation page
Whether or not this process is available in the portal
The form to use for group registration
Whether or not to override POC settings
If this record was loaded via bulk, the timestamp when the record was processed
If this record was loaded via bulk, the ID of the bulk load process
If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
If this record was loaded via bulk, the record number in the source file
If this record was loaded via bulk, the source file
The error associated with the calculated field
If a snapshot was restored/applies to this record, the ID of the snapshot
The date/time that this record was created, expressed in ISO-8601 date format
The ID of the user that deleted (or last tried to delete) this object
Means for passing directive information into an object processing logic
If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
If this record was last touched by a bulk data operation, the ID of that operation
If this record was last touched by a bulk data operation, the sys_version at the time of that operation
The date/time that this record record was last modified, expressed in ISO-8601 date format
The ID of the user that last modified this record
The security context of the last insert, modify, or delete performed on this item
The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
{ "allow_registrants_to_cancel_registrations": true, "allow_registrants_to_edit_registrations": true, "checkout_settings": { "allow_customer_to_choose_installment_plan": true, "bank_account_id": "string", "bill_my_organization_options": { … }, "bill_my_parent_organization_options": { … }, "business_unit_id": "string", "cancellation_fee_product_id": "string", "checkout_donation_options": { … }, "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": { … }, "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": { … }, "invoice_payment_terms_id": "string", "invoice_template_id": "string", "merchant_account_id": "string", "pay_later_options": { … }, "restocking_fee_product_id": "string", "special_instructions": "string", "use_pro_forma_invoices": true }, "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": [ { … } ], "deadline_for_cancelling_registrations": "2019-08-24T14:15:22Z", "description": "string", "display_order": 0.1, "edit_registration_options": { "change_fee_id": "string", "deadline": "2019-08-24T14:15:22Z", "edit_form_id": "string" }, "enable_confirmation_email": true, "enable_custom_confirmation_page_html": true, "enable_online_registration": true, "event_id": "string", "form_id": "string", "group_registration_form_id": "string", "guest_registration_options": { "do_not_save_guests_as_contacts": true, "guest_registration_type_ids": [ … ], "maximum_number_of_guests": 0.1, "quick_add_contact_options": {} }, "id": "string", "is_active": true, "name": "string", "online_registration_options": { "close_date": "2019-08-24T14:15:22Z", "open_date": "2019-08-24T14:15:22Z" }, "organization_form_options": { "html": "string", "organization_form_id": "string" }, "override_checkout_settings": true, "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": [ { … } ], "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 }