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

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

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

Download OpenAPI description
Languages
Servers
Mock server
https://docs.api.rhythmsoftware.com/_mock/apis/events/events-v1/
https://events.api.rhythmsoftware.com/

Abstract Approval Processes

Abstract Approval Processes

Operations

Abstract Decision Processes

Abstract Decision Processes

Operations

Abstract Review Processes

Abstract Review Processes

Operations

Abstract Review Rounds

Abstract Review Rounds

Operations

Abstract Reviews

Abstract Reviews

Operations

Abstract Settings

Abstract Settings

Operations

Abstract Submission Processes

Abstract Submission Processes

Operations

Abstract Types

Abstract Types

Operations

Abstracts

Abstracts

Operations

Coupons

Coupons

Operations

Events

Events

Operations

Exhibitor Add On Products

Exhibitor Add On Products

Operations

Exhibitor Booth Fees

Exhibitor Booth Fees

Operations

Exhibitor Booth Types

Exhibitor Booth Types

Operations

Exhibitor Booths

Exhibitor Booths

Operations

Exhibitor Categories

Exhibitor Categories

Operations

Exhibitor Contact Types

Exhibitor Contact Types

Operations

Exhibitor Priority Point Types

Exhibitor Priority Point Types

Operations

Exhibitor Reg Processes

Exhibitor Reg Processes

Operations

Exhibitor Registrations

Exhibitor Registrations

Operations

Exhibitor Settings

Exhibitor Settings

Operations

Exhibitor Show Floors

Exhibitor Show Floors

Operations

Exhibitors

Exhibitors

Operations

Function Fees

Function Fees

Operations

Function Tickets

Function Tickets

Operations

Function Types

Function Types

Operations

Functions

Functions

Operations

Miscellaneous Events

Miscellaneous Events

Operations

Priority Point Assignments

Priority Point Assignments

Operations

Query Definitions

Query Definitions

Operations

Registrant Directories

Registrant Directories

Operations

Registration Add On Products

Registration Add On Products

Operations

Registration Add On Types

Registration Add On Types

Operations

Registration Categories

Registration Categories

Operations

Registration Change Fees

Registration Change Fees

Operations

Registration Deadlines

Registration Deadlines

Operations

Registration Groups

Registration Groups

Operations

Registration Packages

Registration Packages

Operations

Registration Processes

Registration Processes

Operations

Registration Settings

Registration Settings

Operations

Registration Substitutions

Registration Substitutions

Operations

Registration Types

Registration Types

Operations

Registrations

Registrations

Operations

Ribbon Types

Ribbon Types

Operations

Rooms

Rooms

Operations

Session Fees

Session Fees

Operations

Session Registrations

Session Registrations

Operations

Session Tracks

Session Tracks

Operations

Session Types

Session Types

Operations

Sessions

Sessions

Operations

Creates a new session record that does not already exist.

Request

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

Path
tenantIdstringrequired

The id of the tenant being accessed.

Bodyapplication/jsonrequired

The session that you would like to be saved.

abstract_idstring(Abstract)

The abstract this session is linked to

accessstring(Access)

Who has access to this session

Enum"included""optional"
capacity_optionsobject(Capacity Options)required
capacity_options.​capacitynumber(float)(Capacity)>= 0required
capacity_options.​enable_wait_listboolean(Enable Wait List)

If set, people can be placed on a wait list

capacity_options.​waitlist_process_idWaitlist Process (string)(Waitlist Process)

The process to use for managing the waitlist

One of:

The process to use for managing the waitlist

string(Waitlist Process)

The process to use for managing the waitlist

codestring(Code)

Optional code for the event

custom_field_valuesArray of objects(Custom Field Values)
descriptionstring(Description)

A description of the session

disable_portal_registrationboolean(Disable Portal Registration)

If set, portal registration for this session is disabled

display_ordernumber(float)(Display Order)

The display/sort order for the sessions

enable_capacityboolean(Enable Capacity)

If set, the session has a capacity

enable_registration_questionsboolean(Enable Registration Questions)

If set, a user is prompted to answer questions during registration

end_datestring(date-time)(End Date)

The end date/time of the session

event_idstring(Event)required

The event

has_feesboolean(Has Fees)

Whether or not this session has fees

hide_from_portalboolean(Hide From Portal)

This session is not displayed in the portal or available for registration

hide_from_scheduleboolean(Hide From Schedule)

If selected, hide this session from the online schedule

idstring(ID)^[\w|\-:]+$required

The unique, string identifier of this session

locationstring(Location)
main_presenter_speaker_type_idstring(Main Presenter Speaker Type)

The type to be assigned to the main presenter for sessions generated from abstracts

namestring(Name)required

The name of the session

registration_question_optionsobject(Registration Question Options)required
registration_question_options.​custom_fieldsArray of objects

The custom fields to display

registration_question_options.​registration_instructionsstring(Registration Instructions)

Instructions to show during registration for the session

room_idsArray of strings(Rooms)

The room which is holding the event

sold_outboolean(Sold Out)

Whether the event is sold out

speakersArray of objects
start_datestring(date-time)(Start Date)

The start date/time of the session

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(Sys Bulk Load Pk)

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

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects
sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

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

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(Sys Has Files In S3)

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

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

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

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

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

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

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

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

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

track_idsArray of strings(Tracks)

Session tracks

type_idstring(Type)required

The type of session

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/events/events-v1/sessions/{tenantId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "abstract_id": "string",
    "access": "included",
    "capacity_options": {
      "capacity": 0.1,
      "enable_wait_list": true,
      "waitlist_process_id": null
    },
    "code": "string",
    "custom_field_values": [
      {
        "boolean_value": true,
        "custom_field_id": "string",
        "file_url_value": "string",
        "list_value": [
          "string"
        ],
        "numeric_value": 0.1,
        "string_value": "string",
        "table_value": [
          {}
        ]
      }
    ],
    "description": "string",
    "disable_portal_registration": true,
    "display_order": 0.1,
    "enable_capacity": true,
    "enable_registration_questions": true,
    "end_date": "2019-08-24T14:15:22Z",
    "event_id": "string",
    "has_fees": true,
    "hide_from_portal": true,
    "hide_from_schedule": true,
    "id": "string",
    "location": "string",
    "main_presenter_speaker_type_id": "string",
    "name": "string",
    "registration_question_options": {
      "custom_fields": [
        {
          "id": "string",
          "label": "string",
          "required": true
        }
      ],
      "registration_instructions": "string"
    },
    "room_ids": [
      "string"
    ],
    "sold_out": true,
    "speakers": [
      {
        "speaker_id": "string",
        "speaker_type_id": "string"
      }
    ],
    "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,
    "track_ids": [
      "string"
    ],
    "type_id": "string"
  }'

Responses

The session was saved successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
abstract_idstring(Abstract)

The abstract this session is linked to

accessstring(Access)

Who has access to this session

Enum"included""optional"
capacity_optionsobject(Capacity Options)required
capacity_options.​capacitynumber(float)(Capacity)>= 0required
capacity_options.​enable_wait_listboolean(Enable Wait List)

If set, people can be placed on a wait list

capacity_options.​waitlist_process_idWaitlist Process (string)(Waitlist Process)

The process to use for managing the waitlist

One of:

The process to use for managing the waitlist

string(Waitlist Process)

The process to use for managing the waitlist

codestring(Code)

Optional code for the event

custom_field_valuesArray of objects(Custom Field Values)
descriptionstring(Description)

A description of the session

disable_portal_registrationboolean(Disable Portal Registration)

If set, portal registration for this session is disabled

display_ordernumber(float)(Display Order)

The display/sort order for the sessions

enable_capacityboolean(Enable Capacity)

If set, the session has a capacity

enable_registration_questionsboolean(Enable Registration Questions)

If set, a user is prompted to answer questions during registration

end_datestring(date-time)(End Date)

The end date/time of the session

event_idstring(Event)required

The event

has_feesboolean(Has Fees)

Whether or not this session has fees

hide_from_portalboolean(Hide From Portal)

This session is not displayed in the portal or available for registration

hide_from_scheduleboolean(Hide From Schedule)

If selected, hide this session from the online schedule

idstring(ID)^[\w|\-:]+$required

The unique, string identifier of this session

locationstring(Location)
main_presenter_speaker_type_idstring(Main Presenter Speaker Type)

The type to be assigned to the main presenter for sessions generated from abstracts

namestring(Name)required

The name of the session

registration_question_optionsobject(Registration Question Options)required
registration_question_options.​custom_fieldsArray of objects

The custom fields to display

registration_question_options.​registration_instructionsstring(Registration Instructions)

Instructions to show during registration for the session

room_idsArray of strings(Rooms)

The room which is holding the event

sold_outboolean(Sold Out)

Whether the event is sold out

speakersArray of objects
start_datestring(date-time)(Start Date)

The start date/time of the session

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(Sys Bulk Load Pk)

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

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects
sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

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

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(Sys Has Files In S3)

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

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

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

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

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

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

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

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

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

track_idsArray of strings(Tracks)

Session tracks

type_idstring(Type)required

The type of session

Response
application/json
{ "abstract_id": "string", "access": "included", "capacity_options": { "capacity": 0.1, "enable_wait_list": true, "waitlist_process_id": null }, "code": "string", "custom_field_values": [ {} ], "description": "string", "disable_portal_registration": true, "display_order": 0.1, "enable_capacity": true, "enable_registration_questions": true, "end_date": "2019-08-24T14:15:22Z", "event_id": "string", "has_fees": true, "hide_from_portal": true, "hide_from_schedule": true, "id": "string", "location": "string", "main_presenter_speaker_type_id": "string", "name": "string", "registration_question_options": { "custom_fields": [], "registration_instructions": "string" }, "room_ids": [ "string" ], "sold_out": true, "speakers": [ {} ], "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, "track_ids": [ "string" ], "type_id": "string" }

Returns a list of records with the specified abstract_id

Request

Returns a list of records with the specified abstract_id

Path
tenantIdstringrequired

The tenant

abstract_idstringrequired

The abstract_id to use to for record lookup

Query
fieldsstring

The fields that you want to retrieve; if omitted, the entire object is returned

exclusiveStartKeystring

If paging, this allows you to return the next set of results

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/events/events-v1/sessions/{tenantId}/abstract/{abstract_id}?exclusiveStartKey=string&fields=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The records were retrieved successfully

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
Countinteger
ItemsArray of objects(Session)
LastEvaluatedKeystring
Response
application/json
{ "Count": 0, "Items": [ {} ], "LastEvaluatedKey": "string" }

Generate Session from Abstract

Request

Generates a session with speaker information from an abstract record

Path
tenantIdstringrequired

The tenant

abstract_idstringrequired

The id of the abstract

Bodyapplication/jsonrequired

AbstractIDs and FormData for sessions step function

allow_duplicatesboolean(Allow Duplicates)

If true, the system will create additional sessions for abstracts

main_presenter_speaker_type_idstring(Main Presenter Speaker Type)required

The type to be assigned to the main presenter for sessions generated from abstracts

make_co_authors_speakersboolean(Make Co Authors Speakers)

If true, co-authors

type_idstring(Type)required

The type of session to create

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/events/events-v1/sessions/{tenantId}/abstract/{abstract_id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "allow_duplicates": true,
    "main_presenter_speaker_type_id": "string",
    "make_co_authors_speakers": true,
    "type_id": "string"
  }'

Responses

The record was retrieved successfully

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
abstract_idstring(Abstract)

The abstract this session is linked to

accessstring(Access)

Who has access to this session

Enum"included""optional"
capacity_optionsobject(Capacity Options)required
capacity_options.​capacitynumber(float)(Capacity)>= 0required
capacity_options.​enable_wait_listboolean(Enable Wait List)

If set, people can be placed on a wait list

capacity_options.​waitlist_process_idWaitlist Process (string)(Waitlist Process)

The process to use for managing the waitlist

One of:

The process to use for managing the waitlist

string(Waitlist Process)

The process to use for managing the waitlist

codestring(Code)

Optional code for the event

custom_field_valuesArray of objects(Custom Field Values)
descriptionstring(Description)

A description of the session

disable_portal_registrationboolean(Disable Portal Registration)

If set, portal registration for this session is disabled

display_ordernumber(float)(Display Order)

The display/sort order for the sessions

enable_capacityboolean(Enable Capacity)

If set, the session has a capacity

enable_registration_questionsboolean(Enable Registration Questions)

If set, a user is prompted to answer questions during registration

end_datestring(date-time)(End Date)

The end date/time of the session

event_idstring(Event)required

The event

has_feesboolean(Has Fees)

Whether or not this session has fees

hide_from_portalboolean(Hide From Portal)

This session is not displayed in the portal or available for registration

hide_from_scheduleboolean(Hide From Schedule)

If selected, hide this session from the online schedule

idstring(ID)^[\w|\-:]+$required

The unique, string identifier of this session

locationstring(Location)
main_presenter_speaker_type_idstring(Main Presenter Speaker Type)

The type to be assigned to the main presenter for sessions generated from abstracts

namestring(Name)required

The name of the session

registration_question_optionsobject(Registration Question Options)required
registration_question_options.​custom_fieldsArray of objects

The custom fields to display

registration_question_options.​registration_instructionsstring(Registration Instructions)

Instructions to show during registration for the session

room_idsArray of strings(Rooms)

The room which is holding the event

sold_outboolean(Sold Out)

Whether the event is sold out

speakersArray of objects
start_datestring(date-time)(Start Date)

The start date/time of the session

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(Sys Bulk Load Pk)

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

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects
sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

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

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(Sys Has Files In S3)

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

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

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

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

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

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

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

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

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

track_idsArray of strings(Tracks)

Session tracks

type_idstring(Type)required

The type of session

Response
application/json
{ "abstract_id": "string", "access": "included", "capacity_options": { "capacity": 0.1, "enable_wait_list": true, "waitlist_process_id": null }, "code": "string", "custom_field_values": [ {} ], "description": "string", "disable_portal_registration": true, "display_order": 0.1, "enable_capacity": true, "enable_registration_questions": true, "end_date": "2019-08-24T14:15:22Z", "event_id": "string", "has_fees": true, "hide_from_portal": true, "hide_from_schedule": true, "id": "string", "location": "string", "main_presenter_speaker_type_id": "string", "name": "string", "registration_question_options": { "custom_fields": [], "registration_instructions": "string" }, "room_ids": [ "string" ], "sold_out": true, "speakers": [ {} ], "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, "track_ids": [ "string" ], "type_id": "string" }

Execute Batch Operations

Request

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

Path
tenantIdstringrequired

The id of the tenant being accessed.

Bodyapplication/jsonrequired

The batch request

operationsArray of objects
curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/events/events-v1/sessions/{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"
        }
      }
    ]
  }'

Responses

Request completed successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
error_countnumber(float)(Error Count)

Number of error results

resultsArray of objects
success_countnumber(float)(Success Count)

Number of successful results

Response
application/json
{ "error_count": 0.1, "results": [ {} ], "success_count": 0.1 }

Returns a list of records with the specified event_id

Request

Returns a list of records with the specified event_id

Path
tenantIdstringrequired

The tenant

event_idstringrequired

The event_id to use to for record lookup

Query
fieldsstring

The fields that you want to retrieve; if omitted, the entire object is returned

exclusiveStartKeystring

If paging, this allows you to return the next set of results

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/events/events-v1/sessions/{tenantId}/event/{event_id}?exclusiveStartKey=string&fields=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The records were retrieved successfully

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
Countinteger
ItemsArray of objects(Session)
LastEvaluatedKeystring
Response
application/json
{ "Count": 0, "Items": [ {} ], "LastEvaluatedKey": "string" }

Get Privileges for a session

Request

Returns things a person can do for a session

Path
tenantIdstringrequired

The tenant

idstringrequired

The session ID

contactIdstringrequired

The contact

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/events/events-v1/sessions/{tenantId}/privileges/{id}/{contactId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The records were retrieved successfully

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
can_edit_sessionboolean(Can Edit Session)
can_manage_documentsboolean(Can Manage Documents)
can_update_speaker_profileboolean(Can Update Speaker Profile)
Response
application/json
{ "can_edit_session": true, "can_manage_documents": true, "can_update_speaker_profile": true }

Describes all of the sessions for an event

Request

Returns a list of records with the specified event_id

Path
tenantIdstringrequired

The tenant

event_idstringrequired

The event_id to use to for record lookup

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/events/events-v1/sessions/{tenantId}/public/event/{event_id}'

Responses

The records were retrieved successfully

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
Countinteger
ItemsArray of objects(SessionPublic)
LastEvaluatedKeystring
Response
application/json
{ "Count": 0, "Items": [ {} ], "LastEvaluatedKey": "string" }

Searches for sessions using predefined parameters

Request

Searches for sessions using predefined parameters

Path
tenantIdstringrequired

The id of the tenant being accessed.

Query
exclusiveStartKeystring

The start key for the search, for paging support

fieldsToReturnstring

The fields that you want to retrieve; if omitted, the entire object is returned

Bodyapplication/jsonrequired

The session that you would like to be saved.

abstract_idArray of strings(Abstract)
accessArray of strings(Access)
end_dateArray of strings(date-time)(End Date)= 2 items
event_idstring(Event)required
has_feesArray of booleans(Has Fees)
idsArray of strings(Ids)

IDs to search

namestring(Name)
speakersArray of strings(Speakers)
start_dateArray of strings(date-time)(Start Date)= 2 items
track_idsArray of strings(Tracks)
type_idArray of strings(Type)
curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/events/events-v1/sessions/{tenantId}/public/search?exclusiveStartKey=string&fieldsToReturn=string' \
  -H 'Content-Type: application/json' \
  -d '{
    "abstract_id": [
      "string"
    ],
    "access": [
      "string"
    ],
    "end_date": [
      "2019-08-24T14:15:22Z",
      "2019-08-24T14:15:22Z"
    ],
    "event_id": "string",
    "has_fees": [
      true
    ],
    "ids": [
      "string"
    ],
    "name": "string",
    "speakers": [
      "string"
    ],
    "start_date": [
      "2019-08-24T14:15:22Z",
      "2019-08-24T14:15:22Z"
    ],
    "track_ids": [
      "string"
    ],
    "type_id": [
      "string"
    ]
  }'

Responses

The session search was saved successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
ItemsArray of objects(SessionSearchResults)
LastEvaluatedKeystring
Response
application/json
{ "Items": [ {} ], "LastEvaluatedKey": "string" }

Returns a session from the system by its ID.

Request

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

Path
tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the session to return.

Query
fieldsstring

The fields that you want to retrieve; if omitted, the entire object is returned.

consistentReadstring

Indicates the API should force a consistent read on the data source.

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/events/events-v1/sessions/{tenantId}/public/{id}?consistentRead=string&fields=string'

Responses

The session was retrieved successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
abstract_idstring(Abstract)

The abstract this session is linked to

accessstring(Access)

Who has access to this session

Enum"included""optional"
capacity_optionsobject(Capacity Options)required
capacity_options.​capacitynumber(float)(Capacity)>= 0required
capacity_options.​enable_wait_listboolean(Enable Wait List)

If set, people can be placed on a wait list

capacity_options.​waitlist_process_idWaitlist Process (string)(Waitlist Process)

The process to use for managing the waitlist

One of:

The process to use for managing the waitlist

string(Waitlist Process)

The process to use for managing the waitlist

codestring(Code)

Optional code for the event

custom_field_valuesArray of objects(Custom Field Values)
descriptionstring(Description)

A description of the session

disable_portal_registrationboolean(Disable Portal Registration)

If set, portal registration for this session is disabled

display_ordernumber(float)(Display Order)

The display/sort order for the sessions

enable_capacityboolean(Enable Capacity)

If set, the session has a capacity

enable_registration_questionsboolean(Enable Registration Questions)

If set, a user is prompted to answer questions during registration

end_datestring(date-time)(End Date)

The end date/time of the session

event_idstring(Event)required

The event

has_feesboolean(Has Fees)

Whether or not this session has fees

hide_from_portalboolean(Hide From Portal)

This session is not displayed in the portal or available for registration

hide_from_scheduleboolean(Hide From Schedule)

If selected, hide this session from the online schedule

idstring(ID)^[\w|\-:]+$required

The unique, string identifier of this session

locationstring(Location)
main_presenter_speaker_type_idstring(Main Presenter Speaker Type)

The type to be assigned to the main presenter for sessions generated from abstracts

namestring(Name)required

The name of the session

registration_question_optionsobject(Registration Question Options)required
registration_question_options.​custom_fieldsArray of objects

The custom fields to display

registration_question_options.​registration_instructionsstring(Registration Instructions)

Instructions to show during registration for the session

room_idsArray of strings(Rooms)

The room which is holding the event

sold_outboolean(Sold Out)

Whether the event is sold out

speakersArray of objects
start_datestring(date-time)(Start Date)

The start date/time of the session

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(Sys Bulk Load Pk)

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

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects
sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

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

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(Sys Has Files In S3)

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

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

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

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

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

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

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

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

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

track_idsArray of strings(Tracks)

Session tracks

type_idstring(Type)required

The type of session

Response
application/json
{ "abstract_id": "string", "access": "included", "capacity_options": { "capacity": 0.1, "enable_wait_list": true, "waitlist_process_id": null }, "code": "string", "custom_field_values": [ {} ], "description": "string", "disable_portal_registration": true, "display_order": 0.1, "enable_capacity": true, "enable_registration_questions": true, "end_date": "2019-08-24T14:15:22Z", "event_id": "string", "has_fees": true, "hide_from_portal": true, "hide_from_schedule": true, "id": "string", "location": "string", "main_presenter_speaker_type_id": "string", "name": "string", "registration_question_options": { "custom_fields": [], "registration_instructions": "string" }, "room_ids": [ "string" ], "sold_out": true, "speakers": [ {} ], "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, "track_ids": [ "string" ], "type_id": "string" }

Searches for sessions using predefined parameters

Request

Searches for sessions using predefined parameters

Path
tenantIdstringrequired

The id of the tenant being accessed.

Query
exclusiveStartKeystring

The start key for the search, for paging support

fieldsToReturnstring

The fields that you want to retrieve; if omitted, the entire object is returned

Bodyapplication/jsonrequired

The session that you would like to be saved.

abstract_idArray of strings(Abstract)
accessArray of strings(Access)
end_dateArray of strings(date-time)(End Date)= 2 items
event_idstring(Event)required
has_feesArray of booleans(Has Fees)
idsArray of strings(Ids)

IDs to search

namestring(Name)
speakersArray of strings(Speakers)
start_dateArray of strings(date-time)(Start Date)= 2 items
track_idsArray of strings(Tracks)
type_idArray of strings(Type)
curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/events/events-v1/sessions/{tenantId}/search?exclusiveStartKey=string&fieldsToReturn=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "abstract_id": [
      "string"
    ],
    "access": [
      "string"
    ],
    "end_date": [
      "2019-08-24T14:15:22Z",
      "2019-08-24T14:15:22Z"
    ],
    "event_id": "string",
    "has_fees": [
      true
    ],
    "ids": [
      "string"
    ],
    "name": "string",
    "speakers": [
      "string"
    ],
    "start_date": [
      "2019-08-24T14:15:22Z",
      "2019-08-24T14:15:22Z"
    ],
    "track_ids": [
      "string"
    ],
    "type_id": [
      "string"
    ]
  }'

Responses

The session search was saved successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
ItemsArray of objects(SessionSearchResults)
LastEvaluatedKeystring
Response
application/json
{ "Items": [ {} ], "LastEvaluatedKey": "string" }

Returns a session from the system by its ID.

Request

This method will delete a session with the specified ID.

Path
tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the session to delete.

curl -i -X DELETE \
  'https://docs.api.rhythmsoftware.com/_mock/apis/events/events-v1/sessions/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The session was deleted successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
string
Response
application/json
"string"

Returns a session from the system by its ID.

Request

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

Path
tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the session to return.

Query
fieldsstring

The fields that you want to retrieve; if omitted, the entire object is returned.

consistentReadstring

Indicates the API should force a consistent read on the data source.

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/events/events-v1/sessions/{tenantId}/{id}?consistentRead=string&fields=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The session was retrieved successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
abstract_idstring(Abstract)

The abstract this session is linked to

accessstring(Access)

Who has access to this session

Enum"included""optional"
capacity_optionsobject(Capacity Options)required
capacity_options.​capacitynumber(float)(Capacity)>= 0required
capacity_options.​enable_wait_listboolean(Enable Wait List)

If set, people can be placed on a wait list

capacity_options.​waitlist_process_idWaitlist Process (string)(Waitlist Process)

The process to use for managing the waitlist

One of:

The process to use for managing the waitlist

string(Waitlist Process)

The process to use for managing the waitlist

codestring(Code)

Optional code for the event

custom_field_valuesArray of objects(Custom Field Values)
descriptionstring(Description)

A description of the session

disable_portal_registrationboolean(Disable Portal Registration)

If set, portal registration for this session is disabled

display_ordernumber(float)(Display Order)

The display/sort order for the sessions

enable_capacityboolean(Enable Capacity)

If set, the session has a capacity

enable_registration_questionsboolean(Enable Registration Questions)

If set, a user is prompted to answer questions during registration

end_datestring(date-time)(End Date)

The end date/time of the session

event_idstring(Event)required

The event

has_feesboolean(Has Fees)

Whether or not this session has fees

hide_from_portalboolean(Hide From Portal)

This session is not displayed in the portal or available for registration

hide_from_scheduleboolean(Hide From Schedule)

If selected, hide this session from the online schedule

idstring(ID)^[\w|\-:]+$required

The unique, string identifier of this session

locationstring(Location)
main_presenter_speaker_type_idstring(Main Presenter Speaker Type)

The type to be assigned to the main presenter for sessions generated from abstracts

namestring(Name)required

The name of the session

registration_question_optionsobject(Registration Question Options)required
registration_question_options.​custom_fieldsArray of objects

The custom fields to display

registration_question_options.​registration_instructionsstring(Registration Instructions)

Instructions to show during registration for the session

room_idsArray of strings(Rooms)

The room which is holding the event

sold_outboolean(Sold Out)

Whether the event is sold out

speakersArray of objects
start_datestring(date-time)(Start Date)

The start date/time of the session

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(Sys Bulk Load Pk)

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

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects
sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

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

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(Sys Has Files In S3)

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

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

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

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

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

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

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

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

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

track_idsArray of strings(Tracks)

Session tracks

type_idstring(Type)required

The type of session

Response
application/json
{ "abstract_id": "string", "access": "included", "capacity_options": { "capacity": 0.1, "enable_wait_list": true, "waitlist_process_id": null }, "code": "string", "custom_field_values": [ {} ], "description": "string", "disable_portal_registration": true, "display_order": 0.1, "enable_capacity": true, "enable_registration_questions": true, "end_date": "2019-08-24T14:15:22Z", "event_id": "string", "has_fees": true, "hide_from_portal": true, "hide_from_schedule": true, "id": "string", "location": "string", "main_presenter_speaker_type_id": "string", "name": "string", "registration_question_options": { "custom_fields": [], "registration_instructions": "string" }, "room_ids": [ "string" ], "sold_out": true, "speakers": [ {} ], "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, "track_ids": [ "string" ], "type_id": "string" }

Partially updates a session with the specified ID.

Request

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

Path
tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the session to patch.

Bodyapplication/jsonrequired

The patch directives conforming to RFC 6902.

Array [
opstring(Op)required

The operation

Enum"add""copy""move""remove""replace""test"
pathstring(Path)required

The JSON path

valuestring(Value)

The updated value

]
curl -i -X PATCH \
  'https://docs.api.rhythmsoftware.com/_mock/apis/events/events-v1/sessions/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "op": "add",
      "path": "string",
      "value": "string"
    }
  ]'

Responses

The session was patched successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
abstract_idstring(Abstract)

The abstract this session is linked to

accessstring(Access)

Who has access to this session

Enum"included""optional"
capacity_optionsobject(Capacity Options)required
capacity_options.​capacitynumber(float)(Capacity)>= 0required
capacity_options.​enable_wait_listboolean(Enable Wait List)

If set, people can be placed on a wait list

capacity_options.​waitlist_process_idWaitlist Process (string)(Waitlist Process)

The process to use for managing the waitlist

One of:

The process to use for managing the waitlist

string(Waitlist Process)

The process to use for managing the waitlist

codestring(Code)

Optional code for the event

custom_field_valuesArray of objects(Custom Field Values)
descriptionstring(Description)

A description of the session

disable_portal_registrationboolean(Disable Portal Registration)

If set, portal registration for this session is disabled

display_ordernumber(float)(Display Order)

The display/sort order for the sessions

enable_capacityboolean(Enable Capacity)

If set, the session has a capacity

enable_registration_questionsboolean(Enable Registration Questions)

If set, a user is prompted to answer questions during registration

end_datestring(date-time)(End Date)

The end date/time of the session

event_idstring(Event)required

The event

has_feesboolean(Has Fees)

Whether or not this session has fees

hide_from_portalboolean(Hide From Portal)

This session is not displayed in the portal or available for registration

hide_from_scheduleboolean(Hide From Schedule)

If selected, hide this session from the online schedule

idstring(ID)^[\w|\-:]+$required

The unique, string identifier of this session

locationstring(Location)
main_presenter_speaker_type_idstring(Main Presenter Speaker Type)

The type to be assigned to the main presenter for sessions generated from abstracts

namestring(Name)required

The name of the session

registration_question_optionsobject(Registration Question Options)required
registration_question_options.​custom_fieldsArray of objects

The custom fields to display

registration_question_options.​registration_instructionsstring(Registration Instructions)

Instructions to show during registration for the session

room_idsArray of strings(Rooms)

The room which is holding the event

sold_outboolean(Sold Out)

Whether the event is sold out

speakersArray of objects
start_datestring(date-time)(Start Date)

The start date/time of the session

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(Sys Bulk Load Pk)

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

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects
sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

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

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(Sys Has Files In S3)

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

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

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

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

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

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

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

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

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

track_idsArray of strings(Tracks)

Session tracks

type_idstring(Type)required

The type of session

Response
application/json
{ "abstract_id": "string", "access": "included", "capacity_options": { "capacity": 0.1, "enable_wait_list": true, "waitlist_process_id": null }, "code": "string", "custom_field_values": [ {} ], "description": "string", "disable_portal_registration": true, "display_order": 0.1, "enable_capacity": true, "enable_registration_questions": true, "end_date": "2019-08-24T14:15:22Z", "event_id": "string", "has_fees": true, "hide_from_portal": true, "hide_from_schedule": true, "id": "string", "location": "string", "main_presenter_speaker_type_id": "string", "name": "string", "registration_question_options": { "custom_fields": [], "registration_instructions": "string" }, "room_ids": [ "string" ], "sold_out": true, "speakers": [ {} ], "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, "track_ids": [ "string" ], "type_id": "string" }

Updates a session with the specified ID.

Request

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

Path
tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the session to update.

Bodyapplication/jsonrequired

The updated session that will be saved.

abstract_idstring(Abstract)

The abstract this session is linked to

accessstring(Access)

Who has access to this session

Enum"included""optional"
capacity_optionsobject(Capacity Options)required
capacity_options.​capacitynumber(float)(Capacity)>= 0required
capacity_options.​enable_wait_listboolean(Enable Wait List)

If set, people can be placed on a wait list

capacity_options.​waitlist_process_idWaitlist Process (string)(Waitlist Process)

The process to use for managing the waitlist

One of:

The process to use for managing the waitlist

string(Waitlist Process)

The process to use for managing the waitlist

codestring(Code)

Optional code for the event

custom_field_valuesArray of objects(Custom Field Values)
descriptionstring(Description)

A description of the session

disable_portal_registrationboolean(Disable Portal Registration)

If set, portal registration for this session is disabled

display_ordernumber(float)(Display Order)

The display/sort order for the sessions

enable_capacityboolean(Enable Capacity)

If set, the session has a capacity

enable_registration_questionsboolean(Enable Registration Questions)

If set, a user is prompted to answer questions during registration

end_datestring(date-time)(End Date)

The end date/time of the session

event_idstring(Event)required

The event

has_feesboolean(Has Fees)

Whether or not this session has fees

hide_from_portalboolean(Hide From Portal)

This session is not displayed in the portal or available for registration

hide_from_scheduleboolean(Hide From Schedule)

If selected, hide this session from the online schedule

idstring(ID)^[\w|\-:]+$required

The unique, string identifier of this session

locationstring(Location)
main_presenter_speaker_type_idstring(Main Presenter Speaker Type)

The type to be assigned to the main presenter for sessions generated from abstracts

namestring(Name)required

The name of the session

registration_question_optionsobject(Registration Question Options)required
registration_question_options.​custom_fieldsArray of objects

The custom fields to display

registration_question_options.​registration_instructionsstring(Registration Instructions)

Instructions to show during registration for the session

room_idsArray of strings(Rooms)

The room which is holding the event

sold_outboolean(Sold Out)

Whether the event is sold out

speakersArray of objects
start_datestring(date-time)(Start Date)

The start date/time of the session

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(Sys Bulk Load Pk)

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

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects
sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

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

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(Sys Has Files In S3)

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

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

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

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

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

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

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

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

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

track_idsArray of strings(Tracks)

Session tracks

type_idstring(Type)required

The type of session

curl -i -X PUT \
  'https://docs.api.rhythmsoftware.com/_mock/apis/events/events-v1/sessions/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "abstract_id": "string",
    "access": "included",
    "capacity_options": {
      "capacity": 0.1,
      "enable_wait_list": true,
      "waitlist_process_id": null
    },
    "code": "string",
    "custom_field_values": [
      {
        "boolean_value": true,
        "custom_field_id": "string",
        "file_url_value": "string",
        "list_value": [
          "string"
        ],
        "numeric_value": 0.1,
        "string_value": "string",
        "table_value": [
          {}
        ]
      }
    ],
    "description": "string",
    "disable_portal_registration": true,
    "display_order": 0.1,
    "enable_capacity": true,
    "enable_registration_questions": true,
    "end_date": "2019-08-24T14:15:22Z",
    "event_id": "string",
    "has_fees": true,
    "hide_from_portal": true,
    "hide_from_schedule": true,
    "id": "string",
    "location": "string",
    "main_presenter_speaker_type_id": "string",
    "name": "string",
    "registration_question_options": {
      "custom_fields": [
        {
          "id": "string",
          "label": "string",
          "required": true
        }
      ],
      "registration_instructions": "string"
    },
    "room_ids": [
      "string"
    ],
    "sold_out": true,
    "speakers": [
      {
        "speaker_id": "string",
        "speaker_type_id": "string"
      }
    ],
    "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,
    "track_ids": [
      "string"
    ],
    "type_id": "string"
  }'

Responses

The session was updated successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
abstract_idstring(Abstract)

The abstract this session is linked to

accessstring(Access)

Who has access to this session

Enum"included""optional"
capacity_optionsobject(Capacity Options)required
capacity_options.​capacitynumber(float)(Capacity)>= 0required
capacity_options.​enable_wait_listboolean(Enable Wait List)

If set, people can be placed on a wait list

capacity_options.​waitlist_process_idWaitlist Process (string)(Waitlist Process)

The process to use for managing the waitlist

One of:

The process to use for managing the waitlist

string(Waitlist Process)

The process to use for managing the waitlist

codestring(Code)

Optional code for the event

custom_field_valuesArray of objects(Custom Field Values)
descriptionstring(Description)

A description of the session

disable_portal_registrationboolean(Disable Portal Registration)

If set, portal registration for this session is disabled

display_ordernumber(float)(Display Order)

The display/sort order for the sessions

enable_capacityboolean(Enable Capacity)

If set, the session has a capacity

enable_registration_questionsboolean(Enable Registration Questions)

If set, a user is prompted to answer questions during registration

end_datestring(date-time)(End Date)

The end date/time of the session

event_idstring(Event)required

The event

has_feesboolean(Has Fees)

Whether or not this session has fees

hide_from_portalboolean(Hide From Portal)

This session is not displayed in the portal or available for registration

hide_from_scheduleboolean(Hide From Schedule)

If selected, hide this session from the online schedule

idstring(ID)^[\w|\-:]+$required

The unique, string identifier of this session

locationstring(Location)
main_presenter_speaker_type_idstring(Main Presenter Speaker Type)

The type to be assigned to the main presenter for sessions generated from abstracts

namestring(Name)required

The name of the session

registration_question_optionsobject(Registration Question Options)required
registration_question_options.​custom_fieldsArray of objects

The custom fields to display

registration_question_options.​registration_instructionsstring(Registration Instructions)

Instructions to show during registration for the session

room_idsArray of strings(Rooms)

The room which is holding the event

sold_outboolean(Sold Out)

Whether the event is sold out

speakersArray of objects
start_datestring(date-time)(Start Date)

The start date/time of the session

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(Sys Bulk Load Pk)

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

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects
sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

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

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(Sys Has Files In S3)

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

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

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

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

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

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

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

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

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

track_idsArray of strings(Tracks)

Session tracks

type_idstring(Type)required

The type of session

Response
application/json
{ "abstract_id": "string", "access": "included", "capacity_options": { "capacity": 0.1, "enable_wait_list": true, "waitlist_process_id": null }, "code": "string", "custom_field_values": [ {} ], "description": "string", "disable_portal_registration": true, "display_order": 0.1, "enable_capacity": true, "enable_registration_questions": true, "end_date": "2019-08-24T14:15:22Z", "event_id": "string", "has_fees": true, "hide_from_portal": true, "hide_from_schedule": true, "id": "string", "location": "string", "main_presenter_speaker_type_id": "string", "name": "string", "registration_question_options": { "custom_fields": [], "registration_instructions": "string" }, "room_ids": [ "string" ], "sold_out": true, "speakers": [ {} ], "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, "track_ids": [ "string" ], "type_id": "string" }

Settings

Settings

Operations

Show Floors

Show Floors

Operations

Speaker Profiles

Speaker Profiles

Operations

Speaker Topics

Speaker Topics

Operations

Speaker Types

Speaker Types

Operations

Speakers

Speakers

Operations

Sponsors

Sponsors

Operations

Statistics

Statistics

Operations

Types

Types

Operations

Venues

Venues

Operations

Waitlist Processes

Waitlist Processes

Operations

Waitlisted Contacts

Waitlisted Contacts

Operations