The Contacts & Organizations, or Rolodex, app provides the Customer Relationship Management (CRM) capabilities of the Rhythm platform. Common integrations with the Rolodex API include finding or updating contact information, demographics, or communication preferences for a Contact or Organization.
Like most of the other Rhythm apps, the Rolodex 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.
https://docs.api.rhythmsoftware.com/_mock/apis/rolodex/rolodex-v1/
https://rolodex.api.rhythmsoftware.com/
The contact that you would like to be saved.
The date that the communication preferences were last confirmed for this contact
The ids of the contact roles this contact plays in the linked organization.
The date of birth of the contact, expressed in ISO-8601 date format
The date that this contact profile was last updated
The date that the social profile was last updated
When set, a change in the organization's address changes the contact work address
When set, a change in the organization's phone changes the contact work phone
The Open Civic Data division identifier of the United States congressional district
The name of the organization; if an organization ID is present, this information is automatically populated
If this contact was created by another service, the service is here
If this contact was created by another service, the relevant iD
If true, the region assignment for this record is overridden and should not be automatically assigned
Allows for this contact to be managed by other contacts in the portal
The address at which the contact prefers to be contacted
When a alternate phone number type is preferred, the ID
The preferred phone number, calculated based on the preferred phone number type
The phone number at which the contact prefers to be reach
When a alternate phone number type is preferred, the ID
The start date for the seasonal address
The Open Civic Data division identifier of the US state lower (House) district
The Open Civic Data division identifier of the US state upper (Senate) district
If this record was loaded via bulk, the timestamp when the record was processed
If this record was loaded via bulk, the ID of the bulk load process
If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
If this record was loaded via bulk, the record number in the source file
If this record was loaded via bulk, the source file
The error associated with the calculated field
If a snapshot was restored/applies to this record, the ID of the snapshot
The date/time that this record was created, expressed in ISO-8601 date format
The ID of the user that deleted (or last tried to delete) this object
Means for passing directive information into an object processing logic
If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
If this record was last touched by a bulk data operation, the ID of that operation
If this record was last touched by a bulk data operation, the sys_version at the time of that operation
The date/time that this record record was last modified, expressed in ISO-8601 date format
The ID of the user that last modified this record
The security context of the last insert, modify, or delete performed on this item
The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
A number representing the version of this record in the database
https://docs.api.rhythmsoftware.com/_mock/apis/rolodex/rolodex-v1/contacts/{tenantId}
https://rolodex.api.rhythmsoftware.com/contacts/{tenantId}
curl -i -X POST \
'https://docs.api.rhythmsoftware.com/_mock/apis/rolodex/rolodex-v1/contacts/{tenantId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"communication_preferences": [
{
"communication_type_id": "string",
"enabled": true,
"subscription_email_address": "string",
"subscription_last_updated": "2019-08-24T14:15:22Z",
"subscription_status": "digest"
}
],
"communication_preferences_last_confirmed": "2019-08-24T14:15:22Z",
"contact_role_ids": [
"string"
],
"contact_roles": "string",
"credentials": "string",
"custom_field_values": [
{
"boolean_value": true,
"custom_field_id": "string",
"file_url_value": "string",
"list_value": [
"string"
],
"numeric_value": 0.1,
"string_value": "string",
"table_value": [
{}
]
}
],
"date_of_birth": "2019-08-24",
"date_of_death": "2019-08-24T14:15:22Z",
"date_profile_last_updated": "2019-08-24T14:15:22Z",
"date_social_profile_last_updated": "2019-08-24",
"do_not_call": true,
"do_not_mail": true,
"email_address": "string",
"email_address2": "string",
"email_address3": "string",
"email_opt_out": true,
"facebook": "string",
"fax_phone_number": "string",
"first_name": "string",
"full_name": "string",
"gender": "female",
"home_address": {
"city": "string",
"country": "string",
"country_name": "string",
"county": "string",
"latitude": 0.1,
"line1": "string",
"line2": "string",
"line3": "string",
"longitude": 0.1,
"postal_code": "string",
"state": "string",
"time_zone_id": "string"
},
"home_phone_number": "string",
"id": "string",
"image_url": "string",
"instagram": "string",
"job_title": "string",
"last_name": "string",
"link_work_address_to_organization": true,
"link_work_phone_number_to_organization": true,
"linked_in": "string",
"maiden_name": "string",
"merged_ids": [
"string"
],
"middle_name": "string",
"mobile_phone_number": "string",
"name": "string",
"name_last_first": "string",
"national_district": "string",
"national_district_ocdId": "string",
"new_organization_info": {},
"nickname": "string",
"notes": "string",
"number": 0.1,
"organization_history": [
{
"contact_role_ids": [
"string"
],
"end_date": "2019-08-24",
"job_title": "string",
"notes": "string",
"organization_id": "string",
"start_date": "2019-08-24"
}
],
"organization_id": "string",
"organization_name": "string",
"origin_service": "string",
"origin_service_record_id": "string",
"other_addresses": [
{
"address": {
"city": "string",
"country": "string",
"country_name": "string",
"county": "string",
"latitude": 0.1,
"line1": "string",
"line2": "string",
"line3": "string",
"longitude": 0.1,
"postal_code": "string",
"state": "string",
"time_zone_id": "string"
},
"type_id": "string"
}
],
"other_phone_numbers": [
{
"phone_number": "string",
"type_id": "string"
}
],
"override_automatic_region_assignment": true,
"portal_delegates": [
{
"contact_id": "string",
"expiration_date": "2019-08-24T14:15:22Z",
"status": "approved"
}
],
"preferred_address": {
"city": "string",
"country": "string",
"country_name": "string",
"county": "string",
"latitude": 0.1,
"line1": "string",
"line2": "string",
"line3": "string",
"longitude": 0.1,
"postal_code": "string",
"state": "string",
"time_zone_id": "string"
},
"preferred_address_type": "alternate",
"preferred_address_type_id": "string",
"preferred_phone_number": "string",
"preferred_phone_number_type": "alternate",
"preferred_phone_number_type_id": "string",
"prefix": "string",
"pronouns": "string",
"region_id": "string",
"salutation": "string",
"school_address": {
"city": "string",
"country": "string",
"country_name": "string",
"county": "string",
"latitude": 0.1,
"line1": "string",
"line2": "string",
"line3": "string",
"longitude": 0.1,
"postal_code": "string",
"state": "string",
"time_zone_id": "string"
},
"school_phone_number": "string",
"seasonal_address": {
"city": "string",
"country": "string",
"country_name": "string",
"county": "string",
"latitude": 0.1,
"line1": "string",
"line2": "string",
"line3": "string",
"longitude": 0.1,
"postal_code": "string",
"state": "string",
"time_zone_id": "string"
},
"seasonal_address_end": "2019-08-24T14:15:22Z",
"seasonal_address_start": "2019-08-24T14:15:22Z",
"spouse_id": "string",
"state_lower_district": "string",
"state_lower_district_ocdId": "string",
"state_upper_district": "string",
"state_upper_district_ocdId": "string",
"status": "active",
"suffix": "string",
"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,
"twitter": "string",
"user_ids": [
"string"
],
"work_address": {
"city": "string",
"country": "string",
"country_name": "string",
"county": "string",
"latitude": 0.1,
"line1": "string",
"line2": "string",
"line3": "string",
"longitude": 0.1,
"postal_code": "string",
"state": "string",
"time_zone_id": "string"
},
"work_mobile_phone_number": "string",
"work_phone_number": "string"
}'The contact was saved successfully.
The date that the communication preferences were last confirmed for this contact
The ids of the contact roles this contact plays in the linked organization.
The date of birth of the contact, expressed in ISO-8601 date format
The date that this contact profile was last updated
The date that the social profile was last updated
When set, a change in the organization's address changes the contact work address
When set, a change in the organization's phone changes the contact work phone
The Open Civic Data division identifier of the United States congressional district
The name of the organization; if an organization ID is present, this information is automatically populated
If this contact was created by another service, the service is here
If this contact was created by another service, the relevant iD
If true, the region assignment for this record is overridden and should not be automatically assigned
Allows for this contact to be managed by other contacts in the portal
The address at which the contact prefers to be contacted
When a alternate phone number type is preferred, the ID
The preferred phone number, calculated based on the preferred phone number type
The phone number at which the contact prefers to be reach
When a alternate phone number type is preferred, the ID
The start date for the seasonal address
The Open Civic Data division identifier of the US state lower (House) district
The Open Civic Data division identifier of the US state upper (Senate) district
If this record was loaded via bulk, the timestamp when the record was processed
If this record was loaded via bulk, the ID of the bulk load process
If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
If this record was loaded via bulk, the record number in the source file
If this record was loaded via bulk, the source file
The error associated with the calculated field
If a snapshot was restored/applies to this record, the ID of the snapshot
The date/time that this record was created, expressed in ISO-8601 date format
The ID of the user that deleted (or last tried to delete) this object
Means for passing directive information into an object processing logic
If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
If this record was last touched by a bulk data operation, the ID of that operation
If this record was last touched by a bulk data operation, the sys_version at the time of that operation
The date/time that this record record was last modified, expressed in ISO-8601 date format
The ID of the user that last modified this record
The security context of the last insert, modify, or delete performed on this item
The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
A number representing the version of this record in the database
{ "communication_preferences": [ { … } ], "communication_preferences_last_confirmed": "2019-08-24T14:15:22Z", "contact_role_ids": [ "string" ], "contact_roles": "string", "credentials": "string", "custom_field_values": [ { … } ], "date_of_birth": "2019-08-24", "date_of_death": "2019-08-24T14:15:22Z", "date_profile_last_updated": "2019-08-24T14:15:22Z", "date_social_profile_last_updated": "2019-08-24", "do_not_call": true, "do_not_mail": true, "email_address": "string", "email_address2": "string", "email_address3": "string", "email_opt_out": true, "facebook": "string", "fax_phone_number": "string", "first_name": "string", "full_name": "string", "gender": "female", "home_address": { "city": "string", "country": "string", "country_name": "string", "county": "string", "latitude": 0.1, "line1": "string", "line2": "string", "line3": "string", "longitude": 0.1, "postal_code": "string", "state": "string", "time_zone_id": "string" }, "home_phone_number": "string", "id": "string", "image_url": "string", "instagram": "string", "job_title": "string", "last_name": "string", "link_work_address_to_organization": true, "link_work_phone_number_to_organization": true, "linked_in": "string", "maiden_name": "string", "merged_ids": [ "string" ], "middle_name": "string", "mobile_phone_number": "string", "name": "string", "name_last_first": "string", "national_district": "string", "national_district_ocdId": "string", "new_organization_info": {}, "nickname": "string", "notes": "string", "number": 0.1, "organization_history": [ { … } ], "organization_id": "string", "organization_name": "string", "origin_service": "string", "origin_service_record_id": "string", "other_addresses": [ { … } ], "other_phone_numbers": [ { … } ], "override_automatic_region_assignment": true, "portal_delegates": [ { … } ], "preferred_address": { "city": "string", "country": "string", "country_name": "string", "county": "string", "latitude": 0.1, "line1": "string", "line2": "string", "line3": "string", "longitude": 0.1, "postal_code": "string", "state": "string", "time_zone_id": "string" }, "preferred_address_type": "alternate", "preferred_address_type_id": "string", "preferred_phone_number": "string", "preferred_phone_number_type": "alternate", "preferred_phone_number_type_id": "string", "prefix": "string", "pronouns": "string", "region_id": "string", "salutation": "string", "school_address": { "city": "string", "country": "string", "country_name": "string", "county": "string", "latitude": 0.1, "line1": "string", "line2": "string", "line3": "string", "longitude": 0.1, "postal_code": "string", "state": "string", "time_zone_id": "string" }, "school_phone_number": "string", "seasonal_address": { "city": "string", "country": "string", "country_name": "string", "county": "string", "latitude": 0.1, "line1": "string", "line2": "string", "line3": "string", "longitude": 0.1, "postal_code": "string", "state": "string", "time_zone_id": "string" }, "seasonal_address_end": "2019-08-24T14:15:22Z", "seasonal_address_start": "2019-08-24T14:15:22Z", "spouse_id": "string", "state_lower_district": "string", "state_lower_district_ocdId": "string", "state_upper_district": "string", "state_upper_district_ocdId": "string", "status": "active", "suffix": "string", "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, "twitter": "string", "user_ids": [ "string" ], "work_address": { "city": "string", "country": "string", "country_name": "string", "county": "string", "latitude": 0.1, "line1": "string", "line2": "string", "line3": "string", "longitude": 0.1, "postal_code": "string", "state": "string", "time_zone_id": "string" }, "work_mobile_phone_number": "string", "work_phone_number": "string" }
https://docs.api.rhythmsoftware.com/_mock/apis/rolodex/rolodex-v1/contacts/{tenantId}/batch
https://rolodex.api.rhythmsoftware.com/contacts/{tenantId}/batch
curl -i -X POST \
'https://docs.api.rhythmsoftware.com/_mock/apis/rolodex/rolodex-v1/contacts/{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"
}
}
}
]
}'{ "error_count": 0.1, "results": [ { … } ], "success_count": 0.1 }
https://docs.api.rhythmsoftware.com/_mock/apis/rolodex/rolodex-v1/contacts/{tenantId}/checkManageability/{managerId}
https://rolodex.api.rhythmsoftware.com/contacts/{tenantId}/checkManageability/{managerId}
curl -i -X GET \
'https://docs.api.rhythmsoftware.com/_mock/apis/rolodex/rolodex-v1/contacts/{tenantId}/checkManageability/{managerId}?emailAddress=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'{ "avatar": "string", "bio": "string", "details": {}, "emailAddress": "string", "facebook": "string", "fullName": "string", "gender": "female", "linkedin": "string", "organization": "string", "title": "string", "twitter": "string" }