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/
https://docs.api.rhythmsoftware.com/_mock/apis/rolodex/rolodex-v1/settings/{tenantId}
https://rolodex.api.rhythmsoftware.com/settings/{tenantId}
curl -i -X DELETE \
'https://docs.api.rhythmsoftware.com/_mock/apis/rolodex/rolodex-v1/settings/{tenantId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'"string"
https://docs.api.rhythmsoftware.com/_mock/apis/rolodex/rolodex-v1/settings/{tenantId}
https://rolodex.api.rhythmsoftware.com/settings/{tenantId}
curl -i -X GET \
'https://docs.api.rhythmsoftware.com/_mock/apis/rolodex/rolodex-v1/settings/{tenantId}?consistentRead=string&fields=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'The setting was retrieved successfully.
RB-3239 - when querying organizations, you can show contacts by role. Besides name/email/phone, you can also have additional fields added. A limit is imposed so that query descriptions do not blow up.
Who should have their regions assigned automatically
If set, contacts can create child organizations in the portal
If set, contacts can delete child organizations in the portal
If set, contacts can edit child organizations in the portal
Label for describing child organizations in the portal (plural)
Label for describing child organization in the portal
The default form for creating a contact in the console
The default form for creating an organization in the console
The default form for editing a contact in the console
The default form for editing an organization in the console
The scoring model for contacts
The contact roles that are allowed to manage this scholarship
If set, the sign up contact sign up/linking process will not create an organization
If set, contacts will not be allowed to be created/updated with a duplicate email address
If set, contacts & organizations are assigned to a region
If true, contacts can manage child organizations in the portal
Whether or not engagement scoring is enabled
If set, committee-related fields for certain committees will be included in all contact queries
If set, course-related fields for certain courses will be included in all contact queries
If set, event-related fields for certain events will be included in all contact queries
If set, the route that new contacts should be taken to after contact creation
The scoring model for organizations
The form used in the portal when an administrator adds an organization contact
The form used in the portal when an administrator edits an organization contact
The form for new users
Update profile portal form
Update profile portal form
If set, contacts cannot change their credentials in the portal
If set, contacts cannot change their name in the portal
If set, contacts cannot change their organization's name in the portal
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
{ "additional_contact_fields_to_show_in_organization_queries": [ { … } ], "automatic_region_assignment_options": { "automatically_assign": "both", "contact_address_type": "home", "contact_other_address_type_id": null, "rules": { … } }, "child_organization_portal_settings": { "allow_creation_of_new_child_organization": true, "allow_deleting_of_child_organization": true, "allow_editing_of_child_organization": true, "child_organization_label_plural": "string", "child_organization_label_singular": "string", "create_organization_form_id": null, "edit_organization_form_id": null }, "committees_to_include_in_contact_queries": [ { … } ], "console_create_contact_form_id": "string", "console_create_organization_form_id": "string", "console_edit_contact_form_id": "string", "console_edit_organization_form_id": "string", "contact_engagement_scoring_model_id": "string", "contact_role_permissions": [ { … } ], "contacts": { "default_360_screen": "string", "default_console_forms": { … }, "default_portal_forms": { … } }, "courses_to_include_in_contact_queries": [ { … } ], "disable_organization_creation_during_sign_up": true, "duplicate_prevention": "both", "enable_automatic_region_assignment": true, "enable_child_organization_management_in_portal": true, "enable_engagement_scoring": true, "events_to_include_in_contact_queries": [ { … } ], "include_committee_fields_in_contact_queries": true, "include_course_fields_in_contact_queries": true, "include_event_fields_in_contact_queries": true, "new_contact_redirect_route": "string", "notes": "string", "organization_engagement_scoring_model_id": "string", "organizations": { "default_360_screen": "string", "default_console_forms": { … }, "default_portal_forms": { … } }, "portal_create_organization_contact_form_id": "string", "portal_edit_organization_contact_form_id": "string", "portal_new_user_profile_form_id": "string", "portal_update_organization_info_form_id": "string", "portal_update_profile_form_id": "string", "restrict_contact_credentials_changes": true, "restrict_contact_name_changes": true, "restrict_organization_name_changes": 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": [ { … } ], "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 }
https://docs.api.rhythmsoftware.com/_mock/apis/rolodex/rolodex-v1/settings/{tenantId}
https://rolodex.api.rhythmsoftware.com/settings/{tenantId}
curl -i -X PATCH \
'https://docs.api.rhythmsoftware.com/_mock/apis/rolodex/rolodex-v1/settings/{tenantId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '[
{
"op": "add",
"path": "string",
"value": "string"
}
]'The setting was patched successfully.
RB-3239 - when querying organizations, you can show contacts by role. Besides name/email/phone, you can also have additional fields added. A limit is imposed so that query descriptions do not blow up.
Who should have their regions assigned automatically
If set, contacts can create child organizations in the portal
If set, contacts can delete child organizations in the portal
If set, contacts can edit child organizations in the portal
Label for describing child organizations in the portal (plural)
Label for describing child organization in the portal
The default form for creating a contact in the console
The default form for creating an organization in the console
The default form for editing a contact in the console
The default form for editing an organization in the console
The scoring model for contacts
The contact roles that are allowed to manage this scholarship
If set, the sign up contact sign up/linking process will not create an organization
If set, contacts will not be allowed to be created/updated with a duplicate email address
If set, contacts & organizations are assigned to a region
If true, contacts can manage child organizations in the portal
Whether or not engagement scoring is enabled
If set, committee-related fields for certain committees will be included in all contact queries
If set, course-related fields for certain courses will be included in all contact queries
If set, event-related fields for certain events will be included in all contact queries
If set, the route that new contacts should be taken to after contact creation
The scoring model for organizations
The form used in the portal when an administrator adds an organization contact
The form used in the portal when an administrator edits an organization contact
The form for new users
Update profile portal form
Update profile portal form
If set, contacts cannot change their credentials in the portal
If set, contacts cannot change their name in the portal
If set, contacts cannot change their organization's name in the portal
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
{ "additional_contact_fields_to_show_in_organization_queries": [ { … } ], "automatic_region_assignment_options": { "automatically_assign": "both", "contact_address_type": "home", "contact_other_address_type_id": null, "rules": { … } }, "child_organization_portal_settings": { "allow_creation_of_new_child_organization": true, "allow_deleting_of_child_organization": true, "allow_editing_of_child_organization": true, "child_organization_label_plural": "string", "child_organization_label_singular": "string", "create_organization_form_id": null, "edit_organization_form_id": null }, "committees_to_include_in_contact_queries": [ { … } ], "console_create_contact_form_id": "string", "console_create_organization_form_id": "string", "console_edit_contact_form_id": "string", "console_edit_organization_form_id": "string", "contact_engagement_scoring_model_id": "string", "contact_role_permissions": [ { … } ], "contacts": { "default_360_screen": "string", "default_console_forms": { … }, "default_portal_forms": { … } }, "courses_to_include_in_contact_queries": [ { … } ], "disable_organization_creation_during_sign_up": true, "duplicate_prevention": "both", "enable_automatic_region_assignment": true, "enable_child_organization_management_in_portal": true, "enable_engagement_scoring": true, "events_to_include_in_contact_queries": [ { … } ], "include_committee_fields_in_contact_queries": true, "include_course_fields_in_contact_queries": true, "include_event_fields_in_contact_queries": true, "new_contact_redirect_route": "string", "notes": "string", "organization_engagement_scoring_model_id": "string", "organizations": { "default_360_screen": "string", "default_console_forms": { … }, "default_portal_forms": { … } }, "portal_create_organization_contact_form_id": "string", "portal_edit_organization_contact_form_id": "string", "portal_new_user_profile_form_id": "string", "portal_update_organization_info_form_id": "string", "portal_update_profile_form_id": "string", "restrict_contact_credentials_changes": true, "restrict_contact_name_changes": true, "restrict_organization_name_changes": 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": [ { … } ], "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 }
The setting that you would like to be saved.
RB-3239 - when querying organizations, you can show contacts by role. Besides name/email/phone, you can also have additional fields added. A limit is imposed so that query descriptions do not blow up.
Who should have their regions assigned automatically
If set, contacts can create child organizations in the portal
If set, contacts can delete child organizations in the portal
If set, contacts can edit child organizations in the portal
Label for describing child organizations in the portal (plural)
Label for describing child organization in the portal
The default form for creating a contact in the console
The default form for creating an organization in the console
The default form for editing a contact in the console
The default form for editing an organization in the console
The scoring model for contacts
The contact roles that are allowed to manage this scholarship
If set, the sign up contact sign up/linking process will not create an organization
If set, contacts will not be allowed to be created/updated with a duplicate email address
If set, contacts & organizations are assigned to a region
If true, contacts can manage child organizations in the portal
Whether or not engagement scoring is enabled
If set, committee-related fields for certain committees will be included in all contact queries
If set, course-related fields for certain courses will be included in all contact queries
If set, event-related fields for certain events will be included in all contact queries
If set, the route that new contacts should be taken to after contact creation
The scoring model for organizations
The form used in the portal when an administrator adds an organization contact
The form used in the portal when an administrator edits an organization contact
The form for new users
Update profile portal form
Update profile portal form
If set, contacts cannot change their credentials in the portal
If set, contacts cannot change their name in the portal
If set, contacts cannot change their organization's name in the portal
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
https://docs.api.rhythmsoftware.com/_mock/apis/rolodex/rolodex-v1/settings/{tenantId}
https://rolodex.api.rhythmsoftware.com/settings/{tenantId}
curl -i -X POST \
'https://docs.api.rhythmsoftware.com/_mock/apis/rolodex/rolodex-v1/settings/{tenantId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"additional_contact_fields_to_show_in_organization_queries": [
{
"label": "string",
"name": "string"
}
],
"automatic_region_assignment_options": {
"automatically_assign": "both",
"contact_address_type": "home",
"contact_other_address_type_id": null,
"rules": {
"0": {
"countries": {
"0": {
"country": "string"
}
},
"postal_code_ranges": {
"0": {
"end": "string",
"start": "string"
}
},
"region_id": "string",
"states": {
"0": {
"state": "string"
}
},
"type": "country"
}
}
},
"child_organization_portal_settings": {
"allow_creation_of_new_child_organization": true,
"allow_deleting_of_child_organization": true,
"allow_editing_of_child_organization": true,
"child_organization_label_plural": "string",
"child_organization_label_singular": "string",
"create_organization_form_id": null,
"edit_organization_form_id": null
},
"committees_to_include_in_contact_queries": [
{
"additional_fields": [
"string"
],
"committee_id": "string"
}
],
"console_create_contact_form_id": "string",
"console_create_organization_form_id": "string",
"console_edit_contact_form_id": "string",
"console_edit_organization_form_id": "string",
"contact_engagement_scoring_model_id": "string",
"contact_role_permissions": [
{
"create_child_organizations": true,
"create_contacts": true,
"delete_child_organizations": true,
"edit_child_organizations": true,
"edit_contacts": true,
"manage_child_organizations": true,
"remove_contacts": true,
"role_id": "string",
"update_organization_info": true,
"view_contacts": true
}
],
"contacts": {
"default_360_screen": "string",
"default_console_forms": {
"creation": "string",
"editing": "string"
},
"default_portal_forms": {
"add_organization_contact": "string",
"new_user": "string",
"update_organization_contact": "string",
"update_profile": "string"
}
},
"courses_to_include_in_contact_queries": [
{
"additional_fields": [
"string"
],
"course_id": "string"
}
],
"disable_organization_creation_during_sign_up": true,
"duplicate_prevention": "both",
"enable_automatic_region_assignment": true,
"enable_child_organization_management_in_portal": true,
"enable_engagement_scoring": true,
"events_to_include_in_contact_queries": [
{
"additional_fields": [
"string"
],
"event_id": "string"
}
],
"include_committee_fields_in_contact_queries": true,
"include_course_fields_in_contact_queries": true,
"include_event_fields_in_contact_queries": true,
"new_contact_redirect_route": "string",
"notes": "string",
"organization_engagement_scoring_model_id": "string",
"organizations": {
"default_360_screen": "string",
"default_console_forms": {
"creation": "string",
"editing": "string"
},
"default_portal_forms": {
"editing": "string"
}
},
"portal_create_organization_contact_form_id": "string",
"portal_edit_organization_contact_form_id": "string",
"portal_new_user_profile_form_id": "string",
"portal_update_organization_info_form_id": "string",
"portal_update_profile_form_id": "string",
"restrict_contact_credentials_changes": true,
"restrict_contact_name_changes": true,
"restrict_organization_name_changes": 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": "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
}'The setting was saved successfully.
RB-3239 - when querying organizations, you can show contacts by role. Besides name/email/phone, you can also have additional fields added. A limit is imposed so that query descriptions do not blow up.
Who should have their regions assigned automatically
If set, contacts can create child organizations in the portal
If set, contacts can delete child organizations in the portal
If set, contacts can edit child organizations in the portal
Label for describing child organizations in the portal (plural)
Label for describing child organization in the portal
The default form for creating a contact in the console
The default form for creating an organization in the console
The default form for editing a contact in the console
The default form for editing an organization in the console
The scoring model for contacts
The contact roles that are allowed to manage this scholarship
If set, the sign up contact sign up/linking process will not create an organization
If set, contacts will not be allowed to be created/updated with a duplicate email address
If set, contacts & organizations are assigned to a region
If true, contacts can manage child organizations in the portal
Whether or not engagement scoring is enabled
If set, committee-related fields for certain committees will be included in all contact queries
If set, course-related fields for certain courses will be included in all contact queries
If set, event-related fields for certain events will be included in all contact queries
If set, the route that new contacts should be taken to after contact creation
The scoring model for organizations
The form used in the portal when an administrator adds an organization contact
The form used in the portal when an administrator edits an organization contact
The form for new users
Update profile portal form
Update profile portal form
If set, contacts cannot change their credentials in the portal
If set, contacts cannot change their name in the portal
If set, contacts cannot change their organization's name in the portal
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
{ "additional_contact_fields_to_show_in_organization_queries": [ { … } ], "automatic_region_assignment_options": { "automatically_assign": "both", "contact_address_type": "home", "contact_other_address_type_id": null, "rules": { … } }, "child_organization_portal_settings": { "allow_creation_of_new_child_organization": true, "allow_deleting_of_child_organization": true, "allow_editing_of_child_organization": true, "child_organization_label_plural": "string", "child_organization_label_singular": "string", "create_organization_form_id": null, "edit_organization_form_id": null }, "committees_to_include_in_contact_queries": [ { … } ], "console_create_contact_form_id": "string", "console_create_organization_form_id": "string", "console_edit_contact_form_id": "string", "console_edit_organization_form_id": "string", "contact_engagement_scoring_model_id": "string", "contact_role_permissions": [ { … } ], "contacts": { "default_360_screen": "string", "default_console_forms": { … }, "default_portal_forms": { … } }, "courses_to_include_in_contact_queries": [ { … } ], "disable_organization_creation_during_sign_up": true, "duplicate_prevention": "both", "enable_automatic_region_assignment": true, "enable_child_organization_management_in_portal": true, "enable_engagement_scoring": true, "events_to_include_in_contact_queries": [ { … } ], "include_committee_fields_in_contact_queries": true, "include_course_fields_in_contact_queries": true, "include_event_fields_in_contact_queries": true, "new_contact_redirect_route": "string", "notes": "string", "organization_engagement_scoring_model_id": "string", "organizations": { "default_360_screen": "string", "default_console_forms": { … }, "default_portal_forms": { … } }, "portal_create_organization_contact_form_id": "string", "portal_edit_organization_contact_form_id": "string", "portal_new_user_profile_form_id": "string", "portal_update_organization_info_form_id": "string", "portal_update_profile_form_id": "string", "restrict_contact_credentials_changes": true, "restrict_contact_name_changes": true, "restrict_organization_name_changes": 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": [ { … } ], "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 }
The updated setting that will be saved.
RB-3239 - when querying organizations, you can show contacts by role. Besides name/email/phone, you can also have additional fields added. A limit is imposed so that query descriptions do not blow up.
Who should have their regions assigned automatically
If set, contacts can create child organizations in the portal
If set, contacts can delete child organizations in the portal
If set, contacts can edit child organizations in the portal
Label for describing child organizations in the portal (plural)
Label for describing child organization in the portal
The default form for creating a contact in the console
The default form for creating an organization in the console
The default form for editing a contact in the console
The default form for editing an organization in the console
The scoring model for contacts
The contact roles that are allowed to manage this scholarship
If set, the sign up contact sign up/linking process will not create an organization
If set, contacts will not be allowed to be created/updated with a duplicate email address
If set, contacts & organizations are assigned to a region
If true, contacts can manage child organizations in the portal
Whether or not engagement scoring is enabled
If set, committee-related fields for certain committees will be included in all contact queries
If set, course-related fields for certain courses will be included in all contact queries
If set, event-related fields for certain events will be included in all contact queries
If set, the route that new contacts should be taken to after contact creation
The scoring model for organizations
The form used in the portal when an administrator adds an organization contact
The form used in the portal when an administrator edits an organization contact
The form for new users
Update profile portal form
Update profile portal form
If set, contacts cannot change their credentials in the portal
If set, contacts cannot change their name in the portal
If set, contacts cannot change their organization's name in the portal
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
https://docs.api.rhythmsoftware.com/_mock/apis/rolodex/rolodex-v1/settings/{tenantId}
https://rolodex.api.rhythmsoftware.com/settings/{tenantId}
curl -i -X PUT \
'https://docs.api.rhythmsoftware.com/_mock/apis/rolodex/rolodex-v1/settings/{tenantId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"additional_contact_fields_to_show_in_organization_queries": [
{
"label": "string",
"name": "string"
}
],
"automatic_region_assignment_options": {
"automatically_assign": "both",
"contact_address_type": "home",
"contact_other_address_type_id": null,
"rules": {
"0": {
"countries": {
"0": {
"country": "string"
}
},
"postal_code_ranges": {
"0": {
"end": "string",
"start": "string"
}
},
"region_id": "string",
"states": {
"0": {
"state": "string"
}
},
"type": "country"
}
}
},
"child_organization_portal_settings": {
"allow_creation_of_new_child_organization": true,
"allow_deleting_of_child_organization": true,
"allow_editing_of_child_organization": true,
"child_organization_label_plural": "string",
"child_organization_label_singular": "string",
"create_organization_form_id": null,
"edit_organization_form_id": null
},
"committees_to_include_in_contact_queries": [
{
"additional_fields": [
"string"
],
"committee_id": "string"
}
],
"console_create_contact_form_id": "string",
"console_create_organization_form_id": "string",
"console_edit_contact_form_id": "string",
"console_edit_organization_form_id": "string",
"contact_engagement_scoring_model_id": "string",
"contact_role_permissions": [
{
"create_child_organizations": true,
"create_contacts": true,
"delete_child_organizations": true,
"edit_child_organizations": true,
"edit_contacts": true,
"manage_child_organizations": true,
"remove_contacts": true,
"role_id": "string",
"update_organization_info": true,
"view_contacts": true
}
],
"contacts": {
"default_360_screen": "string",
"default_console_forms": {
"creation": "string",
"editing": "string"
},
"default_portal_forms": {
"add_organization_contact": "string",
"new_user": "string",
"update_organization_contact": "string",
"update_profile": "string"
}
},
"courses_to_include_in_contact_queries": [
{
"additional_fields": [
"string"
],
"course_id": "string"
}
],
"disable_organization_creation_during_sign_up": true,
"duplicate_prevention": "both",
"enable_automatic_region_assignment": true,
"enable_child_organization_management_in_portal": true,
"enable_engagement_scoring": true,
"events_to_include_in_contact_queries": [
{
"additional_fields": [
"string"
],
"event_id": "string"
}
],
"include_committee_fields_in_contact_queries": true,
"include_course_fields_in_contact_queries": true,
"include_event_fields_in_contact_queries": true,
"new_contact_redirect_route": "string",
"notes": "string",
"organization_engagement_scoring_model_id": "string",
"organizations": {
"default_360_screen": "string",
"default_console_forms": {
"creation": "string",
"editing": "string"
},
"default_portal_forms": {
"editing": "string"
}
},
"portal_create_organization_contact_form_id": "string",
"portal_edit_organization_contact_form_id": "string",
"portal_new_user_profile_form_id": "string",
"portal_update_organization_info_form_id": "string",
"portal_update_profile_form_id": "string",
"restrict_contact_credentials_changes": true,
"restrict_contact_name_changes": true,
"restrict_organization_name_changes": 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": "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
}'The setting was updated successfully.
RB-3239 - when querying organizations, you can show contacts by role. Besides name/email/phone, you can also have additional fields added. A limit is imposed so that query descriptions do not blow up.
Who should have their regions assigned automatically
If set, contacts can create child organizations in the portal
If set, contacts can delete child organizations in the portal
If set, contacts can edit child organizations in the portal
Label for describing child organizations in the portal (plural)
Label for describing child organization in the portal
The default form for creating a contact in the console
The default form for creating an organization in the console
The default form for editing a contact in the console
The default form for editing an organization in the console
The scoring model for contacts
The contact roles that are allowed to manage this scholarship
If set, the sign up contact sign up/linking process will not create an organization
If set, contacts will not be allowed to be created/updated with a duplicate email address
If set, contacts & organizations are assigned to a region
If true, contacts can manage child organizations in the portal
Whether or not engagement scoring is enabled
If set, committee-related fields for certain committees will be included in all contact queries
If set, course-related fields for certain courses will be included in all contact queries
If set, event-related fields for certain events will be included in all contact queries
If set, the route that new contacts should be taken to after contact creation
The scoring model for organizations
The form used in the portal when an administrator adds an organization contact
The form used in the portal when an administrator edits an organization contact
The form for new users
Update profile portal form
Update profile portal form
If set, contacts cannot change their credentials in the portal
If set, contacts cannot change their name in the portal
If set, contacts cannot change their organization's name in the portal
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
{ "additional_contact_fields_to_show_in_organization_queries": [ { … } ], "automatic_region_assignment_options": { "automatically_assign": "both", "contact_address_type": "home", "contact_other_address_type_id": null, "rules": { … } }, "child_organization_portal_settings": { "allow_creation_of_new_child_organization": true, "allow_deleting_of_child_organization": true, "allow_editing_of_child_organization": true, "child_organization_label_plural": "string", "child_organization_label_singular": "string", "create_organization_form_id": null, "edit_organization_form_id": null }, "committees_to_include_in_contact_queries": [ { … } ], "console_create_contact_form_id": "string", "console_create_organization_form_id": "string", "console_edit_contact_form_id": "string", "console_edit_organization_form_id": "string", "contact_engagement_scoring_model_id": "string", "contact_role_permissions": [ { … } ], "contacts": { "default_360_screen": "string", "default_console_forms": { … }, "default_portal_forms": { … } }, "courses_to_include_in_contact_queries": [ { … } ], "disable_organization_creation_during_sign_up": true, "duplicate_prevention": "both", "enable_automatic_region_assignment": true, "enable_child_organization_management_in_portal": true, "enable_engagement_scoring": true, "events_to_include_in_contact_queries": [ { … } ], "include_committee_fields_in_contact_queries": true, "include_course_fields_in_contact_queries": true, "include_event_fields_in_contact_queries": true, "new_contact_redirect_route": "string", "notes": "string", "organization_engagement_scoring_model_id": "string", "organizations": { "default_360_screen": "string", "default_console_forms": { … }, "default_portal_forms": { … } }, "portal_create_organization_contact_form_id": "string", "portal_edit_organization_contact_form_id": "string", "portal_new_user_profile_form_id": "string", "portal_update_organization_info_form_id": "string", "portal_update_profile_form_id": "string", "restrict_contact_credentials_changes": true, "restrict_contact_name_changes": true, "restrict_organization_name_changes": 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": [ { … } ], "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 }