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.
The event that you would like to be saved.
If set, people can be placed on a wait list
The text to show in the portal when the event is sold out
The date that that this event should be removed from the portal. If blank, the end date is used
If set, the masthead image is not stretched and is left as is
Whether or not abstract submission and judging is enabled for this event
Whether or not this event has mini-conferences, or components
Whether or not certification courses can be sold during the event
Whether or not logistics & planning are available for this event
Whether or not you would like onsite checking and kiosks for this event
Whether or not online registration is enabled for this event
Whether or not this event has sponsors you would like to track
The event linked that occurred before this one, used for comparison
If true, only certain console users can access this event
Describes how this event registration and site information will be hosted and displayed
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
The timezone abbreviation, based on the event start date
The time zone offset, in minutes, from UTC, based on the event start date
curl -i -X POST \
'https://docs.api.rhythmsoftware.com/_mock/apis/events/events-v1/events/{tenantId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"address": {
"city": "string",
"country": "string",
"country_name": "string",
"county": "string",
"latitude": 0.1,
"line1": "string",
"line2": "string",
"line3": "string",
"longitude": 0.1,
"postal_code": "string",
"state": "string",
"time_zone_id": "string"
},
"business_unit_id": "string",
"capacity_options": {
"capacity": 0.1,
"enable_wait_list": true,
"text_to_display_when_sold_out": "string",
"waitlist_process_id": null
},
"chapter_id": "string",
"cloned_from_id": "string",
"console_access_options": {
"administrator_security_role_ids": [
"string"
],
"user_security_role_ids": [
"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": [
{}
]
}
],
"date_to_remove_from_portal": "2019-08-24T14:15:22Z",
"description": "string",
"do_not_stretch_masthead": true,
"enable_abstracts": true,
"enable_capacity": true,
"enable_components": true,
"enable_courses": true,
"enable_documents": true,
"enable_exhibitors": true,
"enable_functions": true,
"enable_logistics": true,
"enable_onsite": true,
"enable_registration": true,
"enable_sessions": true,
"enable_sponsors": true,
"enable_volunteers": true,
"end_date": "2019-08-24T14:15:22Z",
"featured": true,
"featured_from": "2019-08-24T14:15:22Z",
"featured_until": "2019-08-24T14:15:22Z",
"id": "string",
"masthead_image_uri": "string",
"name": "string",
"portal_integrated_events_options": {
"registrant_directory_id": null,
"show_group_registration": true,
"show_registrant_directory": true,
"show_schedule": true
},
"previous_event_id": "string",
"registration_deadlines": [
{
"date": "2019-08-24T14:15:22Z",
"id": "string"
}
],
"restrict_console_access": true,
"site_mode": "external",
"sold_out": true,
"start_date": "2019-08-24T14:15:22Z",
"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,
"thumbnail_image_uri": "string",
"timezone": "string",
"timezone_abbreviation": "string",
"timezone_mode": "local",
"timezone_offset": 0.1,
"type_id": "string",
"url": "string",
"venue_id": "string",
"visible_in_portal": true
}'The event was saved successfully.
If set, people can be placed on a wait list
The text to show in the portal when the event is sold out
The date that that this event should be removed from the portal. If blank, the end date is used
If set, the masthead image is not stretched and is left as is
Whether or not abstract submission and judging is enabled for this event
Whether or not this event has mini-conferences, or components
Whether or not certification courses can be sold during the event
Whether or not logistics & planning are available for this event
Whether or not you would like onsite checking and kiosks for this event
Whether or not online registration is enabled for this event
Whether or not this event has sponsors you would like to track
The event linked that occurred before this one, used for comparison
If true, only certain console users can access this event
Describes how this event registration and site information will be hosted and displayed
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
The timezone abbreviation, based on the event start date
The time zone offset, in minutes, from UTC, based on the event start date
{ "address": { "city": "string", "country": "string", "country_name": "string", "county": "string", "latitude": 0.1, "line1": "string", "line2": "string", "line3": "string", "longitude": 0.1, "postal_code": "string", "state": "string", "time_zone_id": "string" }, "business_unit_id": "string", "capacity_options": { "capacity": 0.1, "enable_wait_list": true, "text_to_display_when_sold_out": "string", "waitlist_process_id": null }, "chapter_id": "string", "cloned_from_id": "string", "console_access_options": { "administrator_security_role_ids": [ … ], "user_security_role_ids": [ … ] }, "custom_field_values": [ { … } ], "date_to_remove_from_portal": "2019-08-24T14:15:22Z", "description": "string", "do_not_stretch_masthead": true, "enable_abstracts": true, "enable_capacity": true, "enable_components": true, "enable_courses": true, "enable_documents": true, "enable_exhibitors": true, "enable_functions": true, "enable_logistics": true, "enable_onsite": true, "enable_registration": true, "enable_sessions": true, "enable_sponsors": true, "enable_volunteers": true, "end_date": "2019-08-24T14:15:22Z", "featured": true, "featured_from": "2019-08-24T14:15:22Z", "featured_until": "2019-08-24T14:15:22Z", "id": "string", "masthead_image_uri": "string", "name": "string", "portal_integrated_events_options": { "registrant_directory_id": null, "show_group_registration": true, "show_registrant_directory": true, "show_schedule": true }, "previous_event_id": "string", "registration_deadlines": [ { … } ], "restrict_console_access": true, "site_mode": "external", "sold_out": true, "start_date": "2019-08-24T14:15:22Z", "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, "thumbnail_image_uri": "string", "timezone": "string", "timezone_abbreviation": "string", "timezone_mode": "local", "timezone_offset": 0.1, "type_id": "string", "url": "string", "venue_id": "string", "visible_in_portal": true }
curl -i -X POST \
'https://docs.api.rhythmsoftware.com/_mock/apis/events/events-v1/events/{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/events/{tenantId}/chapter/{chapter_id}?exclusiveStartKey=string&fields=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'{ "Count": 0, "Items": [ { … } ], "LastEvaluatedKey": "string" }
The clone request
Whether or not to clone review spaces linked to this event
Whether or not to include sponsorship opportunities
curl -i -X POST \
'https://docs.api.rhythmsoftware.com/_mock/apis/events/events-v1/events/{tenantId}/clone' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"end_date": "string",
"id": "string",
"include_coupons": true,
"include_functions": true,
"include_microsite": true,
"include_review_spaces": true,
"include_sessions": true,
"include_sponsorship_opportunities": true,
"microsite_domain_name": "string",
"name": "string",
"source_event_id": "string",
"start_date": "string"
}'The records were retrieved successfully
If set, people can be placed on a wait list
The text to show in the portal when the event is sold out
The date that that this event should be removed from the portal. If blank, the end date is used
If set, the masthead image is not stretched and is left as is
Whether or not abstract submission and judging is enabled for this event
Whether or not this event has mini-conferences, or components
Whether or not certification courses can be sold during the event
Whether or not logistics & planning are available for this event
Whether or not you would like onsite checking and kiosks for this event
Whether or not online registration is enabled for this event
Whether or not this event has sponsors you would like to track
The event linked that occurred before this one, used for comparison
If true, only certain console users can access this event
Describes how this event registration and site information will be hosted and displayed
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
The timezone abbreviation, based on the event start date
The time zone offset, in minutes, from UTC, based on the event start date
{ "address": { "city": "string", "country": "string", "country_name": "string", "county": "string", "latitude": 0.1, "line1": "string", "line2": "string", "line3": "string", "longitude": 0.1, "postal_code": "string", "state": "string", "time_zone_id": "string" }, "business_unit_id": "string", "capacity_options": { "capacity": 0.1, "enable_wait_list": true, "text_to_display_when_sold_out": "string", "waitlist_process_id": null }, "chapter_id": "string", "cloned_from_id": "string", "console_access_options": { "administrator_security_role_ids": [ … ], "user_security_role_ids": [ … ] }, "custom_field_values": [ { … } ], "date_to_remove_from_portal": "2019-08-24T14:15:22Z", "description": "string", "do_not_stretch_masthead": true, "enable_abstracts": true, "enable_capacity": true, "enable_components": true, "enable_courses": true, "enable_documents": true, "enable_exhibitors": true, "enable_functions": true, "enable_logistics": true, "enable_onsite": true, "enable_registration": true, "enable_sessions": true, "enable_sponsors": true, "enable_volunteers": true, "end_date": "2019-08-24T14:15:22Z", "featured": true, "featured_from": "2019-08-24T14:15:22Z", "featured_until": "2019-08-24T14:15:22Z", "id": "string", "masthead_image_uri": "string", "name": "string", "portal_integrated_events_options": { "registrant_directory_id": null, "show_group_registration": true, "show_registrant_directory": true, "show_schedule": true }, "previous_event_id": "string", "registration_deadlines": [ { … } ], "restrict_console_access": true, "site_mode": "external", "sold_out": true, "start_date": "2019-08-24T14:15:22Z", "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, "thumbnail_image_uri": "string", "timezone": "string", "timezone_abbreviation": "string", "timezone_mode": "local", "timezone_offset": 0.1, "type_id": "string", "url": "string", "venue_id": "string", "visible_in_portal": true }
curl -i -X GET \
'https://docs.api.rhythmsoftware.com/_mock/apis/events/events-v1/events/{tenantId}/guestEligibility/{id}?guestNumber=string&isNewRegistration=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'curl -i -X GET \
'https://docs.api.rhythmsoftware.com/_mock/apis/events/events-v1/events/{tenantId}/public/upcoming?exclusiveStartKey=string&fields=string'{ "Items": [ { … } ], "LastEvaluatedKey": "string" }
curl -i -X GET \
'https://docs.api.rhythmsoftware.com/_mock/apis/events/events-v1/events/{tenantId}/public/{id}'The store was retrieved
Describes how this event registration and site information will be hosted and displayed
The timezone abbreviation, based on the event start date
The time zone offset, in minutes, from UTC, based on the event start date
{ "currency_code": "string", "currency_symbol": "string", "description": "string", "enable_documents": true, "end_date": "2019-08-24T14:15:22Z", "featured": true, "featured_from": "2019-08-24T14:15:22Z", "featured_until": "2019-08-24T14:15:22Z", "id": "string", "location": { "city": "string", "country": "string", "country_name": "string", "county": "string", "latitude": 0.1, "line1": "string", "line2": "string", "line3": "string", "longitude": 0.1, "postal_code": "string", "state": "string", "time_zone_id": "string" }, "masthead_image_uri": "string", "name": "string", "portal_integrated_events_options": { "registrant_directory_id": "string", "show_group_registration": true, "show_registrant_directory": true, "show_schedule": true }, "registration_deadlines": [ { … } ], "site_mode": "external", "sold_out": true, "start_date": "2019-08-24T14:15:22Z", "text_to_display_when_sold_out": "string", "thumbnail_image_uri": "string", "timezone": "string", "timezone_abbreviation": "string", "timezone_offset": 0.1, "type_id": "string", "type_name": "string", "url": "string", "venue_id": "string", "venue_name": "string", "visible_in_portal": true, "wait_list_available": true }
curl -i -X POST \
'https://docs.api.rhythmsoftware.com/_mock/apis/events/events-v1/events/{tenantId}/search?exclusiveStartKey=string&fieldsToReturn=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"city": "string",
"end_date": [
"2019-08-24T14:15:22Z",
"2019-08-24T14:15:22Z"
],
"id": "string",
"name": "string",
"start_date": [
"2019-08-24T14:15:22Z",
"2019-08-24T14:15:22Z"
],
"state": "string",
"type_id": [
"string"
],
"venue_id": [
"string"
],
"visible_in_portal": true
}'{ "Items": [ { … } ], "LastEvaluatedKey": "string" }
curl -i -X GET \
'https://docs.api.rhythmsoftware.com/_mock/apis/events/events-v1/events/{tenantId}/startDate/{start_date}?exclusiveStartKey=string&fields=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'{ "Items": [ { … } ], "LastEvaluatedKey": "string" }
curl -i -X GET \
'https://docs.api.rhythmsoftware.com/_mock/apis/events/events-v1/events/{tenantId}/type/{type_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/events/{tenantId}/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'"string"
curl -i -X GET \
'https://docs.api.rhythmsoftware.com/_mock/apis/events/events-v1/events/{tenantId}/{id}?consistentRead=string&fields=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'The event was retrieved successfully.
If set, people can be placed on a wait list
The text to show in the portal when the event is sold out
The date that that this event should be removed from the portal. If blank, the end date is used
If set, the masthead image is not stretched and is left as is
Whether or not abstract submission and judging is enabled for this event
Whether or not this event has mini-conferences, or components
Whether or not certification courses can be sold during the event
Whether or not logistics & planning are available for this event
Whether or not you would like onsite checking and kiosks for this event
Whether or not online registration is enabled for this event
Whether or not this event has sponsors you would like to track
The event linked that occurred before this one, used for comparison
If true, only certain console users can access this event
Describes how this event registration and site information will be hosted and displayed
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
The timezone abbreviation, based on the event start date
The time zone offset, in minutes, from UTC, based on the event start date
{ "address": { "city": "string", "country": "string", "country_name": "string", "county": "string", "latitude": 0.1, "line1": "string", "line2": "string", "line3": "string", "longitude": 0.1, "postal_code": "string", "state": "string", "time_zone_id": "string" }, "business_unit_id": "string", "capacity_options": { "capacity": 0.1, "enable_wait_list": true, "text_to_display_when_sold_out": "string", "waitlist_process_id": null }, "chapter_id": "string", "cloned_from_id": "string", "console_access_options": { "administrator_security_role_ids": [ … ], "user_security_role_ids": [ … ] }, "custom_field_values": [ { … } ], "date_to_remove_from_portal": "2019-08-24T14:15:22Z", "description": "string", "do_not_stretch_masthead": true, "enable_abstracts": true, "enable_capacity": true, "enable_components": true, "enable_courses": true, "enable_documents": true, "enable_exhibitors": true, "enable_functions": true, "enable_logistics": true, "enable_onsite": true, "enable_registration": true, "enable_sessions": true, "enable_sponsors": true, "enable_volunteers": true, "end_date": "2019-08-24T14:15:22Z", "featured": true, "featured_from": "2019-08-24T14:15:22Z", "featured_until": "2019-08-24T14:15:22Z", "id": "string", "masthead_image_uri": "string", "name": "string", "portal_integrated_events_options": { "registrant_directory_id": null, "show_group_registration": true, "show_registrant_directory": true, "show_schedule": true }, "previous_event_id": "string", "registration_deadlines": [ { … } ], "restrict_console_access": true, "site_mode": "external", "sold_out": true, "start_date": "2019-08-24T14:15:22Z", "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, "thumbnail_image_uri": "string", "timezone": "string", "timezone_abbreviation": "string", "timezone_mode": "local", "timezone_offset": 0.1, "type_id": "string", "url": "string", "venue_id": "string", "visible_in_portal": true }
curl -i -X PATCH \
'https://docs.api.rhythmsoftware.com/_mock/apis/events/events-v1/events/{tenantId}/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '[
{
"op": "add",
"path": "string",
"value": "string"
}
]'The event was patched successfully.
If set, people can be placed on a wait list
The text to show in the portal when the event is sold out
The date that that this event should be removed from the portal. If blank, the end date is used
If set, the masthead image is not stretched and is left as is
Whether or not abstract submission and judging is enabled for this event
Whether or not this event has mini-conferences, or components
Whether or not certification courses can be sold during the event
Whether or not logistics & planning are available for this event
Whether or not you would like onsite checking and kiosks for this event
Whether or not online registration is enabled for this event
Whether or not this event has sponsors you would like to track
The event linked that occurred before this one, used for comparison
If true, only certain console users can access this event
Describes how this event registration and site information will be hosted and displayed
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
The timezone abbreviation, based on the event start date
The time zone offset, in minutes, from UTC, based on the event start date
{ "address": { "city": "string", "country": "string", "country_name": "string", "county": "string", "latitude": 0.1, "line1": "string", "line2": "string", "line3": "string", "longitude": 0.1, "postal_code": "string", "state": "string", "time_zone_id": "string" }, "business_unit_id": "string", "capacity_options": { "capacity": 0.1, "enable_wait_list": true, "text_to_display_when_sold_out": "string", "waitlist_process_id": null }, "chapter_id": "string", "cloned_from_id": "string", "console_access_options": { "administrator_security_role_ids": [ … ], "user_security_role_ids": [ … ] }, "custom_field_values": [ { … } ], "date_to_remove_from_portal": "2019-08-24T14:15:22Z", "description": "string", "do_not_stretch_masthead": true, "enable_abstracts": true, "enable_capacity": true, "enable_components": true, "enable_courses": true, "enable_documents": true, "enable_exhibitors": true, "enable_functions": true, "enable_logistics": true, "enable_onsite": true, "enable_registration": true, "enable_sessions": true, "enable_sponsors": true, "enable_volunteers": true, "end_date": "2019-08-24T14:15:22Z", "featured": true, "featured_from": "2019-08-24T14:15:22Z", "featured_until": "2019-08-24T14:15:22Z", "id": "string", "masthead_image_uri": "string", "name": "string", "portal_integrated_events_options": { "registrant_directory_id": null, "show_group_registration": true, "show_registrant_directory": true, "show_schedule": true }, "previous_event_id": "string", "registration_deadlines": [ { … } ], "restrict_console_access": true, "site_mode": "external", "sold_out": true, "start_date": "2019-08-24T14:15:22Z", "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, "thumbnail_image_uri": "string", "timezone": "string", "timezone_abbreviation": "string", "timezone_mode": "local", "timezone_offset": 0.1, "type_id": "string", "url": "string", "venue_id": "string", "visible_in_portal": true }
The updated event that will be saved.
If set, people can be placed on a wait list
The text to show in the portal when the event is sold out
The date that that this event should be removed from the portal. If blank, the end date is used
If set, the masthead image is not stretched and is left as is
Whether or not abstract submission and judging is enabled for this event
Whether or not this event has mini-conferences, or components
Whether or not certification courses can be sold during the event
Whether or not logistics & planning are available for this event
Whether or not you would like onsite checking and kiosks for this event
Whether or not online registration is enabled for this event
Whether or not this event has sponsors you would like to track
The event linked that occurred before this one, used for comparison
If true, only certain console users can access this event
Describes how this event registration and site information will be hosted and displayed
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
The timezone abbreviation, based on the event start date
The time zone offset, in minutes, from UTC, based on the event start date
curl -i -X PUT \
'https://docs.api.rhythmsoftware.com/_mock/apis/events/events-v1/events/{tenantId}/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"address": {
"city": "string",
"country": "string",
"country_name": "string",
"county": "string",
"latitude": 0.1,
"line1": "string",
"line2": "string",
"line3": "string",
"longitude": 0.1,
"postal_code": "string",
"state": "string",
"time_zone_id": "string"
},
"business_unit_id": "string",
"capacity_options": {
"capacity": 0.1,
"enable_wait_list": true,
"text_to_display_when_sold_out": "string",
"waitlist_process_id": null
},
"chapter_id": "string",
"cloned_from_id": "string",
"console_access_options": {
"administrator_security_role_ids": [
"string"
],
"user_security_role_ids": [
"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": [
{}
]
}
],
"date_to_remove_from_portal": "2019-08-24T14:15:22Z",
"description": "string",
"do_not_stretch_masthead": true,
"enable_abstracts": true,
"enable_capacity": true,
"enable_components": true,
"enable_courses": true,
"enable_documents": true,
"enable_exhibitors": true,
"enable_functions": true,
"enable_logistics": true,
"enable_onsite": true,
"enable_registration": true,
"enable_sessions": true,
"enable_sponsors": true,
"enable_volunteers": true,
"end_date": "2019-08-24T14:15:22Z",
"featured": true,
"featured_from": "2019-08-24T14:15:22Z",
"featured_until": "2019-08-24T14:15:22Z",
"id": "string",
"masthead_image_uri": "string",
"name": "string",
"portal_integrated_events_options": {
"registrant_directory_id": null,
"show_group_registration": true,
"show_registrant_directory": true,
"show_schedule": true
},
"previous_event_id": "string",
"registration_deadlines": [
{
"date": "2019-08-24T14:15:22Z",
"id": "string"
}
],
"restrict_console_access": true,
"site_mode": "external",
"sold_out": true,
"start_date": "2019-08-24T14:15:22Z",
"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,
"thumbnail_image_uri": "string",
"timezone": "string",
"timezone_abbreviation": "string",
"timezone_mode": "local",
"timezone_offset": 0.1,
"type_id": "string",
"url": "string",
"venue_id": "string",
"visible_in_portal": true
}'The event was updated successfully.
If set, people can be placed on a wait list
The text to show in the portal when the event is sold out
The date that that this event should be removed from the portal. If blank, the end date is used
If set, the masthead image is not stretched and is left as is
Whether or not abstract submission and judging is enabled for this event
Whether or not this event has mini-conferences, or components
Whether or not certification courses can be sold during the event
Whether or not logistics & planning are available for this event
Whether or not you would like onsite checking and kiosks for this event
Whether or not online registration is enabled for this event
Whether or not this event has sponsors you would like to track
The event linked that occurred before this one, used for comparison
If true, only certain console users can access this event
Describes how this event registration and site information will be hosted and displayed
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
The timezone abbreviation, based on the event start date
The time zone offset, in minutes, from UTC, based on the event start date
{ "address": { "city": "string", "country": "string", "country_name": "string", "county": "string", "latitude": 0.1, "line1": "string", "line2": "string", "line3": "string", "longitude": 0.1, "postal_code": "string", "state": "string", "time_zone_id": "string" }, "business_unit_id": "string", "capacity_options": { "capacity": 0.1, "enable_wait_list": true, "text_to_display_when_sold_out": "string", "waitlist_process_id": null }, "chapter_id": "string", "cloned_from_id": "string", "console_access_options": { "administrator_security_role_ids": [ … ], "user_security_role_ids": [ … ] }, "custom_field_values": [ { … } ], "date_to_remove_from_portal": "2019-08-24T14:15:22Z", "description": "string", "do_not_stretch_masthead": true, "enable_abstracts": true, "enable_capacity": true, "enable_components": true, "enable_courses": true, "enable_documents": true, "enable_exhibitors": true, "enable_functions": true, "enable_logistics": true, "enable_onsite": true, "enable_registration": true, "enable_sessions": true, "enable_sponsors": true, "enable_volunteers": true, "end_date": "2019-08-24T14:15:22Z", "featured": true, "featured_from": "2019-08-24T14:15:22Z", "featured_until": "2019-08-24T14:15:22Z", "id": "string", "masthead_image_uri": "string", "name": "string", "portal_integrated_events_options": { "registrant_directory_id": null, "show_group_registration": true, "show_registrant_directory": true, "show_schedule": true }, "previous_event_id": "string", "registration_deadlines": [ { … } ], "restrict_console_access": true, "site_mode": "external", "sold_out": true, "start_date": "2019-08-24T14:15:22Z", "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, "thumbnail_image_uri": "string", "timezone": "string", "timezone_abbreviation": "string", "timezone_mode": "local", "timezone_offset": 0.1, "type_id": "string", "url": "string", "venue_id": "string", "visible_in_portal": true }