# Creates a new setting record that does not already exist.

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.

Endpoint: POST /settings/{tenantId}
Version: v1-2025-04-18
Security: knox-authorizer

## Path parameters:

  - `tenantId` (string, required)
    The id of the tenant being accessed.

## Request fields (application/json):

  - `additional_contact_fields_to_show_in_organization_queries` (array)
    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.

  - `additional_contact_fields_to_show_in_organization_queries.label` (string, required)

  - `additional_contact_fields_to_show_in_organization_queries.name` (string, required)

  - `automatic_region_assignment_options` (object, required)

  - `automatic_region_assignment_options.automatically_assign` (string)
    Who should have their regions assigned automatically
    Enum: "both", "contacts", "organizations"

  - `automatic_region_assignment_options.contact_address_type` (string)
    Enum: "home", "other", "preferred", "school", "work"

  - `automatic_region_assignment_options.contact_other_address_type_id` (string)

  - `automatic_region_assignment_options.rules` (array)

  - `child_organization_portal_settings` (object, required)

  - `child_organization_portal_settings.allow_creation_of_new_child_organization` (boolean)
    If set, contacts can create child organizations in the portal

  - `child_organization_portal_settings.allow_deleting_of_child_organization` (boolean)
    If set, contacts can delete child organizations in the portal

  - `child_organization_portal_settings.allow_editing_of_child_organization` (boolean)
    If set, contacts can edit child organizations in the portal

  - `child_organization_portal_settings.child_organization_label_plural` (string, required)
    Label for describing child organizations in the portal (plural)

  - `child_organization_portal_settings.child_organization_label_singular` (string, required)
    Label for describing child organization in the portal

  - `child_organization_portal_settings.create_organization_form_id` (string)
    The form for new users

  - `child_organization_portal_settings.edit_organization_form_id` (string)
    The form for new users

  - `committees_to_include_in_contact_queries` (array, required)

  - `committees_to_include_in_contact_queries.additional_fields` (array)

  - `committees_to_include_in_contact_queries.committee_id` (string, required)
    The committee that is being linked

  - `console_create_contact_form_id` (string)
    The default form for creating a contact in the console

  - `console_create_organization_form_id` (string)
    The default form for creating an organization in the console

  - `console_edit_contact_form_id` (string)
    The default form for editing a contact in the console

  - `console_edit_organization_form_id` (string)
    The default form for editing an organization in the console

  - `contact_engagement_scoring_model_id` (string)
    The scoring model for contacts

  - `contact_role_permissions` (array)
    The contact roles that are allowed to manage this scholarship

  - `contact_role_permissions.create_child_organizations` (boolean)
    This role can create new child organizations

  - `contact_role_permissions.create_contacts` (boolean)
    This role can create contacts associated with the organization

  - `contact_role_permissions.delete_child_organizations` (boolean)
    This role can delete child organizations

  - `contact_role_permissions.edit_child_organizations` (boolean)
    This role can edit child organizations

  - `contact_role_permissions.edit_contacts` (boolean)
    This role can edit contacts associated with the organization

  - `contact_role_permissions.manage_child_organizations` (boolean)
    This role can manage child organizations

  - `contact_role_permissions.remove_contacts` (boolean)
    This role can remove contacts associated with the organization

  - `contact_role_permissions.role_id` (string)
    The contact role

  - `contact_role_permissions.update_organization_info` (boolean)
    Contacts in this role are notified any time new contacts are added to their organization

  - `contact_role_permissions.view_contacts` (boolean)
    This role can view contacts associated with the organization

  - `contacts` (object)

  - `contacts.default_360_screen` (string)
    The default 360 screen to show in the console

  - `contacts.default_console_forms` (object)

  - `contacts.default_console_forms.creation` (string)
    Default form for creating a contact in the console

  - `contacts.default_console_forms.editing` (string)
    Default form for editing a contact in the console

  - `contacts.default_portal_forms` (object)

  - `contacts.default_portal_forms.add_organization_contact` (string)
    Default form for a contact adding another contact in their organization in the portal

  - `contacts.default_portal_forms.new_user` (string)
    Default form for a new user in the portal

  - `contacts.default_portal_forms.update_organization_contact` (string)
    Default form for a contact editing another contact in their organization in the portal

  - `contacts.default_portal_forms.update_profile` (string)
    Default form for a contact editing themselves in the portal

  - `courses_to_include_in_contact_queries` (array, required)

  - `courses_to_include_in_contact_queries.course_id` (string, required)
    The course that is being linked

  - `disable_organization_creation_during_sign_up` (boolean)
    If set, the sign up contact sign up/linking process will not create an organization

  - `duplicate_prevention` (string)
    If set, contacts will not be allowed to be created/updated with a duplicate email address
    Enum: "both", "disabled", "portal"

  - `enable_automatic_region_assignment` (boolean)
    If set, contacts & organizations are assigned to a region

  - `enable_child_organization_management_in_portal` (boolean)
    If true, contacts can manage child organizations in the portal

  - `enable_engagement_scoring` (boolean)
    Whether or not engagement scoring is enabled

  - `events_to_include_in_contact_queries` (array, required)

  - `events_to_include_in_contact_queries.event_id` (string, required)
    The event that is being linked

  - `include_committee_fields_in_contact_queries` (boolean)
    If set, committee-related fields for certain committees will be included in all contact queries

  - `include_course_fields_in_contact_queries` (boolean)
    If set, course-related fields for certain courses will be included in all contact queries

  - `include_event_fields_in_contact_queries` (boolean)
    If set, event-related fields for certain events will be included in all contact queries

  - `new_contact_redirect_route` (string)
    If set, the route that new contacts should be taken to after contact creation

  - `notes` (string)

  - `organization_engagement_scoring_model_id` (string)
    The scoring model for organizations

  - `organizations` (object)

  - `portal_create_organization_contact_form_id` (string)
    The form used in the portal when an administrator adds an organization contact

  - `portal_edit_organization_contact_form_id` (string)
    The form used in the portal when an administrator edits an organization contact

  - `portal_new_user_profile_form_id` (string)
    The form for new users

  - `portal_update_organization_info_form_id` (string)
    Update profile portal form

  - `portal_update_profile_form_id` (string)
    Update profile portal form

  - `restrict_contact_credentials_changes` (boolean)
    If set, contacts cannot change their credentials in the portal

  - `restrict_contact_name_changes` (boolean)
    If set, contacts cannot change their name in the portal

  - `restrict_organization_name_changes` (boolean)
    If set, contacts cannot change their organization's name in the portal

  - `sys_bulk_load_at` (string)
    If this record was loaded via bulk, the timestamp when the record was processed

  - `sys_bulk_load_id` (string)
    If this record was loaded via bulk, the ID of the bulk load process

  - `sys_bulk_load_pk` (string)
    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_no` (number)
    If this record was loaded via bulk, the record number in the source file

  - `sys_bulk_load_source_file` (string)
    If this record was loaded via bulk, the source file

  - `sys_calculated_field_error` (string)
    The error associated with the calculated field

  - `sys_calculated_field_errors` (array)

  - `sys_calculated_field_errors.error` (string)

  - `sys_calculated_field_errors.field` (string)

  - `sys_configuration_snapshot_id` (string)
    If a snapshot was restored/applies to this record, the ID of the snapshot

  - `sys_created_at` (string, required)
    The date/time that this record was created, expressed in ISO-8601 date format

  - `sys_created_by_id` (string, required)
    The ID of the user that created this record

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

  - `sys_directive` (string)
    Means for passing directive information into an object processing logic

  - `sys_external_id` (string)
    The ID that a record has from an external system or data import

  - `sys_has_files_in_s3` (boolean)
    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_id` (string)
    If this record was last touched by a bulk data operation, the ID of that operation

  - `sys_last_bulk_data_operation_sys_version` (string)
    If this record was last touched by a bulk data operation, the sys_version at the time of that operation

  - `sys_last_modified_at` (string, required)
    The date/time that this record record was last modified, expressed in ISO-8601 date format

  - `sys_last_modified_by_id` (string, required)
    The ID of the user that last modified this record

  - `sys_last_security_context` (object)
    The security context of the last insert, modify, or delete performed on this item

  - `sys_locked` (boolean)
    If set, this record is locked and cannot be changed via the API

  - `sys_snapshot_base_version` (number)
    The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

  - `sys_version` (number)
    A number representing the version of this record in the database

## Response 200 fields (application/json):

  - `additional_contact_fields_to_show_in_organization_queries` (array)
    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.

  - `additional_contact_fields_to_show_in_organization_queries.label` (string, required)

  - `additional_contact_fields_to_show_in_organization_queries.name` (string, required)

  - `automatic_region_assignment_options` (object, required)

  - `automatic_region_assignment_options.automatically_assign` (string)
    Who should have their regions assigned automatically
    Enum: "both", "contacts", "organizations"

  - `automatic_region_assignment_options.contact_address_type` (string)
    Enum: "home", "other", "preferred", "school", "work"

  - `automatic_region_assignment_options.contact_other_address_type_id` (string)

  - `automatic_region_assignment_options.rules` (array)

  - `child_organization_portal_settings` (object, required)

  - `child_organization_portal_settings.allow_creation_of_new_child_organization` (boolean)
    If set, contacts can create child organizations in the portal

  - `child_organization_portal_settings.allow_deleting_of_child_organization` (boolean)
    If set, contacts can delete child organizations in the portal

  - `child_organization_portal_settings.allow_editing_of_child_organization` (boolean)
    If set, contacts can edit child organizations in the portal

  - `child_organization_portal_settings.child_organization_label_plural` (string, required)
    Label for describing child organizations in the portal (plural)

  - `child_organization_portal_settings.child_organization_label_singular` (string, required)
    Label for describing child organization in the portal

  - `child_organization_portal_settings.create_organization_form_id` (string)
    The form for new users

  - `child_organization_portal_settings.edit_organization_form_id` (string)
    The form for new users

  - `committees_to_include_in_contact_queries` (array, required)

  - `committees_to_include_in_contact_queries.additional_fields` (array)

  - `committees_to_include_in_contact_queries.committee_id` (string, required)
    The committee that is being linked

  - `console_create_contact_form_id` (string)
    The default form for creating a contact in the console

  - `console_create_organization_form_id` (string)
    The default form for creating an organization in the console

  - `console_edit_contact_form_id` (string)
    The default form for editing a contact in the console

  - `console_edit_organization_form_id` (string)
    The default form for editing an organization in the console

  - `contact_engagement_scoring_model_id` (string)
    The scoring model for contacts

  - `contact_role_permissions` (array)
    The contact roles that are allowed to manage this scholarship

  - `contact_role_permissions.create_child_organizations` (boolean)
    This role can create new child organizations

  - `contact_role_permissions.create_contacts` (boolean)
    This role can create contacts associated with the organization

  - `contact_role_permissions.delete_child_organizations` (boolean)
    This role can delete child organizations

  - `contact_role_permissions.edit_child_organizations` (boolean)
    This role can edit child organizations

  - `contact_role_permissions.edit_contacts` (boolean)
    This role can edit contacts associated with the organization

  - `contact_role_permissions.manage_child_organizations` (boolean)
    This role can manage child organizations

  - `contact_role_permissions.remove_contacts` (boolean)
    This role can remove contacts associated with the organization

  - `contact_role_permissions.role_id` (string)
    The contact role

  - `contact_role_permissions.update_organization_info` (boolean)
    Contacts in this role are notified any time new contacts are added to their organization

  - `contact_role_permissions.view_contacts` (boolean)
    This role can view contacts associated with the organization

  - `contacts` (object)

  - `contacts.default_360_screen` (string)
    The default 360 screen to show in the console

  - `contacts.default_console_forms` (object)

  - `contacts.default_console_forms.creation` (string)
    Default form for creating a contact in the console

  - `contacts.default_console_forms.editing` (string)
    Default form for editing a contact in the console

  - `contacts.default_portal_forms` (object)

  - `contacts.default_portal_forms.add_organization_contact` (string)
    Default form for a contact adding another contact in their organization in the portal

  - `contacts.default_portal_forms.new_user` (string)
    Default form for a new user in the portal

  - `contacts.default_portal_forms.update_organization_contact` (string)
    Default form for a contact editing another contact in their organization in the portal

  - `contacts.default_portal_forms.update_profile` (string)
    Default form for a contact editing themselves in the portal

  - `courses_to_include_in_contact_queries` (array, required)

  - `courses_to_include_in_contact_queries.course_id` (string, required)
    The course that is being linked

  - `disable_organization_creation_during_sign_up` (boolean)
    If set, the sign up contact sign up/linking process will not create an organization

  - `duplicate_prevention` (string)
    If set, contacts will not be allowed to be created/updated with a duplicate email address
    Enum: "both", "disabled", "portal"

  - `enable_automatic_region_assignment` (boolean)
    If set, contacts & organizations are assigned to a region

  - `enable_child_organization_management_in_portal` (boolean)
    If true, contacts can manage child organizations in the portal

  - `enable_engagement_scoring` (boolean)
    Whether or not engagement scoring is enabled

  - `events_to_include_in_contact_queries` (array, required)

  - `events_to_include_in_contact_queries.event_id` (string, required)
    The event that is being linked

  - `include_committee_fields_in_contact_queries` (boolean)
    If set, committee-related fields for certain committees will be included in all contact queries

  - `include_course_fields_in_contact_queries` (boolean)
    If set, course-related fields for certain courses will be included in all contact queries

  - `include_event_fields_in_contact_queries` (boolean)
    If set, event-related fields for certain events will be included in all contact queries

  - `new_contact_redirect_route` (string)
    If set, the route that new contacts should be taken to after contact creation

  - `notes` (string)

  - `organization_engagement_scoring_model_id` (string)
    The scoring model for organizations

  - `organizations` (object)

  - `portal_create_organization_contact_form_id` (string)
    The form used in the portal when an administrator adds an organization contact

  - `portal_edit_organization_contact_form_id` (string)
    The form used in the portal when an administrator edits an organization contact

  - `portal_new_user_profile_form_id` (string)
    The form for new users

  - `portal_update_organization_info_form_id` (string)
    Update profile portal form

  - `portal_update_profile_form_id` (string)
    Update profile portal form

  - `restrict_contact_credentials_changes` (boolean)
    If set, contacts cannot change their credentials in the portal

  - `restrict_contact_name_changes` (boolean)
    If set, contacts cannot change their name in the portal

  - `restrict_organization_name_changes` (boolean)
    If set, contacts cannot change their organization's name in the portal

  - `sys_bulk_load_at` (string)
    If this record was loaded via bulk, the timestamp when the record was processed

  - `sys_bulk_load_id` (string)
    If this record was loaded via bulk, the ID of the bulk load process

  - `sys_bulk_load_pk` (string)
    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_no` (number)
    If this record was loaded via bulk, the record number in the source file

  - `sys_bulk_load_source_file` (string)
    If this record was loaded via bulk, the source file

  - `sys_calculated_field_error` (string)
    The error associated with the calculated field

  - `sys_calculated_field_errors` (array)

  - `sys_calculated_field_errors.error` (string)

  - `sys_calculated_field_errors.field` (string)

  - `sys_configuration_snapshot_id` (string)
    If a snapshot was restored/applies to this record, the ID of the snapshot

  - `sys_created_at` (string, required)
    The date/time that this record was created, expressed in ISO-8601 date format

  - `sys_created_by_id` (string, required)
    The ID of the user that created this record

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

  - `sys_directive` (string)
    Means for passing directive information into an object processing logic

  - `sys_external_id` (string)
    The ID that a record has from an external system or data import

  - `sys_has_files_in_s3` (boolean)
    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_id` (string)
    If this record was last touched by a bulk data operation, the ID of that operation

  - `sys_last_bulk_data_operation_sys_version` (string)
    If this record was last touched by a bulk data operation, the sys_version at the time of that operation

  - `sys_last_modified_at` (string, required)
    The date/time that this record record was last modified, expressed in ISO-8601 date format

  - `sys_last_modified_by_id` (string, required)
    The ID of the user that last modified this record

  - `sys_last_security_context` (object)
    The security context of the last insert, modify, or delete performed on this item

  - `sys_locked` (boolean)
    If set, this record is locked and cannot be changed via the API

  - `sys_snapshot_base_version` (number)
    The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

  - `sys_version` (number)
    A number representing the version of this record in the database


## Response 400 fields

## Response 401 fields

## Response 403 fields

## Response 404 fields

## Response 405 fields

## Response 409 fields

## Response 429 fields

## Response 500 fields