Rolodex
/
Settings
/
Returns a setting from the system by its ID.

Rolodex (Contacts & Organizations) (v1-2025-04-18)

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.

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

Account Delegation Processes

Account Delegation Processes

Operations

Address Types

Address Types

Operations

Communication Types

Communication Types

Operations

Contact Directories

Contact Directories

Operations

Contact Districts

Contact Districts

Operations

Contact Duplicates

Contact Duplicates

Operations

Contact Login Profiles

Contact Login Profiles

Operations

Contact Role Rule Sets

Contact Role Rule Sets

Operations

Contact Roles

Contact Roles

Operations

Contacts

Contacts

Operations

Custom Activities

Custom Activities

Operations

Custom Activity Types

Custom Activity Types

Operations

Custom Engagement Metrics

Custom Engagement Metrics

Operations

Engagement Categories

Engagement Categories

Operations

Engagement Models

Engagement Models

Operations

Engagement Scores

Engagement Scores

Operations

Organization Directories

Organization Directories

Operations

Organization Duplicates

Organization Duplicates

Operations

Organization Types

Organization Types

Operations

Organizations

Organizations

Operations

Phone Number Types

Phone Number Types

Operations

Query Definitions

Query Definitions

Operations

Region Configurations

Region Configurations

Operations

Regions

Regions

Operations

Relationship Types

Relationship Types

Operations

Relationships

Relationships

Operations

Settings

Settings

Operations

Returns a setting from the system by its ID.

Request

This method will delete a setting with the specified ID.

Path
tenantIdstringrequired

The id of the tenant being accessed.

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

Responses

The setting 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 setting from the system by its ID.

Request

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

Path
tenantIdstringrequired

The id of the tenant being accessed.

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/rolodex/rolodex-v1/settings/{tenantId}?consistentRead=string&fields=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The setting was retrieved successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
additional_contact_fields_to_show_in_organization_queriesArray of objects<= 15 items

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.

automatic_region_assignment_optionsobject(Automatic Region Assignment Options)required
automatic_region_assignment_options.​automatically_assignstring(Automatically Assign)

Who should have their regions assigned automatically

Enum"both""contacts""organizations"
automatic_region_assignment_options.​contact_address_typestring(Contact Address Type)
Enum"home""other""preferred""school""work"
automatic_region_assignment_options.​contact_other_address_type_idContact Other Address Type (string)(Contact Other Address Type)
One of:
string(Contact Other Address Type)
automatic_region_assignment_options.​rulesArray of objectsnon-empty
One of:
non-empty
child_organization_portal_settingsobject(Child Organization Portal Settings)required
child_organization_portal_settings.​allow_creation_of_new_child_organizationboolean(Allow Creation Of New Child Organization)

If set, contacts can create child organizations in the portal

child_organization_portal_settings.​allow_deleting_of_child_organizationboolean(Allow Deleting Of Child Organization)

If set, contacts can delete child organizations in the portal

child_organization_portal_settings.​allow_editing_of_child_organizationboolean(Allow Editing Of Child Organization)

If set, contacts can edit child organizations in the portal

child_organization_portal_settings.​child_organization_label_pluralstring(Child Organization Label Plural)required

Label for describing child organizations in the portal (plural)

child_organization_portal_settings.​child_organization_label_singularstring(Child Organization Label Singular)required

Label for describing child organization in the portal

child_organization_portal_settings.​create_organization_form_idCreate Organization Form (string)(Create Organization Form)^rolodex-organizations__.*

The form for new users

One of:

The form for new users

string(Create Organization Form)^rolodex-organizations__.*

The form for new users

child_organization_portal_settings.​edit_organization_form_idEdit Organization Form (string)(Edit Organization Form)^rolodex-organizations__.*

The form for new users

One of:

The form for new users

string(Edit Organization Form)^rolodex-organizations__.*

The form for new users

committees_to_include_in_contact_queriesArray of objects[ 1 .. 15 ] itemsrequired
committees_to_include_in_contact_queries[].​additional_fieldsArray of strings(Additional Fields)<= 10 items
committees_to_include_in_contact_queries[].​committee_idstring(Committee)required

The committee that is being linked

console_create_contact_form_idstring(Console Create Contact Form)^rolodex-contacts__.*

The default form for creating a contact in the console

console_create_organization_form_idstring(Console Create Organization Form)^rolodex-organizations__.*

The default form for creating an organization in the console

console_edit_contact_form_idstring(Console Edit Contact Form)^rolodex-contacts__.*

The default form for editing a contact in the console

console_edit_organization_form_idstring(Console Edit Organization Form)^rolodex-organizations__.*

The default form for editing an organization in the console

contact_engagement_scoring_model_idstring(Contact Engagement Scoring Model)

The scoring model for contacts

contact_role_permissionsArray of objects

The contact roles that are allowed to manage this scholarship

contactsobject(Contacts)
courses_to_include_in_contact_queriesArray of objects[ 1 .. 15 ] itemsrequired
courses_to_include_in_contact_queries[].​additional_fieldsArray of strings(Additional Fields)<= 10 items
courses_to_include_in_contact_queries[].​course_idstring(Course)required

The course that is being linked

disable_organization_creation_during_sign_upboolean(Disable Organization Creation During Sign Up)

If set, the sign up contact sign up/linking process will not create an organization

duplicate_preventionstring(Duplicate Prevention)

If set, contacts will not be allowed to be created/updated with a duplicate email address

Enum"both""disabled""portal"
enable_automatic_region_assignmentboolean(Enable Automatic Region Assignment)

If set, contacts & organizations are assigned to a region

enable_child_organization_management_in_portalboolean(Enable Child Organization Management In Portal)

If true, contacts can manage child organizations in the portal

enable_engagement_scoringboolean(Enable Engagement Scoring)

Whether or not engagement scoring is enabled

events_to_include_in_contact_queriesArray of objects[ 1 .. 15 ] itemsrequired
events_to_include_in_contact_queries[].​additional_fieldsArray of strings(Additional Fields)<= 10 items
events_to_include_in_contact_queries[].​event_idstring(Event)required

The event that is being linked

include_committee_fields_in_contact_queriesboolean(Include Committee Fields In Contact Queries)

If set, committee-related fields for certain committees will be included in all contact queries

include_course_fields_in_contact_queriesboolean(Include Course Fields In Contact Queries)

If set, course-related fields for certain courses will be included in all contact queries

include_event_fields_in_contact_queriesboolean(Include Event Fields In Contact Queries)

If set, event-related fields for certain events will be included in all contact queries

new_contact_redirect_routestring(New Contact Redirect Route)

If set, the route that new contacts should be taken to after contact creation

notesstring(Notes)
organization_engagement_scoring_model_idstring(Organization Engagement Scoring Model)

The scoring model for organizations

organizationsobject(Organizations)
portal_create_organization_contact_form_idstring(Portal Create Organization Contact Form)^rolodex-contacts__.*

The form used in the portal when an administrator adds an organization contact

portal_edit_organization_contact_form_idstring(Portal Edit Organization Contact Form)^rolodex-contacts__.*

The form used in the portal when an administrator edits an organization contact

portal_new_user_profile_form_idstring(Portal New User Profile Form)^rolodex-contacts__.*

The form for new users

portal_update_organization_info_form_idstring(Portal Update Organization Info Form)^rolodex-organizations__.*

Update profile portal form

portal_update_profile_form_idstring(Portal Update Profile Form)^rolodex-contacts__.*

Update profile portal form

restrict_contact_credentials_changesboolean(Restrict Contact Credentials Changes)

If set, contacts cannot change their credentials in the portal

restrict_contact_name_changesboolean(Restrict Contact Name Changes)

If set, contacts cannot change their name in the portal

restrict_organization_name_changesboolean(Restrict Organization Name Changes)

If set, contacts cannot change their organization's name in the portal

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

Response
application/json
{
  "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
}

Partially updates a setting with the specified ID.

Request

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

Path
tenantIdstringrequired

The id of the tenant being accessed.

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/rolodex/rolodex-v1/settings/{tenantId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "op": "add",
      "path": "string",
      "value": "string"
    }
  ]'

Responses

The setting was patched successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
additional_contact_fields_to_show_in_organization_queriesArray of objects<= 15 items

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.

automatic_region_assignment_optionsobject(Automatic Region Assignment Options)required
automatic_region_assignment_options.​automatically_assignstring(Automatically Assign)

Who should have their regions assigned automatically

Enum"both""contacts""organizations"
automatic_region_assignment_options.​contact_address_typestring(Contact Address Type)
Enum"home""other""preferred""school""work"
automatic_region_assignment_options.​contact_other_address_type_idContact Other Address Type (string)(Contact Other Address Type)
One of:
string(Contact Other Address Type)
automatic_region_assignment_options.​rulesArray of objectsnon-empty
One of:
non-empty
child_organization_portal_settingsobject(Child Organization Portal Settings)required
child_organization_portal_settings.​allow_creation_of_new_child_organizationboolean(Allow Creation Of New Child Organization)

If set, contacts can create child organizations in the portal

child_organization_portal_settings.​allow_deleting_of_child_organizationboolean(Allow Deleting Of Child Organization)

If set, contacts can delete child organizations in the portal

child_organization_portal_settings.​allow_editing_of_child_organizationboolean(Allow Editing Of Child Organization)

If set, contacts can edit child organizations in the portal

child_organization_portal_settings.​child_organization_label_pluralstring(Child Organization Label Plural)required

Label for describing child organizations in the portal (plural)

child_organization_portal_settings.​child_organization_label_singularstring(Child Organization Label Singular)required

Label for describing child organization in the portal

child_organization_portal_settings.​create_organization_form_idCreate Organization Form (string)(Create Organization Form)^rolodex-organizations__.*

The form for new users

One of:

The form for new users

string(Create Organization Form)^rolodex-organizations__.*

The form for new users

child_organization_portal_settings.​edit_organization_form_idEdit Organization Form (string)(Edit Organization Form)^rolodex-organizations__.*

The form for new users

One of:

The form for new users

string(Edit Organization Form)^rolodex-organizations__.*

The form for new users

committees_to_include_in_contact_queriesArray of objects[ 1 .. 15 ] itemsrequired
committees_to_include_in_contact_queries[].​additional_fieldsArray of strings(Additional Fields)<= 10 items
committees_to_include_in_contact_queries[].​committee_idstring(Committee)required

The committee that is being linked

console_create_contact_form_idstring(Console Create Contact Form)^rolodex-contacts__.*

The default form for creating a contact in the console

console_create_organization_form_idstring(Console Create Organization Form)^rolodex-organizations__.*

The default form for creating an organization in the console

console_edit_contact_form_idstring(Console Edit Contact Form)^rolodex-contacts__.*

The default form for editing a contact in the console

console_edit_organization_form_idstring(Console Edit Organization Form)^rolodex-organizations__.*

The default form for editing an organization in the console

contact_engagement_scoring_model_idstring(Contact Engagement Scoring Model)

The scoring model for contacts

contact_role_permissionsArray of objects

The contact roles that are allowed to manage this scholarship

contactsobject(Contacts)
courses_to_include_in_contact_queriesArray of objects[ 1 .. 15 ] itemsrequired
courses_to_include_in_contact_queries[].​additional_fieldsArray of strings(Additional Fields)<= 10 items
courses_to_include_in_contact_queries[].​course_idstring(Course)required

The course that is being linked

disable_organization_creation_during_sign_upboolean(Disable Organization Creation During Sign Up)

If set, the sign up contact sign up/linking process will not create an organization

duplicate_preventionstring(Duplicate Prevention)

If set, contacts will not be allowed to be created/updated with a duplicate email address

Enum"both""disabled""portal"
enable_automatic_region_assignmentboolean(Enable Automatic Region Assignment)

If set, contacts & organizations are assigned to a region

enable_child_organization_management_in_portalboolean(Enable Child Organization Management In Portal)

If true, contacts can manage child organizations in the portal

enable_engagement_scoringboolean(Enable Engagement Scoring)

Whether or not engagement scoring is enabled

events_to_include_in_contact_queriesArray of objects[ 1 .. 15 ] itemsrequired
events_to_include_in_contact_queries[].​additional_fieldsArray of strings(Additional Fields)<= 10 items
events_to_include_in_contact_queries[].​event_idstring(Event)required

The event that is being linked

include_committee_fields_in_contact_queriesboolean(Include Committee Fields In Contact Queries)

If set, committee-related fields for certain committees will be included in all contact queries

include_course_fields_in_contact_queriesboolean(Include Course Fields In Contact Queries)

If set, course-related fields for certain courses will be included in all contact queries

include_event_fields_in_contact_queriesboolean(Include Event Fields In Contact Queries)

If set, event-related fields for certain events will be included in all contact queries

new_contact_redirect_routestring(New Contact Redirect Route)

If set, the route that new contacts should be taken to after contact creation

notesstring(Notes)
organization_engagement_scoring_model_idstring(Organization Engagement Scoring Model)

The scoring model for organizations

organizationsobject(Organizations)
portal_create_organization_contact_form_idstring(Portal Create Organization Contact Form)^rolodex-contacts__.*

The form used in the portal when an administrator adds an organization contact

portal_edit_organization_contact_form_idstring(Portal Edit Organization Contact Form)^rolodex-contacts__.*

The form used in the portal when an administrator edits an organization contact

portal_new_user_profile_form_idstring(Portal New User Profile Form)^rolodex-contacts__.*

The form for new users

portal_update_organization_info_form_idstring(Portal Update Organization Info Form)^rolodex-organizations__.*

Update profile portal form

portal_update_profile_form_idstring(Portal Update Profile Form)^rolodex-contacts__.*

Update profile portal form

restrict_contact_credentials_changesboolean(Restrict Contact Credentials Changes)

If set, contacts cannot change their credentials in the portal

restrict_contact_name_changesboolean(Restrict Contact Name Changes)

If set, contacts cannot change their name in the portal

restrict_organization_name_changesboolean(Restrict Organization Name Changes)

If set, contacts cannot change their organization's name in the portal

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

Response
application/json
{
  "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
}

Creates a new setting record that does not already exist.

Request

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

Path
tenantIdstringrequired

The id of the tenant being accessed.

Bodyapplication/jsonrequired

The setting that you would like to be saved.

additional_contact_fields_to_show_in_organization_queriesArray of objects<= 15 items

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.

automatic_region_assignment_optionsobject(Automatic Region Assignment Options)required
automatic_region_assignment_options.​automatically_assignstring(Automatically Assign)

Who should have their regions assigned automatically

Enum"both""contacts""organizations"
automatic_region_assignment_options.​contact_address_typestring(Contact Address Type)
Enum"home""other""preferred""school""work"
automatic_region_assignment_options.​contact_other_address_type_idContact Other Address Type (string)(Contact Other Address Type)
One of:
string(Contact Other Address Type)
automatic_region_assignment_options.​rulesArray of objectsnon-empty
One of:
non-empty
child_organization_portal_settingsobject(Child Organization Portal Settings)required
child_organization_portal_settings.​allow_creation_of_new_child_organizationboolean(Allow Creation Of New Child Organization)

If set, contacts can create child organizations in the portal

child_organization_portal_settings.​allow_deleting_of_child_organizationboolean(Allow Deleting Of Child Organization)

If set, contacts can delete child organizations in the portal

child_organization_portal_settings.​allow_editing_of_child_organizationboolean(Allow Editing Of Child Organization)

If set, contacts can edit child organizations in the portal

child_organization_portal_settings.​child_organization_label_pluralstring(Child Organization Label Plural)required

Label for describing child organizations in the portal (plural)

child_organization_portal_settings.​child_organization_label_singularstring(Child Organization Label Singular)required

Label for describing child organization in the portal

child_organization_portal_settings.​create_organization_form_idCreate Organization Form (string)(Create Organization Form)^rolodex-organizations__.*

The form for new users

One of:

The form for new users

string(Create Organization Form)^rolodex-organizations__.*

The form for new users

child_organization_portal_settings.​edit_organization_form_idEdit Organization Form (string)(Edit Organization Form)^rolodex-organizations__.*

The form for new users

One of:

The form for new users

string(Edit Organization Form)^rolodex-organizations__.*

The form for new users

committees_to_include_in_contact_queriesArray of objects[ 1 .. 15 ] itemsrequired
committees_to_include_in_contact_queries[].​additional_fieldsArray of strings(Additional Fields)<= 10 items
committees_to_include_in_contact_queries[].​committee_idstring(Committee)required

The committee that is being linked

console_create_contact_form_idstring(Console Create Contact Form)^rolodex-contacts__.*

The default form for creating a contact in the console

console_create_organization_form_idstring(Console Create Organization Form)^rolodex-organizations__.*

The default form for creating an organization in the console

console_edit_contact_form_idstring(Console Edit Contact Form)^rolodex-contacts__.*

The default form for editing a contact in the console

console_edit_organization_form_idstring(Console Edit Organization Form)^rolodex-organizations__.*

The default form for editing an organization in the console

contact_engagement_scoring_model_idstring(Contact Engagement Scoring Model)

The scoring model for contacts

contact_role_permissionsArray of objects

The contact roles that are allowed to manage this scholarship

contactsobject(Contacts)
courses_to_include_in_contact_queriesArray of objects[ 1 .. 15 ] itemsrequired
courses_to_include_in_contact_queries[].​additional_fieldsArray of strings(Additional Fields)<= 10 items
courses_to_include_in_contact_queries[].​course_idstring(Course)required

The course that is being linked

disable_organization_creation_during_sign_upboolean(Disable Organization Creation During Sign Up)

If set, the sign up contact sign up/linking process will not create an organization

duplicate_preventionstring(Duplicate Prevention)

If set, contacts will not be allowed to be created/updated with a duplicate email address

Enum"both""disabled""portal"
enable_automatic_region_assignmentboolean(Enable Automatic Region Assignment)

If set, contacts & organizations are assigned to a region

enable_child_organization_management_in_portalboolean(Enable Child Organization Management In Portal)

If true, contacts can manage child organizations in the portal

enable_engagement_scoringboolean(Enable Engagement Scoring)

Whether or not engagement scoring is enabled

events_to_include_in_contact_queriesArray of objects[ 1 .. 15 ] itemsrequired
events_to_include_in_contact_queries[].​additional_fieldsArray of strings(Additional Fields)<= 10 items
events_to_include_in_contact_queries[].​event_idstring(Event)required

The event that is being linked

include_committee_fields_in_contact_queriesboolean(Include Committee Fields In Contact Queries)

If set, committee-related fields for certain committees will be included in all contact queries

include_course_fields_in_contact_queriesboolean(Include Course Fields In Contact Queries)

If set, course-related fields for certain courses will be included in all contact queries

include_event_fields_in_contact_queriesboolean(Include Event Fields In Contact Queries)

If set, event-related fields for certain events will be included in all contact queries

new_contact_redirect_routestring(New Contact Redirect Route)

If set, the route that new contacts should be taken to after contact creation

notesstring(Notes)
organization_engagement_scoring_model_idstring(Organization Engagement Scoring Model)

The scoring model for organizations

organizationsobject(Organizations)
portal_create_organization_contact_form_idstring(Portal Create Organization Contact Form)^rolodex-contacts__.*

The form used in the portal when an administrator adds an organization contact

portal_edit_organization_contact_form_idstring(Portal Edit Organization Contact Form)^rolodex-contacts__.*

The form used in the portal when an administrator edits an organization contact

portal_new_user_profile_form_idstring(Portal New User Profile Form)^rolodex-contacts__.*

The form for new users

portal_update_organization_info_form_idstring(Portal Update Organization Info Form)^rolodex-organizations__.*

Update profile portal form

portal_update_profile_form_idstring(Portal Update Profile Form)^rolodex-contacts__.*

Update profile portal form

restrict_contact_credentials_changesboolean(Restrict Contact Credentials Changes)

If set, contacts cannot change their credentials in the portal

restrict_contact_name_changesboolean(Restrict Contact Name Changes)

If set, contacts cannot change their name in the portal

restrict_organization_name_changesboolean(Restrict Organization Name Changes)

If set, contacts cannot change their organization's name in the portal

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

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
  }'

Responses

The setting was saved successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
additional_contact_fields_to_show_in_organization_queriesArray of objects<= 15 items

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.

automatic_region_assignment_optionsobject(Automatic Region Assignment Options)required
automatic_region_assignment_options.​automatically_assignstring(Automatically Assign)

Who should have their regions assigned automatically

Enum"both""contacts""organizations"
automatic_region_assignment_options.​contact_address_typestring(Contact Address Type)
Enum"home""other""preferred""school""work"
automatic_region_assignment_options.​contact_other_address_type_idContact Other Address Type (string)(Contact Other Address Type)
One of:
string(Contact Other Address Type)
automatic_region_assignment_options.​rulesArray of objectsnon-empty
One of:
non-empty
child_organization_portal_settingsobject(Child Organization Portal Settings)required
child_organization_portal_settings.​allow_creation_of_new_child_organizationboolean(Allow Creation Of New Child Organization)

If set, contacts can create child organizations in the portal

child_organization_portal_settings.​allow_deleting_of_child_organizationboolean(Allow Deleting Of Child Organization)

If set, contacts can delete child organizations in the portal

child_organization_portal_settings.​allow_editing_of_child_organizationboolean(Allow Editing Of Child Organization)

If set, contacts can edit child organizations in the portal

child_organization_portal_settings.​child_organization_label_pluralstring(Child Organization Label Plural)required

Label for describing child organizations in the portal (plural)

child_organization_portal_settings.​child_organization_label_singularstring(Child Organization Label Singular)required

Label for describing child organization in the portal

child_organization_portal_settings.​create_organization_form_idCreate Organization Form (string)(Create Organization Form)^rolodex-organizations__.*

The form for new users

One of:

The form for new users

string(Create Organization Form)^rolodex-organizations__.*

The form for new users

child_organization_portal_settings.​edit_organization_form_idEdit Organization Form (string)(Edit Organization Form)^rolodex-organizations__.*

The form for new users

One of:

The form for new users

string(Edit Organization Form)^rolodex-organizations__.*

The form for new users

committees_to_include_in_contact_queriesArray of objects[ 1 .. 15 ] itemsrequired
committees_to_include_in_contact_queries[].​additional_fieldsArray of strings(Additional Fields)<= 10 items
committees_to_include_in_contact_queries[].​committee_idstring(Committee)required

The committee that is being linked

console_create_contact_form_idstring(Console Create Contact Form)^rolodex-contacts__.*

The default form for creating a contact in the console

console_create_organization_form_idstring(Console Create Organization Form)^rolodex-organizations__.*

The default form for creating an organization in the console

console_edit_contact_form_idstring(Console Edit Contact Form)^rolodex-contacts__.*

The default form for editing a contact in the console

console_edit_organization_form_idstring(Console Edit Organization Form)^rolodex-organizations__.*

The default form for editing an organization in the console

contact_engagement_scoring_model_idstring(Contact Engagement Scoring Model)

The scoring model for contacts

contact_role_permissionsArray of objects

The contact roles that are allowed to manage this scholarship

contactsobject(Contacts)
courses_to_include_in_contact_queriesArray of objects[ 1 .. 15 ] itemsrequired
courses_to_include_in_contact_queries[].​additional_fieldsArray of strings(Additional Fields)<= 10 items
courses_to_include_in_contact_queries[].​course_idstring(Course)required

The course that is being linked

disable_organization_creation_during_sign_upboolean(Disable Organization Creation During Sign Up)

If set, the sign up contact sign up/linking process will not create an organization

duplicate_preventionstring(Duplicate Prevention)

If set, contacts will not be allowed to be created/updated with a duplicate email address

Enum"both""disabled""portal"
enable_automatic_region_assignmentboolean(Enable Automatic Region Assignment)

If set, contacts & organizations are assigned to a region

enable_child_organization_management_in_portalboolean(Enable Child Organization Management In Portal)

If true, contacts can manage child organizations in the portal

enable_engagement_scoringboolean(Enable Engagement Scoring)

Whether or not engagement scoring is enabled

events_to_include_in_contact_queriesArray of objects[ 1 .. 15 ] itemsrequired
events_to_include_in_contact_queries[].​additional_fieldsArray of strings(Additional Fields)<= 10 items
events_to_include_in_contact_queries[].​event_idstring(Event)required

The event that is being linked

include_committee_fields_in_contact_queriesboolean(Include Committee Fields In Contact Queries)

If set, committee-related fields for certain committees will be included in all contact queries

include_course_fields_in_contact_queriesboolean(Include Course Fields In Contact Queries)

If set, course-related fields for certain courses will be included in all contact queries

include_event_fields_in_contact_queriesboolean(Include Event Fields In Contact Queries)

If set, event-related fields for certain events will be included in all contact queries

new_contact_redirect_routestring(New Contact Redirect Route)

If set, the route that new contacts should be taken to after contact creation

notesstring(Notes)
organization_engagement_scoring_model_idstring(Organization Engagement Scoring Model)

The scoring model for organizations

organizationsobject(Organizations)
portal_create_organization_contact_form_idstring(Portal Create Organization Contact Form)^rolodex-contacts__.*

The form used in the portal when an administrator adds an organization contact

portal_edit_organization_contact_form_idstring(Portal Edit Organization Contact Form)^rolodex-contacts__.*

The form used in the portal when an administrator edits an organization contact

portal_new_user_profile_form_idstring(Portal New User Profile Form)^rolodex-contacts__.*

The form for new users

portal_update_organization_info_form_idstring(Portal Update Organization Info Form)^rolodex-organizations__.*

Update profile portal form

portal_update_profile_form_idstring(Portal Update Profile Form)^rolodex-contacts__.*

Update profile portal form

restrict_contact_credentials_changesboolean(Restrict Contact Credentials Changes)

If set, contacts cannot change their credentials in the portal

restrict_contact_name_changesboolean(Restrict Contact Name Changes)

If set, contacts cannot change their name in the portal

restrict_organization_name_changesboolean(Restrict Organization Name Changes)

If set, contacts cannot change their organization's name in the portal

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

Response
application/json
{
  "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
}

Updates a setting with the specified ID.

Request

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

Path
tenantIdstringrequired

The id of the tenant being accessed.

Bodyapplication/jsonrequired

The updated setting that will be saved.

additional_contact_fields_to_show_in_organization_queriesArray of objects<= 15 items

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.

automatic_region_assignment_optionsobject(Automatic Region Assignment Options)required
automatic_region_assignment_options.​automatically_assignstring(Automatically Assign)

Who should have their regions assigned automatically

Enum"both""contacts""organizations"
automatic_region_assignment_options.​contact_address_typestring(Contact Address Type)
Enum"home""other""preferred""school""work"
automatic_region_assignment_options.​contact_other_address_type_idContact Other Address Type (string)(Contact Other Address Type)
One of:
string(Contact Other Address Type)
automatic_region_assignment_options.​rulesArray of objectsnon-empty
One of:
non-empty
child_organization_portal_settingsobject(Child Organization Portal Settings)required
child_organization_portal_settings.​allow_creation_of_new_child_organizationboolean(Allow Creation Of New Child Organization)

If set, contacts can create child organizations in the portal

child_organization_portal_settings.​allow_deleting_of_child_organizationboolean(Allow Deleting Of Child Organization)

If set, contacts can delete child organizations in the portal

child_organization_portal_settings.​allow_editing_of_child_organizationboolean(Allow Editing Of Child Organization)

If set, contacts can edit child organizations in the portal

child_organization_portal_settings.​child_organization_label_pluralstring(Child Organization Label Plural)required

Label for describing child organizations in the portal (plural)

child_organization_portal_settings.​child_organization_label_singularstring(Child Organization Label Singular)required

Label for describing child organization in the portal

child_organization_portal_settings.​create_organization_form_idCreate Organization Form (string)(Create Organization Form)^rolodex-organizations__.*

The form for new users

One of:

The form for new users

string(Create Organization Form)^rolodex-organizations__.*

The form for new users

child_organization_portal_settings.​edit_organization_form_idEdit Organization Form (string)(Edit Organization Form)^rolodex-organizations__.*

The form for new users

One of:

The form for new users

string(Edit Organization Form)^rolodex-organizations__.*

The form for new users

committees_to_include_in_contact_queriesArray of objects[ 1 .. 15 ] itemsrequired
committees_to_include_in_contact_queries[].​additional_fieldsArray of strings(Additional Fields)<= 10 items
committees_to_include_in_contact_queries[].​committee_idstring(Committee)required

The committee that is being linked

console_create_contact_form_idstring(Console Create Contact Form)^rolodex-contacts__.*

The default form for creating a contact in the console

console_create_organization_form_idstring(Console Create Organization Form)^rolodex-organizations__.*

The default form for creating an organization in the console

console_edit_contact_form_idstring(Console Edit Contact Form)^rolodex-contacts__.*

The default form for editing a contact in the console

console_edit_organization_form_idstring(Console Edit Organization Form)^rolodex-organizations__.*

The default form for editing an organization in the console

contact_engagement_scoring_model_idstring(Contact Engagement Scoring Model)

The scoring model for contacts

contact_role_permissionsArray of objects

The contact roles that are allowed to manage this scholarship

contactsobject(Contacts)
courses_to_include_in_contact_queriesArray of objects[ 1 .. 15 ] itemsrequired
courses_to_include_in_contact_queries[].​additional_fieldsArray of strings(Additional Fields)<= 10 items
courses_to_include_in_contact_queries[].​course_idstring(Course)required

The course that is being linked

disable_organization_creation_during_sign_upboolean(Disable Organization Creation During Sign Up)

If set, the sign up contact sign up/linking process will not create an organization

duplicate_preventionstring(Duplicate Prevention)

If set, contacts will not be allowed to be created/updated with a duplicate email address

Enum"both""disabled""portal"
enable_automatic_region_assignmentboolean(Enable Automatic Region Assignment)

If set, contacts & organizations are assigned to a region

enable_child_organization_management_in_portalboolean(Enable Child Organization Management In Portal)

If true, contacts can manage child organizations in the portal

enable_engagement_scoringboolean(Enable Engagement Scoring)

Whether or not engagement scoring is enabled

events_to_include_in_contact_queriesArray of objects[ 1 .. 15 ] itemsrequired
events_to_include_in_contact_queries[].​additional_fieldsArray of strings(Additional Fields)<= 10 items
events_to_include_in_contact_queries[].​event_idstring(Event)required

The event that is being linked

include_committee_fields_in_contact_queriesboolean(Include Committee Fields In Contact Queries)

If set, committee-related fields for certain committees will be included in all contact queries

include_course_fields_in_contact_queriesboolean(Include Course Fields In Contact Queries)

If set, course-related fields for certain courses will be included in all contact queries

include_event_fields_in_contact_queriesboolean(Include Event Fields In Contact Queries)

If set, event-related fields for certain events will be included in all contact queries

new_contact_redirect_routestring(New Contact Redirect Route)

If set, the route that new contacts should be taken to after contact creation

notesstring(Notes)
organization_engagement_scoring_model_idstring(Organization Engagement Scoring Model)

The scoring model for organizations

organizationsobject(Organizations)
portal_create_organization_contact_form_idstring(Portal Create Organization Contact Form)^rolodex-contacts__.*

The form used in the portal when an administrator adds an organization contact

portal_edit_organization_contact_form_idstring(Portal Edit Organization Contact Form)^rolodex-contacts__.*

The form used in the portal when an administrator edits an organization contact

portal_new_user_profile_form_idstring(Portal New User Profile Form)^rolodex-contacts__.*

The form for new users

portal_update_organization_info_form_idstring(Portal Update Organization Info Form)^rolodex-organizations__.*

Update profile portal form

portal_update_profile_form_idstring(Portal Update Profile Form)^rolodex-contacts__.*

Update profile portal form

restrict_contact_credentials_changesboolean(Restrict Contact Credentials Changes)

If set, contacts cannot change their credentials in the portal

restrict_contact_name_changesboolean(Restrict Contact Name Changes)

If set, contacts cannot change their name in the portal

restrict_organization_name_changesboolean(Restrict Organization Name Changes)

If set, contacts cannot change their organization's name in the portal

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

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
  }'

Responses

The setting was updated successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
additional_contact_fields_to_show_in_organization_queriesArray of objects<= 15 items

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.

automatic_region_assignment_optionsobject(Automatic Region Assignment Options)required
automatic_region_assignment_options.​automatically_assignstring(Automatically Assign)

Who should have their regions assigned automatically

Enum"both""contacts""organizations"
automatic_region_assignment_options.​contact_address_typestring(Contact Address Type)
Enum"home""other""preferred""school""work"
automatic_region_assignment_options.​contact_other_address_type_idContact Other Address Type (string)(Contact Other Address Type)
One of:
string(Contact Other Address Type)
automatic_region_assignment_options.​rulesArray of objectsnon-empty
One of:
non-empty
child_organization_portal_settingsobject(Child Organization Portal Settings)required
child_organization_portal_settings.​allow_creation_of_new_child_organizationboolean(Allow Creation Of New Child Organization)

If set, contacts can create child organizations in the portal

child_organization_portal_settings.​allow_deleting_of_child_organizationboolean(Allow Deleting Of Child Organization)

If set, contacts can delete child organizations in the portal

child_organization_portal_settings.​allow_editing_of_child_organizationboolean(Allow Editing Of Child Organization)

If set, contacts can edit child organizations in the portal

child_organization_portal_settings.​child_organization_label_pluralstring(Child Organization Label Plural)required

Label for describing child organizations in the portal (plural)

child_organization_portal_settings.​child_organization_label_singularstring(Child Organization Label Singular)required

Label for describing child organization in the portal

child_organization_portal_settings.​create_organization_form_idCreate Organization Form (string)(Create Organization Form)^rolodex-organizations__.*

The form for new users

One of:

The form for new users

string(Create Organization Form)^rolodex-organizations__.*

The form for new users

child_organization_portal_settings.​edit_organization_form_idEdit Organization Form (string)(Edit Organization Form)^rolodex-organizations__.*

The form for new users

One of:

The form for new users

string(Edit Organization Form)^rolodex-organizations__.*

The form for new users

committees_to_include_in_contact_queriesArray of objects[ 1 .. 15 ] itemsrequired
committees_to_include_in_contact_queries[].​additional_fieldsArray of strings(Additional Fields)<= 10 items
committees_to_include_in_contact_queries[].​committee_idstring(Committee)required

The committee that is being linked

console_create_contact_form_idstring(Console Create Contact Form)^rolodex-contacts__.*

The default form for creating a contact in the console

console_create_organization_form_idstring(Console Create Organization Form)^rolodex-organizations__.*

The default form for creating an organization in the console

console_edit_contact_form_idstring(Console Edit Contact Form)^rolodex-contacts__.*

The default form for editing a contact in the console

console_edit_organization_form_idstring(Console Edit Organization Form)^rolodex-organizations__.*

The default form for editing an organization in the console

contact_engagement_scoring_model_idstring(Contact Engagement Scoring Model)

The scoring model for contacts

contact_role_permissionsArray of objects

The contact roles that are allowed to manage this scholarship

contactsobject(Contacts)
courses_to_include_in_contact_queriesArray of objects[ 1 .. 15 ] itemsrequired
courses_to_include_in_contact_queries[].​additional_fieldsArray of strings(Additional Fields)<= 10 items
courses_to_include_in_contact_queries[].​course_idstring(Course)required

The course that is being linked

disable_organization_creation_during_sign_upboolean(Disable Organization Creation During Sign Up)

If set, the sign up contact sign up/linking process will not create an organization

duplicate_preventionstring(Duplicate Prevention)

If set, contacts will not be allowed to be created/updated with a duplicate email address

Enum"both""disabled""portal"
enable_automatic_region_assignmentboolean(Enable Automatic Region Assignment)

If set, contacts & organizations are assigned to a region

enable_child_organization_management_in_portalboolean(Enable Child Organization Management In Portal)

If true, contacts can manage child organizations in the portal

enable_engagement_scoringboolean(Enable Engagement Scoring)

Whether or not engagement scoring is enabled

events_to_include_in_contact_queriesArray of objects[ 1 .. 15 ] itemsrequired
events_to_include_in_contact_queries[].​additional_fieldsArray of strings(Additional Fields)<= 10 items
events_to_include_in_contact_queries[].​event_idstring(Event)required

The event that is being linked

include_committee_fields_in_contact_queriesboolean(Include Committee Fields In Contact Queries)

If set, committee-related fields for certain committees will be included in all contact queries

include_course_fields_in_contact_queriesboolean(Include Course Fields In Contact Queries)

If set, course-related fields for certain courses will be included in all contact queries

include_event_fields_in_contact_queriesboolean(Include Event Fields In Contact Queries)

If set, event-related fields for certain events will be included in all contact queries

new_contact_redirect_routestring(New Contact Redirect Route)

If set, the route that new contacts should be taken to after contact creation

notesstring(Notes)
organization_engagement_scoring_model_idstring(Organization Engagement Scoring Model)

The scoring model for organizations

organizationsobject(Organizations)
portal_create_organization_contact_form_idstring(Portal Create Organization Contact Form)^rolodex-contacts__.*

The form used in the portal when an administrator adds an organization contact

portal_edit_organization_contact_form_idstring(Portal Edit Organization Contact Form)^rolodex-contacts__.*

The form used in the portal when an administrator edits an organization contact

portal_new_user_profile_form_idstring(Portal New User Profile Form)^rolodex-contacts__.*

The form for new users

portal_update_organization_info_form_idstring(Portal Update Organization Info Form)^rolodex-organizations__.*

Update profile portal form

portal_update_profile_form_idstring(Portal Update Profile Form)^rolodex-contacts__.*

Update profile portal form

restrict_contact_credentials_changesboolean(Restrict Contact Credentials Changes)

If set, contacts cannot change their credentials in the portal

restrict_contact_name_changesboolean(Restrict Contact Name Changes)

If set, contacts cannot change their name in the portal

restrict_organization_name_changesboolean(Restrict Organization Name Changes)

If set, contacts cannot change their organization's name in the portal

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

Response
application/json
{
  "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
}

Statistics

Statistics

Operations