Events

Creates a new event record that does not already exist.

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

Request

Security:

knox-authorizer

path Parameters

tenantId

required

string

The id of the tenant being accessed.

Request Body schema: application/json

The event that you would like to be saved.

id required	string (ID) /^[\w\|-]+$/ The unique, string identifier of this event
business_unit_id	string (Business Unit) The business unit of this event
name required	string (Name) The name of the event
type_id required	string (Type) The type of event
venue_id	string (Venue) The venue hosting the event
previous_event_id	string (Previous Event) The event linked that occurred before this one, used for comparison
masthead_image_uri	string (Masthead Image Uri) The masthead image to be displayed for the event
do_not_stretch_masthead	boolean (Do Not Stretch Masthead) If set, the masthead image is not stretched and is left as is
thumbnail_image_uri	string (Thumbnail Image Uri) The thumbnail image to display in upcoming events
start_date required	string <date-time> (Start Date) The start of the event
end_date required	string <date-time> (End Date) The end of the event
date_to_remove_from_portal	string <date-time> (Date To Remove From Portal) The date that that this event should be removed from the portal. If blank, the end date is used
site_mode	string (Site Mode) Describes how this event registration and site information will be hosted and displayed Enum: "microsite" "portal integrated" "external" "none"
url required	string (Url) The URL of the event site
	object (Portal Integrated Events Options)
	object (Address) A complete address
timezone_mode	string (Timezone Mode) Enum: "local" "specific timezone"
timezone required	string (Timezone) The timezone that the event is in
featured	boolean (Featured) If true, this event should be featured and displayed prominently
featured_from	string <date-time> (Featured From) The time during which this event should be featured
featured_until	string <date-time> (Featured Until) The time during which this event should be featured
timezone_offset	number <float> (Timezone Offset) The time zone offset, in minutes, from UTC, based on the event start date
timezone_abbreviation	string (Timezone Abbreviation) The timezone abbreviation, based on the event start date
cloned_from_id	string (Cloned From) The event from which this event was cloned
enable_capacity	boolean (Enable Capacity) If set, the session has a capacity
required	object (Capacity Options)
chapter_id	string (Chapter) The chapter associated with this event, if applicable
enable_components	boolean (Enable Components) Whether or not this event has mini-conferences, or components
enable_logistics	boolean (Enable Logistics) Whether or not logistics & planning are available for this event
enable_courses	boolean (Enable Courses) Whether or not certification courses can be sold during the event
enable_registration	boolean (Enable Registration) Whether or not online registration is enabled for this event
enable_abstracts	boolean (Enable Abstracts) Whether or not abstract submission and judging is enabled for this event
enable_sessions	boolean (Enable Sessions) Whether or not onlines sessions are enabled for this event
enable_functions	boolean (Enable Functions) Whether or not functions are enabled for this event
enable_exhibitors	boolean (Enable Exhibitors) Whether or not this event has exhibitors
enable_sponsors	boolean (Enable Sponsors) Whether or not this event has sponsors you would like to track
enable_volunteers	boolean (Enable Volunteers) Whether or not volunteer management & tracking
enable_onsite	boolean (Enable Onsite) Whether or not you would like onsite checking and kiosks for this event
enable_documents	boolean (Enable Documents) Enable documents for your event
description	string (Description) Event description
sold_out	boolean (Sold Out) Whether the event is sold out
visible_in_portal	boolean (Visible In Portal) Whether this is visible in the portal
	Array of objects
restrict_console_access	boolean (Restrict Console Access) If true, only certain console users can access this event
required	object (Console Access Options)
	Array of objects (Custom Field Values)
sys_deleted_by_id	string (Sys Deleted By) The ID of the user that deleted (or last tried to delete) this object
sys_version	number <float> (Sys Version) A number representing the version of this record in the database
sys_created_at required	string <date-time> (Sys Created At) The date/time that this record was created, expressed in ISO-8601 date format
sys_last_modified_at required	string <date-time> (Sys Last Modified At) The date/time that this record record was last modified, expressed in ISO-8601 date format
sys_created_by_id required	string (Sys Created By) The ID of the user that created this record
sys_last_modified_by_id required	string (Sys Last Modified By) The ID of the user that last modified this record
sys_external_id	string (Sys External) The ID that a record has from an external system or data import
sys_locked	boolean (Sys Locked) If set, this record is locked and cannot be changed via the API
sys_bulk_load_pk	string (Sys Bulk Load Pk) If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
sys_bulk_load_at	string (Sys Bulk Load At) If this record was loaded via bulk, the timestamp when the record was processed
sys_bulk_load_id	string (Sys Bulk Load) If this record was loaded via bulk, the ID of the bulk load process
sys_bulk_load_record_no	number <float> (Sys Bulk Load Record No) If this record was loaded via bulk, the record number in the source file
sys_bulk_load_source_file	string (Sys Bulk Load Source File) If this record was loaded via bulk, the source file
sys_last_bulk_data_operation_id	string (Sys Last Bulk Data Operation) If this record was last touched by a bulk data operation, the ID of that operation
sys_last_bulk_data_operation_sys_version	string (Sys Last Bulk Data Operation Sys Version) If this record was last touched by a bulk data operation, the sys_version at the time of that operation
sys_directive	string (Sys Directive) Means for passing directive information into an object processing logic
sys_calculated_field_error	string (Sys Calculated Field Error) The error associated with the calculated field
sys_snapshot_base_version	number <float> (Sys Snapshot Base Version) The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
sys_has_files_in_s3	boolean (Sys Has Files In S3) If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
sys_configuration_snapshot_id	string (Sys Configuration Snapshot) If a snapshot was restored/applies to this record, the ID of the snapshot
sys_last_security_context	object (Sys Last Security Context) The security context of the last insert, modify, or delete performed on this item
	Array of objects

Responses

200The event was saved successfully.

400The event you supplied was invalid.

401Unauthorized.

403Forbidden.

404The resource could not be found

409The event could not be saved because it refers to/depends on a non-existent object.

429Limit exceeded... unable to add event based on tenant limits.

500General server error.

post/events/{tenantId}

Request samples

application/json

{"id": "string",
"business_unit_id": "string",
"name": "string",
"type_id": "string",
"venue_id": "string",
"previous_event_id": "string",
"masthead_image_uri": "string",
"do_not_stretch_masthead": true,
"thumbnail_image_uri": "string",
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"date_to_remove_from_portal": "2019-08-24T14:15:22Z",
"site_mode": "microsite",
"url": "string",
"portal_integrated_events_options": {"show_schedule": true,
"show_group_registration": true,
"show_registrant_directory": true,
"registrant_directory_id": "string"
},
"address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"timezone_mode": "local",
"timezone": "string",
"featured": true,
"featured_from": "2019-08-24T14:15:22Z",
"featured_until": "2019-08-24T14:15:22Z",
"timezone_offset": 0,
"timezone_abbreviation": "string",
"cloned_from_id": "string",
"enable_capacity": true,
"capacity_options": {"capacity": 0,
"text_to_display_when_sold_out": "string",
"enable_wait_list": true,
"waitlist_process_id": "string"
},
"chapter_id": "string",
"enable_components": true,
"enable_logistics": true,
"enable_courses": true,
"enable_registration": true,
"enable_abstracts": true,
"enable_sessions": true,
"enable_functions": true,
"enable_exhibitors": true,
"enable_sponsors": true,
"enable_volunteers": true,
"enable_onsite": true,
"enable_documents": true,
"description": "string",
"sold_out": true,
"visible_in_portal": true,
"registration_deadlines": [{"id": "string",
"date": "2019-08-24T14:15:22Z"
}
],
"restrict_console_access": true,
"console_access_options": {"user_security_role_ids": ["string"
],
"administrator_security_role_ids": ["string"
]
},
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}

Response samples

application/json

{"id": "string",
"business_unit_id": "string",
"name": "string",
"type_id": "string",
"venue_id": "string",
"previous_event_id": "string",
"masthead_image_uri": "string",
"do_not_stretch_masthead": true,
"thumbnail_image_uri": "string",
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"date_to_remove_from_portal": "2019-08-24T14:15:22Z",
"site_mode": "microsite",
"url": "string",
"portal_integrated_events_options": {"show_schedule": true,
"show_group_registration": true,
"show_registrant_directory": true,
"registrant_directory_id": "string"
},
"address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"timezone_mode": "local",
"timezone": "string",
"featured": true,
"featured_from": "2019-08-24T14:15:22Z",
"featured_until": "2019-08-24T14:15:22Z",
"timezone_offset": 0,
"timezone_abbreviation": "string",
"cloned_from_id": "string",
"enable_capacity": true,
"capacity_options": {"capacity": 0,
"text_to_display_when_sold_out": "string",
"enable_wait_list": true,
"waitlist_process_id": "string"
},
"chapter_id": "string",
"enable_components": true,
"enable_logistics": true,
"enable_courses": true,
"enable_registration": true,
"enable_abstracts": true,
"enable_sessions": true,
"enable_functions": true,
"enable_exhibitors": true,
"enable_sponsors": true,
"enable_volunteers": true,
"enable_onsite": true,
"enable_documents": true,
"description": "string",
"sold_out": true,
"visible_in_portal": true,
"registration_deadlines": [{"id": "string",
"date": "2019-08-24T14:15:22Z"
}
],
"restrict_console_access": true,
"console_access_options": {"user_security_role_ids": ["string"
],
"administrator_security_role_ids": ["string"
]
},
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}

Returns a event from the system by its ID.

This method will look up a event by the specified ID and return it back.

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The id of the tenant being accessed.
id required	string The ID of the event to return.

query Parameters

fields	string The fields that you want to retrieve; if omitted, the entire object is returned.
consistentRead	string Indicates the API should force a consistent read on the data source.

Responses

200The event was retrieved successfully.

400The request was not valid.

401Unauthorized.

403Forbidden.

404The event could not be found.

429Limit exceeded... unable to retrieve event based on tenant limits.

500General server error.

get/events/{tenantId}/{id}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  'https://events.api.756794052567.rhythmsoftware.com/events/:tenantId/:id?fields=string&consistentRead=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"id": "string",
"business_unit_id": "string",
"name": "string",
"type_id": "string",
"venue_id": "string",
"previous_event_id": "string",
"masthead_image_uri": "string",
"do_not_stretch_masthead": true,
"thumbnail_image_uri": "string",
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"date_to_remove_from_portal": "2019-08-24T14:15:22Z",
"site_mode": "microsite",
"url": "string",
"portal_integrated_events_options": {"show_schedule": true,
"show_group_registration": true,
"show_registrant_directory": true,
"registrant_directory_id": "string"
},
"address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"timezone_mode": "local",
"timezone": "string",
"featured": true,
"featured_from": "2019-08-24T14:15:22Z",
"featured_until": "2019-08-24T14:15:22Z",
"timezone_offset": 0,
"timezone_abbreviation": "string",
"cloned_from_id": "string",
"enable_capacity": true,
"capacity_options": {"capacity": 0,
"text_to_display_when_sold_out": "string",
"enable_wait_list": true,
"waitlist_process_id": "string"
},
"chapter_id": "string",
"enable_components": true,
"enable_logistics": true,
"enable_courses": true,
"enable_registration": true,
"enable_abstracts": true,
"enable_sessions": true,
"enable_functions": true,
"enable_exhibitors": true,
"enable_sponsors": true,
"enable_volunteers": true,
"enable_onsite": true,
"enable_documents": true,
"description": "string",
"sold_out": true,
"visible_in_portal": true,
"registration_deadlines": [{"id": "string",
"date": "2019-08-24T14:15:22Z"
}
],
"restrict_console_access": true,
"console_access_options": {"user_security_role_ids": ["string"
],
"administrator_security_role_ids": ["string"
]
},
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}

Updates a event with the specified ID.

This method will update an existing event with the specified ID.

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The id of the tenant being accessed.
id required	string The ID of the event to update.

Request Body schema: application/json

The updated event that will be saved.

id required	string (ID) /^[\w\|-]+$/ The unique, string identifier of this event
business_unit_id	string (Business Unit) The business unit of this event
name required	string (Name) The name of the event
type_id required	string (Type) The type of event
venue_id	string (Venue) The venue hosting the event
previous_event_id	string (Previous Event) The event linked that occurred before this one, used for comparison
masthead_image_uri	string (Masthead Image Uri) The masthead image to be displayed for the event
do_not_stretch_masthead	boolean (Do Not Stretch Masthead) If set, the masthead image is not stretched and is left as is
thumbnail_image_uri	string (Thumbnail Image Uri) The thumbnail image to display in upcoming events
start_date required	string <date-time> (Start Date) The start of the event
end_date required	string <date-time> (End Date) The end of the event
date_to_remove_from_portal	string <date-time> (Date To Remove From Portal) The date that that this event should be removed from the portal. If blank, the end date is used
site_mode	string (Site Mode) Describes how this event registration and site information will be hosted and displayed Enum: "microsite" "portal integrated" "external" "none"
url required	string (Url) The URL of the event site
	object (Portal Integrated Events Options)
	object (Address) A complete address
timezone_mode	string (Timezone Mode) Enum: "local" "specific timezone"
timezone required	string (Timezone) The timezone that the event is in
featured	boolean (Featured) If true, this event should be featured and displayed prominently
featured_from	string <date-time> (Featured From) The time during which this event should be featured
featured_until	string <date-time> (Featured Until) The time during which this event should be featured
timezone_offset	number <float> (Timezone Offset) The time zone offset, in minutes, from UTC, based on the event start date
timezone_abbreviation	string (Timezone Abbreviation) The timezone abbreviation, based on the event start date
cloned_from_id	string (Cloned From) The event from which this event was cloned
enable_capacity	boolean (Enable Capacity) If set, the session has a capacity
required	object (Capacity Options)
chapter_id	string (Chapter) The chapter associated with this event, if applicable
enable_components	boolean (Enable Components) Whether or not this event has mini-conferences, or components
enable_logistics	boolean (Enable Logistics) Whether or not logistics & planning are available for this event
enable_courses	boolean (Enable Courses) Whether or not certification courses can be sold during the event
enable_registration	boolean (Enable Registration) Whether or not online registration is enabled for this event
enable_abstracts	boolean (Enable Abstracts) Whether or not abstract submission and judging is enabled for this event
enable_sessions	boolean (Enable Sessions) Whether or not onlines sessions are enabled for this event
enable_functions	boolean (Enable Functions) Whether or not functions are enabled for this event
enable_exhibitors	boolean (Enable Exhibitors) Whether or not this event has exhibitors
enable_sponsors	boolean (Enable Sponsors) Whether or not this event has sponsors you would like to track
enable_volunteers	boolean (Enable Volunteers) Whether or not volunteer management & tracking
enable_onsite	boolean (Enable Onsite) Whether or not you would like onsite checking and kiosks for this event
enable_documents	boolean (Enable Documents) Enable documents for your event
description	string (Description) Event description
sold_out	boolean (Sold Out) Whether the event is sold out
visible_in_portal	boolean (Visible In Portal) Whether this is visible in the portal
	Array of objects
restrict_console_access	boolean (Restrict Console Access) If true, only certain console users can access this event
required	object (Console Access Options)
	Array of objects (Custom Field Values)
sys_deleted_by_id	string (Sys Deleted By) The ID of the user that deleted (or last tried to delete) this object
sys_version	number <float> (Sys Version) A number representing the version of this record in the database
sys_created_at required	string <date-time> (Sys Created At) The date/time that this record was created, expressed in ISO-8601 date format
sys_last_modified_at required	string <date-time> (Sys Last Modified At) The date/time that this record record was last modified, expressed in ISO-8601 date format
sys_created_by_id required	string (Sys Created By) The ID of the user that created this record
sys_last_modified_by_id required	string (Sys Last Modified By) The ID of the user that last modified this record
sys_external_id	string (Sys External) The ID that a record has from an external system or data import
sys_locked	boolean (Sys Locked) If set, this record is locked and cannot be changed via the API
sys_bulk_load_pk	string (Sys Bulk Load Pk) If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
sys_bulk_load_at	string (Sys Bulk Load At) If this record was loaded via bulk, the timestamp when the record was processed
sys_bulk_load_id	string (Sys Bulk Load) If this record was loaded via bulk, the ID of the bulk load process
sys_bulk_load_record_no	number <float> (Sys Bulk Load Record No) If this record was loaded via bulk, the record number in the source file
sys_bulk_load_source_file	string (Sys Bulk Load Source File) If this record was loaded via bulk, the source file
sys_last_bulk_data_operation_id	string (Sys Last Bulk Data Operation) If this record was last touched by a bulk data operation, the ID of that operation
sys_last_bulk_data_operation_sys_version	string (Sys Last Bulk Data Operation Sys Version) If this record was last touched by a bulk data operation, the sys_version at the time of that operation
sys_directive	string (Sys Directive) Means for passing directive information into an object processing logic
sys_calculated_field_error	string (Sys Calculated Field Error) The error associated with the calculated field
sys_snapshot_base_version	number <float> (Sys Snapshot Base Version) The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
sys_has_files_in_s3	boolean (Sys Has Files In S3) If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
sys_configuration_snapshot_id	string (Sys Configuration Snapshot) If a snapshot was restored/applies to this record, the ID of the snapshot
sys_last_security_context	object (Sys Last Security Context) The security context of the last insert, modify, or delete performed on this item
	Array of objects

Responses

200The event was updated successfully.

400The event supplied was not valid.

401Unauthorized.

403Forbidden.

404The event could not be found.

409The event could not be saved because it refers to/depends on a non-existent object.

429Limit exceeded... unable to retrieve event based on tenant limits.

500General server error.

put/events/{tenantId}/{id}

Request samples

application/json

{"id": "string",
"business_unit_id": "string",
"name": "string",
"type_id": "string",
"venue_id": "string",
"previous_event_id": "string",
"masthead_image_uri": "string",
"do_not_stretch_masthead": true,
"thumbnail_image_uri": "string",
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"date_to_remove_from_portal": "2019-08-24T14:15:22Z",
"site_mode": "microsite",
"url": "string",
"portal_integrated_events_options": {"show_schedule": true,
"show_group_registration": true,
"show_registrant_directory": true,
"registrant_directory_id": "string"
},
"address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"timezone_mode": "local",
"timezone": "string",
"featured": true,
"featured_from": "2019-08-24T14:15:22Z",
"featured_until": "2019-08-24T14:15:22Z",
"timezone_offset": 0,
"timezone_abbreviation": "string",
"cloned_from_id": "string",
"enable_capacity": true,
"capacity_options": {"capacity": 0,
"text_to_display_when_sold_out": "string",
"enable_wait_list": true,
"waitlist_process_id": "string"
},
"chapter_id": "string",
"enable_components": true,
"enable_logistics": true,
"enable_courses": true,
"enable_registration": true,
"enable_abstracts": true,
"enable_sessions": true,
"enable_functions": true,
"enable_exhibitors": true,
"enable_sponsors": true,
"enable_volunteers": true,
"enable_onsite": true,
"enable_documents": true,
"description": "string",
"sold_out": true,
"visible_in_portal": true,
"registration_deadlines": [{"id": "string",
"date": "2019-08-24T14:15:22Z"
}
],
"restrict_console_access": true,
"console_access_options": {"user_security_role_ids": ["string"
],
"administrator_security_role_ids": ["string"
]
},
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}

Response samples

application/json

{"id": "string",
"business_unit_id": "string",
"name": "string",
"type_id": "string",
"venue_id": "string",
"previous_event_id": "string",
"masthead_image_uri": "string",
"do_not_stretch_masthead": true,
"thumbnail_image_uri": "string",
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"date_to_remove_from_portal": "2019-08-24T14:15:22Z",
"site_mode": "microsite",
"url": "string",
"portal_integrated_events_options": {"show_schedule": true,
"show_group_registration": true,
"show_registrant_directory": true,
"registrant_directory_id": "string"
},
"address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"timezone_mode": "local",
"timezone": "string",
"featured": true,
"featured_from": "2019-08-24T14:15:22Z",
"featured_until": "2019-08-24T14:15:22Z",
"timezone_offset": 0,
"timezone_abbreviation": "string",
"cloned_from_id": "string",
"enable_capacity": true,
"capacity_options": {"capacity": 0,
"text_to_display_when_sold_out": "string",
"enable_wait_list": true,
"waitlist_process_id": "string"
},
"chapter_id": "string",
"enable_components": true,
"enable_logistics": true,
"enable_courses": true,
"enable_registration": true,
"enable_abstracts": true,
"enable_sessions": true,
"enable_functions": true,
"enable_exhibitors": true,
"enable_sponsors": true,
"enable_volunteers": true,
"enable_onsite": true,
"enable_documents": true,
"description": "string",
"sold_out": true,
"visible_in_portal": true,
"registration_deadlines": [{"id": "string",
"date": "2019-08-24T14:15:22Z"
}
],
"restrict_console_access": true,
"console_access_options": {"user_security_role_ids": ["string"
],
"administrator_security_role_ids": ["string"
]
},
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}

Partially updates a event with the specified ID.

This method will patch an existing event with the specified ID, using the HTTP PATCH specification.

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The id of the tenant being accessed.
id required	string The ID of the event to patch.

Request Body schema: application/json

The patch directives conforming to RFC 6902.

Array

op required	string (Op) The operation Enum: "add" "remove" "replace" "move" "copy" "test"
path required	string (Path) The JSON path
value	string (Value) The updated value

Responses

200The event was patched successfully.

400The JSON patch directive you supplied was not valid.

401Unauthorized.

403Forbidden.

404The event could not be found.

409The event could not be saved because it refers to/depends on a non-existent object.

429Limit exceeded... unable to retrieve event based on tenant limits.

500General server error.

patch/events/{tenantId}/{id}

Request samples

application/json

[{"op": "add",
"path": "string",
"value": "string"
}
]

Response samples

application/json

{"id": "string",
"business_unit_id": "string",
"name": "string",
"type_id": "string",
"venue_id": "string",
"previous_event_id": "string",
"masthead_image_uri": "string",
"do_not_stretch_masthead": true,
"thumbnail_image_uri": "string",
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"date_to_remove_from_portal": "2019-08-24T14:15:22Z",
"site_mode": "microsite",
"url": "string",
"portal_integrated_events_options": {"show_schedule": true,
"show_group_registration": true,
"show_registrant_directory": true,
"registrant_directory_id": "string"
},
"address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"timezone_mode": "local",
"timezone": "string",
"featured": true,
"featured_from": "2019-08-24T14:15:22Z",
"featured_until": "2019-08-24T14:15:22Z",
"timezone_offset": 0,
"timezone_abbreviation": "string",
"cloned_from_id": "string",
"enable_capacity": true,
"capacity_options": {"capacity": 0,
"text_to_display_when_sold_out": "string",
"enable_wait_list": true,
"waitlist_process_id": "string"
},
"chapter_id": "string",
"enable_components": true,
"enable_logistics": true,
"enable_courses": true,
"enable_registration": true,
"enable_abstracts": true,
"enable_sessions": true,
"enable_functions": true,
"enable_exhibitors": true,
"enable_sponsors": true,
"enable_volunteers": true,
"enable_onsite": true,
"enable_documents": true,
"description": "string",
"sold_out": true,
"visible_in_portal": true,
"registration_deadlines": [{"id": "string",
"date": "2019-08-24T14:15:22Z"
}
],
"restrict_console_access": true,
"console_access_options": {"user_security_role_ids": ["string"
],
"administrator_security_role_ids": ["string"
]
},
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}

Returns a event from the system by its ID.

This method will delete a event with the specified ID.

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The id of the tenant being accessed.
id required	string The ID of the event to delete.

Responses

200The event was deleted successfully.

400The request was not valid.

401Unauthorized.

403Forbidden.

404The event could not be found.

409The event could not be deleted because other objects refers to/depends on this one.

429Limit exceeded... unable to delete event based on tenant limits.

500General server error.

delete/events/{tenantId}/{id}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X DELETE \
  https://events.api.756794052567.rhythmsoftware.com/events/:tenantId/:id \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

"string"

Returns a list of records with the specified type_id

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The tenant
type_id required	string The type_id to use to for record lookup

query Parameters

fields	string The fields that you want to retrieve; if omitted, the entire object is returned
exclusiveStartKey	string If paging, this allows you to return the next set of results

Responses

200The records were retrieved successfully

400The request was not valid.

401Unauthorized.

403Forbidden

404Unable to locate records

429Limit exceeded... unable to retrieve records based on tenant limits.

500General server error

get/events/{tenantId}/type/{type_id}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  'https://events.api.756794052567.rhythmsoftware.com/events/:tenantId/type/:type_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"Count": 0,
"Items": [{"id": "string",
"business_unit_id": "string",
"name": "string",
"type_id": "string",
"venue_id": "string",
"previous_event_id": "string",
"masthead_image_uri": "string",
"do_not_stretch_masthead": true,
"thumbnail_image_uri": "string",
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"date_to_remove_from_portal": "2019-08-24T14:15:22Z",
"site_mode": "microsite",
"url": "string",
"portal_integrated_events_options": {"show_schedule": true,
"show_group_registration": true,
"show_registrant_directory": true,
"registrant_directory_id": "string"
},
"address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"timezone_mode": "local",
"timezone": "string",
"featured": true,
"featured_from": "2019-08-24T14:15:22Z",
"featured_until": "2019-08-24T14:15:22Z",
"timezone_offset": 0,
"timezone_abbreviation": "string",
"cloned_from_id": "string",
"enable_capacity": true,
"capacity_options": {"capacity": 0,
"text_to_display_when_sold_out": "string",
"enable_wait_list": true,
"waitlist_process_id": "string"
},
"chapter_id": "string",
"enable_components": true,
"enable_logistics": true,
"enable_courses": true,
"enable_registration": true,
"enable_abstracts": true,
"enable_sessions": true,
"enable_functions": true,
"enable_exhibitors": true,
"enable_sponsors": true,
"enable_volunteers": true,
"enable_onsite": true,
"enable_documents": true,
"description": "string",
"sold_out": true,
"visible_in_portal": true,
"registration_deadlines": [{"id": "string",
"date": "2019-08-24T14:15:22Z"
}
],
"restrict_console_access": true,
"console_access_options": {"user_security_role_ids": ["string"
],
"administrator_security_role_ids": ["string"
]
},
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}
],
"LastEvaluatedKey": "string"
}

Returns a list of records that start after specified start_date

Returns a list of records with that start after the specified start_date

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The tenant
start_date required	string The start_date to use to for record lookup

query Parameters

fields	string The fields that you want to retrieve; if omitted, the entire object is returned
exclusiveStartKey	string If paging, this allows you to return the next set of results

Responses

200The records were retrieved successfully

400The request was not valid.

401Unauthorized.

403Forbidden

404Unable to locate records

429Limit exceeded... unable to retrieve records based on tenant limits.

500General server error

get/events/{tenantId}/startDate/{start_date}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  'https://events.api.756794052567.rhythmsoftware.com/events/:tenantId/startDate/:start_date?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"Items": [{"id": "string",
"name": "string",
"type_id": "string",
"type_name": "string",
"venue_id": "string",
"venue_name": "string",
"location": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"visible_in_portal": true,
"description": "string",
"masthead_image_uri": "string",
"thumbnail_image_uri": "string",
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"url": "string",
"site_mode": "microsite",
"sold_out": true,
"text_to_display_when_sold_out": "string",
"portal_integrated_events_options": {"show_schedule": true,
"show_group_registration": true,
"show_registrant_directory": true,
"registrant_directory_id": "string"
},
"featured": true,
"featured_from": "2019-08-24T14:15:22Z",
"featured_until": "2019-08-24T14:15:22Z",
"wait_list_available": true,
"currency_code": "string",
"currency_symbol": "string",
"timezone": "string",
"timezone_offset": 0,
"timezone_abbreviation": "string",
"enable_documents": true,
"registration_deadlines": [{"id": "string",
"name": "string",
"date": "2019-08-24T14:15:22Z"
}
]
}
],
"LastEvaluatedKey": "string"
}

Gets the public event info

Request

path Parameters

tenantId required	string The tenant
id required	string The id of the event

Responses

200The store was retrieved

400The request was not valid.

401Unauthorized

403Forbidden

404Unable to locate records

429Limit exceeded... unable to retrieve records based on tenant limits.

500General server error

get/events/{tenantId}/public/{id}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  https://events.api.756794052567.rhythmsoftware.com/events/:tenantId/public/:id

Response samples

application/json

{"id": "string",
"name": "string",
"type_id": "string",
"type_name": "string",
"venue_id": "string",
"venue_name": "string",
"location": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"visible_in_portal": true,
"description": "string",
"masthead_image_uri": "string",
"thumbnail_image_uri": "string",
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"url": "string",
"site_mode": "microsite",
"sold_out": true,
"text_to_display_when_sold_out": "string",
"portal_integrated_events_options": {"show_schedule": true,
"show_group_registration": true,
"show_registrant_directory": true,
"registrant_directory_id": "string"
},
"featured": true,
"featured_from": "2019-08-24T14:15:22Z",
"featured_until": "2019-08-24T14:15:22Z",
"wait_list_available": true,
"currency_code": "string",
"currency_symbol": "string",
"timezone": "string",
"timezone_offset": 0,
"timezone_abbreviation": "string",
"enable_documents": true,
"registration_deadlines": [{"id": "string",
"name": "string",
"date": "2019-08-24T14:15:22Z"
}
]
}

Returns a list of records that are upcoming

Request

path Parameters

tenantId

required

string

The tenant

query Parameters

fields	string The fields that you want to retrieve; if omitted, the entire object is returned
exclusiveStartKey	string If paging, this allows you to return the next set of results

Responses

200The records were retrieved successfully

400The request was not valid.

401Unauthorized.

403Forbidden

404Unable to locate records

429Limit exceeded... unable to retrieve records based on tenant limits.

500General server error

get/events/{tenantId}/public/upcoming

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  'https://events.api.756794052567.rhythmsoftware.com/events/:tenantId/public/upcoming?fields=string&exclusiveStartKey=string'

Response samples

application/json

{"Items": [{"id": "string",
"name": "string",
"type_id": "string",
"type_name": "string",
"venue_id": "string",
"venue_name": "string",
"location": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"visible_in_portal": true,
"description": "string",
"masthead_image_uri": "string",
"thumbnail_image_uri": "string",
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"url": "string",
"site_mode": "microsite",
"sold_out": true,
"text_to_display_when_sold_out": "string",
"portal_integrated_events_options": {"show_schedule": true,
"show_group_registration": true,
"show_registrant_directory": true,
"registrant_directory_id": "string"
},
"featured": true,
"featured_from": "2019-08-24T14:15:22Z",
"featured_until": "2019-08-24T14:15:22Z",
"wait_list_available": true,
"currency_code": "string",
"currency_symbol": "string",
"timezone": "string",
"timezone_offset": 0,
"timezone_abbreviation": "string",
"enable_documents": true,
"registration_deadlines": [{"id": "string",
"name": "string",
"date": "2019-08-24T14:15:22Z"
}
]
}
],
"LastEvaluatedKey": "string"
}

Creates a copy of an event, along with other associated records

Request

Security:

knox-authorizer

path Parameters

tenantId

required

string

The tenant

Request Body schema: application/json

The clone request

source_event_id required	string (Source Event) The source event
id required	string (ID) /^[\w\|-]+$/ The ID of the new event
name required	string (Name)
start_date required	string (Start Date)
end_date required	string (End Date)
include_functions	boolean (Include Functions) Whether to include functions
include_sessions	boolean (Include Sessions) Whether to include sessions
include_coupons	boolean (Include Coupons) Whether to include coupons
include_review_spaces	boolean (Include Review Spaces) Whether or not to clone review spaces linked to this event
include_sponsorship_opportunities	boolean (Include Sponsorship Opportunities) Whether or not to include sponsorship opportunities
include_microsite	boolean (Include Microsite) Whether to include the microsite
microsite_domain_name required	string (Microsite Domain Name)

Responses

200The records were retrieved successfully

400The request was not valid.

401Unauthorized.

403Forbidden

404Unable to locate records

429Limit exceeded... unable to retrieve records based on tenant limits.

500General server error

post/events/{tenantId}/clone

Request samples

application/json

{"source_event_id": "string",
"id": "string",
"name": "string",
"start_date": "string",
"end_date": "string",
"include_functions": true,
"include_sessions": true,
"include_coupons": true,
"include_review_spaces": true,
"include_sponsorship_opportunities": true,
"include_microsite": true,
"microsite_domain_name": "string"
}

Response samples

application/json

{"id": "string",
"business_unit_id": "string",
"name": "string",
"type_id": "string",
"venue_id": "string",
"previous_event_id": "string",
"masthead_image_uri": "string",
"do_not_stretch_masthead": true,
"thumbnail_image_uri": "string",
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"date_to_remove_from_portal": "2019-08-24T14:15:22Z",
"site_mode": "microsite",
"url": "string",
"portal_integrated_events_options": {"show_schedule": true,
"show_group_registration": true,
"show_registrant_directory": true,
"registrant_directory_id": "string"
},
"address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"timezone_mode": "local",
"timezone": "string",
"featured": true,
"featured_from": "2019-08-24T14:15:22Z",
"featured_until": "2019-08-24T14:15:22Z",
"timezone_offset": 0,
"timezone_abbreviation": "string",
"cloned_from_id": "string",
"enable_capacity": true,
"capacity_options": {"capacity": 0,
"text_to_display_when_sold_out": "string",
"enable_wait_list": true,
"waitlist_process_id": "string"
},
"chapter_id": "string",
"enable_components": true,
"enable_logistics": true,
"enable_courses": true,
"enable_registration": true,
"enable_abstracts": true,
"enable_sessions": true,
"enable_functions": true,
"enable_exhibitors": true,
"enable_sponsors": true,
"enable_volunteers": true,
"enable_onsite": true,
"enable_documents": true,
"description": "string",
"sold_out": true,
"visible_in_portal": true,
"registration_deadlines": [{"id": "string",
"date": "2019-08-24T14:15:22Z"
}
],
"restrict_console_access": true,
"console_access_options": {"user_security_role_ids": ["string"
],
"administrator_security_role_ids": ["string"
]
},
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}

Searches for events using predefined parameters

Request

Security:

knox-authorizer

path Parameters

tenantId

required

string

The id of the tenant being accessed.

query Parameters

exclusiveStartKey	string The start key for the search, for paging support
fieldsToReturn	string The fields that you want to retrieve; if omitted, the entire object is returned

Request Body schema: application/json

The event that you would like to be saved.

id	string (ID) The id
name	string (Name) The name
city	string (City) City to search
state	string (State) The state
start_date	Array of strings <date-time> (Start Date) 2 items
end_date	Array of strings <date-time> (End Date) 2 items
type_id	Array of strings (Type)
venue_id	Array of strings (Venue)
visible_in_portal	boolean (Visible In Portal)

Responses

200The event search was saved successfully.

400The event you supplied was invalid.

401Unauthorized.

403Forbidden.

404The resource could not be found

409The event could not be saved because it refers to/depends on a non-existent object.

429Limit exceeded... unable to add event based on tenant limits.

500General server error.

post/events/{tenantId}/search

Request samples

application/json

{"id": "string",
"name": "string",
"city": "string",
"state": "string",
"start_date": ["2019-08-24T14:15:22Z",
"2019-08-24T14:15:22Z"
],
"end_date": ["2019-08-24T14:15:22Z",
"2019-08-24T14:15:22Z"
],
"type_id": ["string"
],
"venue_id": ["string"
],
"visible_in_portal": true
}

Response samples

application/json

{"Items": [{"id": "string",
"name": "string",
"city": "string",
"state": "string",
"start_date": ["2019-08-24T14:15:22Z",
"2019-08-24T14:15:22Z"
],
"end_date": ["2019-08-24T14:15:22Z",
"2019-08-24T14:15:22Z"
],
"type_id": ["string"
],
"venue_id": ["string"
],
"visible_in_portal": true
}
],
"LastEvaluatedKey": "string"
}

Returns a list of records with the specified chapter_id

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The tenant
chapter_id required	string The chapter_id to use to for record lookup

query Parameters

fields	string The fields that you want to retrieve; if omitted, the entire object is returned
exclusiveStartKey	string If paging, this allows you to return the next set of results

Responses

200The records were retrieved successfully

400The request was not valid.

401Unauthorized.

403Forbidden

404Unable to locate records

429Limit exceeded... unable to retrieve records based on tenant limits.

500General server error

get/events/{tenantId}/chapter/{chapter_id}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  'https://events.api.756794052567.rhythmsoftware.com/events/:tenantId/chapter/:chapter_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"Count": 0,
"Items": [{"id": "string",
"business_unit_id": "string",
"name": "string",
"type_id": "string",
"venue_id": "string",
"previous_event_id": "string",
"masthead_image_uri": "string",
"do_not_stretch_masthead": true,
"thumbnail_image_uri": "string",
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"date_to_remove_from_portal": "2019-08-24T14:15:22Z",
"site_mode": "microsite",
"url": "string",
"portal_integrated_events_options": {"show_schedule": true,
"show_group_registration": true,
"show_registrant_directory": true,
"registrant_directory_id": "string"
},
"address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"timezone_mode": "local",
"timezone": "string",
"featured": true,
"featured_from": "2019-08-24T14:15:22Z",
"featured_until": "2019-08-24T14:15:22Z",
"timezone_offset": 0,
"timezone_abbreviation": "string",
"cloned_from_id": "string",
"enable_capacity": true,
"capacity_options": {"capacity": 0,
"text_to_display_when_sold_out": "string",
"enable_wait_list": true,
"waitlist_process_id": "string"
},
"chapter_id": "string",
"enable_components": true,
"enable_logistics": true,
"enable_courses": true,
"enable_registration": true,
"enable_abstracts": true,
"enable_sessions": true,
"enable_functions": true,
"enable_exhibitors": true,
"enable_sponsors": true,
"enable_volunteers": true,
"enable_onsite": true,
"enable_documents": true,
"description": "string",
"sold_out": true,
"visible_in_portal": true,
"registration_deadlines": [{"id": "string",
"date": "2019-08-24T14:15:22Z"
}
],
"restrict_console_access": true,
"console_access_options": {"user_security_role_ids": ["string"
],
"administrator_security_role_ids": ["string"
]
},
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}
],
"LastEvaluatedKey": "string"
}

Execute Batch Operations

TAllows you to perform up to 100 parallel patch/delete operations

Request

Security:

knox-authorizer

path Parameters

tenantId

required

string

The id of the tenant being accessed.

Request Body schema: application/json

The batch request

Array of objects

Responses

200Request completed successfully.

400The request was not valid.

401Unauthorized.

403Forbidden.

404The event could not be found.

429Limit exceeded... unable to retrieve event based on tenant limits.

500General server error.

post/events/{tenantId}/batch

Request samples

application/json

{"operations": [{"operation": "create",
"id": "string",
"patch_directives": [{"op": "add",
"path": "string",
"value": "string"
}
],
"object": { },
"payload": {"new_status": "draft",
"suppress_email_notifications": true,
"abstract": {"id": "string",
"event_id": "string",
"main_presenter_id": "string",
"process_id": "string",
"first_name": "string",
"last_name": "string",
"name": "string",
"email_address": "string",
"city": "string",
"state": "string",
"country": "string",
"job_title": "string",
"review_status": "pending review",
"last_review_status_change": "2019-08-24T14:15:22Z",
"pending_console_review": true,
"submission_space_id": "string",
"override_bucket_assignment": true,
"round_id": "string",
"bucket_id": "string",
"average_score": 0,
"total_score": 0,
"reviewer_recommendation": "string",
"organization_id": "string",
"submitter_id": "string",
"has_co_authors": true,
"co_authors": [{"co_author_contact_info": { },
"co_author_contact_id": "string",
"speaker_type_id": "string"
}
],
"status": "draft",
"session_has_been_generated": true,
"title": "string",
"body": "string",
"type_id": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": [null
],
"table_value": [{ }
]
}
],
"date": "2019-08-24T14:15:22Z",
"session_track_ids": ["string"
],
"number": 0,
"max_contact_submissions": 0,
"submitting_on_behalf_of_presenter": true,
"presenter_info": {"contact_info": { },
"email_presenter": true
},
"review_process_id": "string",
"reviews_assigned": true,
"review_round_id": "string",
"notes": "string",
"approval_process_id": "string",
"round_scores": [{"round_id": "string",
"score": 0
}
],
"co_author_1": {"speaker_type_id": "string",
"first_name": "string",
"last_name": "string",
"email_address": "string",
"phone_number": "string"
},
"co_author_2": {"speaker_type_id": "string",
"first_name": "string",
"last_name": "string",
"email_address": "string",
"phone_number": "string"
},
"co_author_3": {"speaker_type_id": "string",
"first_name": "string",
"last_name": "string",
"email_address": "string",
"phone_number": "string"
},
"co_author_4": {"speaker_type_id": "string",
"first_name": "string",
"last_name": "string",
"email_address": "string",
"phone_number": "string"
},
"co_author_5": {"speaker_type_id": "string",
"first_name": "string",
"last_name": "string",
"email_address": "string",
"phone_number": "string"
},
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
},
"type_id": "string",
"main_presenter_speaker_type_id": "string",
"allow_duplicates": true
}
}
]
}

Response samples

application/json

{"success_count": 0,
"error_count": 0,
"results": [{"operation": "create",
"id": "string",
"outcome": "success",
"error_message": "string",
"object": { }
}
]
}