Speaker Profiles

Speaker Profiles

Creates a new speaker profile record that does not already exist.

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

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed.

Request Body schema: application/json

The speaker profile that you would like to be saved.

id
required
string (ID) /^[\w|-]+$/

The unique, string identifier of this speaker profile

bio
string (Bio)

The biography for this speaker profile

first_name
string (First Name)

The member's first name

last_name
string (Last Name)

The member's last name

name
required
string (Name)

The member's name

email_address
string (Email Address)

The member's email address

city
string (City)

The member city

state
string (State)

The state

country
string (Country)

The member country

job_title
string (Job Title)

The member job title

photo_uri
string (Photo Uri)

Upload string for path for photo for the profile

photo_approved
boolean (Photo Approved)

Whether or not the photo is approved

topic_ids
Array of strings (Topics)

Array of accreditation topic ids

speakers_bureau
string (Speakers Bureau)

The bureau for this speaker

object (Contact Person)
url
string (Url)

The url for this speaker

honorarium
number <float> (Honorarium)

The honorarium for this speaker

dietary_restrictions
string (Dietary Restrictions)

Special dietary restrictions

preferred_name
string (Preferred Name)

The referred spelling of this persons name

notes
string (Notes)

Any relevant notes

is_active
boolean (Is Active)

Whether or not this speaker profile is active

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 speaker profile was saved successfully.
400The speaker profile you supplied was invalid.
401Unauthorized.
403Forbidden.
404The resource could not be found
409The speaker profile could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to add speaker profile based on tenant limits.
500General server error.
post/speakerProfiles/{tenantId}
Request samples
application/json
{
  • "id": "string",
  • "bio": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "name": "string",
  • "email_address": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "job_title": "string",
  • "photo_uri": "string",
  • "photo_approved": true,
  • "topic_ids": [
    ],
  • "speakers_bureau": "string",
  • "contact_person": {
    },
  • "url": "string",
  • "honorarium": 0,
  • "dietary_restrictions": "string",
  • "preferred_name": "string",
  • "notes": "string",
  • "is_active": true,
  • "custom_field_values": [
    ],
  • "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": [
    ]
}
Response samples
application/json
{
  • "id": "string",
  • "bio": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "name": "string",
  • "email_address": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "job_title": "string",
  • "photo_uri": "string",
  • "photo_approved": true,
  • "topic_ids": [
    ],
  • "speakers_bureau": "string",
  • "contact_person": {
    },
  • "url": "string",
  • "honorarium": 0,
  • "dietary_restrictions": "string",
  • "preferred_name": "string",
  • "notes": "string",
  • "is_active": true,
  • "custom_field_values": [
    ],
  • "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": [
    ]
}

Returns a speaker profile from the system by its ID.

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

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the speaker profile 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 speaker profile was retrieved successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The speaker profile could not be found.
429Limit exceeded... unable to retrieve speaker profile based on tenant limits.
500General server error.
get/speakerProfiles/{tenantId}/{id}
Request samples
curl -i -X GET \
  'https://events.api.756794052567.rhythmsoftware.com/speakerProfiles/:tenantId/:id?fields=string&consistentRead=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "string",
  • "bio": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "name": "string",
  • "email_address": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "job_title": "string",
  • "photo_uri": "string",
  • "photo_approved": true,
  • "topic_ids": [
    ],
  • "speakers_bureau": "string",
  • "contact_person": {
    },
  • "url": "string",
  • "honorarium": 0,
  • "dietary_restrictions": "string",
  • "preferred_name": "string",
  • "notes": "string",
  • "is_active": true,
  • "custom_field_values": [
    ],
  • "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": [
    ]
}

Updates a speaker profile with the specified ID.

This method will update an existing speaker profile with the specified ID.

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the speaker profile to update.

Request Body schema: application/json

The updated speaker profile that will be saved.

id
required
string (ID) /^[\w|-]+$/

The unique, string identifier of this speaker profile

bio
string (Bio)

The biography for this speaker profile

first_name
string (First Name)

The member's first name

last_name
string (Last Name)

The member's last name

name
required
string (Name)

The member's name

email_address
string (Email Address)

The member's email address

city
string (City)

The member city

state
string (State)

The state

country
string (Country)

The member country

job_title
string (Job Title)

The member job title

photo_uri
string (Photo Uri)

Upload string for path for photo for the profile

photo_approved
boolean (Photo Approved)

Whether or not the photo is approved

topic_ids
Array of strings (Topics)

Array of accreditation topic ids

speakers_bureau
string (Speakers Bureau)

The bureau for this speaker

object (Contact Person)
url
string (Url)

The url for this speaker

honorarium
number <float> (Honorarium)

The honorarium for this speaker

dietary_restrictions
string (Dietary Restrictions)

Special dietary restrictions

preferred_name
string (Preferred Name)

The referred spelling of this persons name

notes
string (Notes)

Any relevant notes

is_active
boolean (Is Active)

Whether or not this speaker profile is active

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 speaker profile was updated successfully.
400The speaker profile supplied was not valid.
401Unauthorized.
403Forbidden.
404The speaker profile could not be found.
409The speaker profile could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve speaker profile based on tenant limits.
500General server error.
put/speakerProfiles/{tenantId}/{id}
Request samples
application/json
{
  • "id": "string",
  • "bio": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "name": "string",
  • "email_address": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "job_title": "string",
  • "photo_uri": "string",
  • "photo_approved": true,
  • "topic_ids": [
    ],
  • "speakers_bureau": "string",
  • "contact_person": {
    },
  • "url": "string",
  • "honorarium": 0,
  • "dietary_restrictions": "string",
  • "preferred_name": "string",
  • "notes": "string",
  • "is_active": true,
  • "custom_field_values": [
    ],
  • "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": [
    ]
}
Response samples
application/json
{
  • "id": "string",
  • "bio": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "name": "string",
  • "email_address": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "job_title": "string",
  • "photo_uri": "string",
  • "photo_approved": true,
  • "topic_ids": [
    ],
  • "speakers_bureau": "string",
  • "contact_person": {
    },
  • "url": "string",
  • "honorarium": 0,
  • "dietary_restrictions": "string",
  • "preferred_name": "string",
  • "notes": "string",
  • "is_active": true,
  • "custom_field_values": [
    ],
  • "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": [
    ]
}

Partially updates a speaker profile with the specified ID.

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

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the speaker profile 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 speaker profile was patched successfully.
400The JSON patch directive you supplied was not valid.
401Unauthorized.
403Forbidden.
404The speaker profile could not be found.
409The speaker profile could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve speaker profile based on tenant limits.
500General server error.
patch/speakerProfiles/{tenantId}/{id}
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "string",
  • "bio": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "name": "string",
  • "email_address": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "job_title": "string",
  • "photo_uri": "string",
  • "photo_approved": true,
  • "topic_ids": [
    ],
  • "speakers_bureau": "string",
  • "contact_person": {
    },
  • "url": "string",
  • "honorarium": 0,
  • "dietary_restrictions": "string",
  • "preferred_name": "string",
  • "notes": "string",
  • "is_active": true,
  • "custom_field_values": [
    ],
  • "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": [
    ]
}

Returns a speaker profile from the system by its ID.

This method will delete a speaker profile with the specified ID.

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the speaker profile to delete.

Responses
200The speaker profile was deleted successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The speaker profile could not be found.
409The speaker profile could not be deleted because other objects refers to/depends on this one.
429Limit exceeded... unable to delete speaker profile based on tenant limits.
500General server error.
delete/speakerProfiles/{tenantId}/{id}
Request samples
curl -i -X DELETE \
  https://events.api.756794052567.rhythmsoftware.com/speakerProfiles/:tenantId/:id \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
"string"

Searches for speaker profiles using predefined parameters

Searches for speaker profiles using predefined parameters

Request
Security:
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 speaker profile that you would like to be saved.

ids
Array of strings (Ids)

IDs to search

topic_ids
Array of strings (Topics)
contact_person_name
string (Contact Person Name)
is_active
boolean (Is Active)
Responses
200The speaker profile search was saved successfully.
400The speaker profile you supplied was invalid.
401Unauthorized.
403Forbidden.
404The resource could not be found
409The speaker profile could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to add speaker profile based on tenant limits.
500General server error.
post/speakerProfiles/{tenantId}/search
Request samples
application/json
{
  • "ids": [
    ],
  • "topic_ids": [
    ],
  • "contact_person_name": "string",
  • "is_active": true
}
Response samples
application/json
{
  • "Items": [
    ],
  • "LastEvaluatedKey": "string"
}

Execute Batch Operations

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

Request
Security:
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 speaker profile could not be found.
429Limit exceeded... unable to retrieve speaker profile based on tenant limits.
500General server error.
post/speakerProfiles/{tenantId}/batch
Request samples
application/json
{
  • "operations": [
    ]
}
Response samples
application/json
{
  • "success_count": 0,
  • "error_count": 0,
  • "results": [
    ]
}