Rolodex
/
Contact Directories
/
Sends a message to an entry in the directory

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

Gets all of the contact directories in the system.

Request

This method will scan all contact directories and and return them to the caller.

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.

exclusiveStartKeystring

The start key, if you're making a subsequent request

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/rolodex/rolodex-v1/contactDirectories/{tenantId}?exclusiveStartKey=string&fields=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The contact directorieswere retrieved successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/jsonArray [
additional_fieldsArray of strings(Additional Fields)

These are additional fields that should be in the directory query, which will be available in the search results

comment_optionsobject(Comment Options)
custom_directory_entry_templatestring(Custom Directory Entry Template)required
custom_search_results_templatestring(Custom Search Results Template)required
custom_sort_fieldsArray of objectsnon-emptyrequired
custom_sort_fields[].​descendingboolean(Descending)
custom_sort_fields[].​namestring(Name)required
directory_entry_modestring(Directory Entry Mode)
Enum"custom""do not show""use default"
display_modestring(Display Mode)

The way that the directory should be displayed

Enum"list""search"
eligibility_criteriaobject(Eligibility Criteria)required

The criteria to use

eligibility_criteria.​advanced_rule_error_messagestring(Advanced Rule Error Message)

The error message to show when the advanced rule fails

eligibility_criteria.​advanced_rulesobject(Advanced Rules)
eligibility_criteria.​age_restrictionsobject(Age Restrictions)
eligibility_criteria.​award_optionsobject(Award Options)
eligibility_criteria.​award_recipientsboolean(Award Recipients)

If set, only people who have received awards

eligibility_criteria.​by_locationboolean(By Location)

If true, then filter by location

eligibility_criteria.​certificantsboolean(Certificants)

If set, only people with specific certifications

eligibility_criteria.​certification_optionsCertification Options (object)(Certification Options)
One of:
eligibility_criteria.​committee_member_optionsCommittee Member Options (object)(Committee Member Options)
One of:
eligibility_criteria.​committee_membersboolean(Committee Members)

If set, active members who belong to a committee can purchase

eligibility_criteria.​custom_logic_optionsCustom Logic Options (object)(Custom Logic Options)
One of:
eligibility_criteria.​customer_typestring(Customer Type)
Enum"contact""organization"
eligibility_criteria.​donor_optionsobject(Donor Options)
eligibility_criteria.​donorsboolean(Donors)

If true, only donors

eligibility_criteria.​enable_advanced_rulesboolean(Enable Advanced Rules)

Enable advanced JSON rules

eligibility_criteria.​enable_age_restrictionsboolean(Enable Age Restrictions)

Age registrations

eligibility_criteria.​enable_custom_logicboolean(Enable Custom Logic)

If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion

eligibility_criteria.​enable_entitlement_restrictionsboolean(Enable Entitlement Restrictions)

If set, then you must have certain entitlements

eligibility_criteria.​enable_expressionboolean(Enable Expression)

Whether or not to enable an expression for evaluation

eligibility_criteria.​enable_organization_restrictionsboolean(Enable Organization Restrictions)

If set, you can restrict organizations

eligibility_criteria.​enable_status_restrictionboolean(Enable Status Restriction)

If set, you can restrict by status

eligibility_criteria.​entitlement_restrictionsArray of objects
eligibility_criteria.​event_registration_optionsobject(Event Registration Options)
eligibility_criteria.​event_registrationsboolean(Event Registrations)

If set, only people who have registered for events

eligibility_criteria.​expressionstring(Expression)

The expression

eligibility_criteria.​expression_error_messagestring(Expression Error Message)

The error message to show when the expression fails

eligibility_criteria.​locationLocation (object)(Location)
One of:
eligibility_criteria.​logic_operatorstring(Logic Operator)
Enum"and""not"
eligibility_criteria.​member_optionsMember Options (object)(Member Options)
One of:
eligibility_criteria.​membersboolean(Members)

If set, active members can purchase this

eligibility_criteria.​non_membersboolean(Non Members)

If set, only nonmembers can purchase

eligibility_criteria.​organization_restrictionsobject(Organization Restrictions)
eligibility_criteria.​status_restrictionsArray of Status Restrictions (strings)(Status Restrictions)non-empty

The statuses

One of:

The statuses

non-empty
eligibility_criteria.​use_organization_for_eligibilityboolean(Use Organization For Eligibility)

If checked, a person's organization is used to check for eligibility, rather than the person themselves

enable_commentsboolean(Enable Comments)

If set, users are allowed to submit comments in the directory

enable_custom_search_results_templateboolean(Enable Custom Search Results Template)

If set, a custom search results template is displayed

enable_custom_sortingboolean(Enable Custom Sorting)

If true, the directory results will be sorted differently that the query

enable_eligibility_criteriaboolean(Enable Eligibility Criteria)

If set, only certain people can access this directory

enable_messagingboolean(Enable Messaging)

When true, users are able to contact other users through the directory

enable_query_expression_filterboolean(Enable Query Expression Filter)

If set to true, an expression can be used to further filter the query

enable_query_filterboolean(Enable Query Filter)

If set to true, the directory can display a subset of records based on the provided filter. If false, the default filter is used

enable_radius_searchboolean(Enable Radius Search)

If true, the user can search across zip code radius

idstring(ID)^[\w|-]+$required

The unique, string identifier of this contact directory

is_activeboolean(Is Active)

Whether or not this directory is active

is_publicboolean(Is Public)

If true, this is a public directory that can be accessed without security

namestring(Name)required

The name of the contact directory

page_sizenumber(float)(Page Size)[ 1 .. 50 ]

The page size, used for server side page and to combat scraping attacks

query_filter_expressionstring(Query Filter Expression)required

The expression to use to filter the directory

query_filter_rulesobject(Query Filter Rules)
radius_search_optionsobject(Radius Search Options)required
radius_search_options.​postal_code_fieldstring(Postal Code Field)required

The field to use as the basis for a radius search

radius_search_options.​radius_optionsArray of numbers(float)(Radius Options)non-emptyrequired

The various default radius that can be selected

refresh_periodnumber(float)(Refresh Period)>= 5

The period of time (in minutes) after which the directory should refresh it self

searchable_fieldsArray of objectsnon-emptyrequired

The fields in the directory that are displayed as search criteria

searchable_fields[].​group_namestring(Group Name)

The group/display label

searchable_fields[].​labelstring(Label)

The label that the field should be displayed

searchable_fields[].​namestring(Name)required

The field name

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_fields": [ … ],
    "comment_options": { … },
    "custom_directory_entry_template": "string",
    "custom_search_results_template": "string",
    "custom_sort_fields": [ … ],
    "directory_entry_mode": "custom",
    "display_mode": "list",
    "eligibility_criteria": { … },
    "enable_comments": true,
    "enable_custom_search_results_template": true,
    "enable_custom_sorting": true,
    "enable_eligibility_criteria": true,
    "enable_messaging": true,
    "enable_query_expression_filter": true,
    "enable_query_filter": true,
    "enable_radius_search": true,
    "id": "string",
    "is_active": true,
    "is_public": true,
    "name": "string",
    "page_size": 1,
    "query_filter_expression": "string",
    "query_filter_rules": {},
    "radius_search_options": { … },
    "refresh_period": 5,
    "searchable_fields": [ … ],
    "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 contact directory record that does not already exist.

Request

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

Path
tenantIdstringrequired

The id of the tenant being accessed.

Bodyapplication/jsonrequired

The contact directory that you would like to be saved.

additional_fieldsArray of strings(Additional Fields)

These are additional fields that should be in the directory query, which will be available in the search results

comment_optionsobject(Comment Options)
custom_directory_entry_templatestring(Custom Directory Entry Template)required
custom_search_results_templatestring(Custom Search Results Template)required
custom_sort_fieldsArray of objectsnon-emptyrequired
custom_sort_fields[].​descendingboolean(Descending)
custom_sort_fields[].​namestring(Name)required
directory_entry_modestring(Directory Entry Mode)
Enum"custom""do not show""use default"
display_modestring(Display Mode)

The way that the directory should be displayed

Enum"list""search"
eligibility_criteriaobject(Eligibility Criteria)required

The criteria to use

eligibility_criteria.​advanced_rule_error_messagestring(Advanced Rule Error Message)

The error message to show when the advanced rule fails

eligibility_criteria.​advanced_rulesobject(Advanced Rules)
eligibility_criteria.​age_restrictionsobject(Age Restrictions)
eligibility_criteria.​award_optionsobject(Award Options)
eligibility_criteria.​award_recipientsboolean(Award Recipients)

If set, only people who have received awards

eligibility_criteria.​by_locationboolean(By Location)

If true, then filter by location

eligibility_criteria.​certificantsboolean(Certificants)

If set, only people with specific certifications

eligibility_criteria.​certification_optionsCertification Options (object)(Certification Options)
One of:
eligibility_criteria.​committee_member_optionsCommittee Member Options (object)(Committee Member Options)
One of:
eligibility_criteria.​committee_membersboolean(Committee Members)

If set, active members who belong to a committee can purchase

eligibility_criteria.​custom_logic_optionsCustom Logic Options (object)(Custom Logic Options)
One of:
eligibility_criteria.​customer_typestring(Customer Type)
Enum"contact""organization"
eligibility_criteria.​donor_optionsobject(Donor Options)
eligibility_criteria.​donorsboolean(Donors)

If true, only donors

eligibility_criteria.​enable_advanced_rulesboolean(Enable Advanced Rules)

Enable advanced JSON rules

eligibility_criteria.​enable_age_restrictionsboolean(Enable Age Restrictions)

Age registrations

eligibility_criteria.​enable_custom_logicboolean(Enable Custom Logic)

If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion

eligibility_criteria.​enable_entitlement_restrictionsboolean(Enable Entitlement Restrictions)

If set, then you must have certain entitlements

eligibility_criteria.​enable_expressionboolean(Enable Expression)

Whether or not to enable an expression for evaluation

eligibility_criteria.​enable_organization_restrictionsboolean(Enable Organization Restrictions)

If set, you can restrict organizations

eligibility_criteria.​enable_status_restrictionboolean(Enable Status Restriction)

If set, you can restrict by status

eligibility_criteria.​entitlement_restrictionsArray of objects
eligibility_criteria.​event_registration_optionsobject(Event Registration Options)
eligibility_criteria.​event_registrationsboolean(Event Registrations)

If set, only people who have registered for events

eligibility_criteria.​expressionstring(Expression)

The expression

eligibility_criteria.​expression_error_messagestring(Expression Error Message)

The error message to show when the expression fails

eligibility_criteria.​locationLocation (object)(Location)
One of:
eligibility_criteria.​logic_operatorstring(Logic Operator)
Enum"and""not"
eligibility_criteria.​member_optionsMember Options (object)(Member Options)
One of:
eligibility_criteria.​membersboolean(Members)

If set, active members can purchase this

eligibility_criteria.​non_membersboolean(Non Members)

If set, only nonmembers can purchase

eligibility_criteria.​organization_restrictionsobject(Organization Restrictions)
eligibility_criteria.​status_restrictionsArray of Status Restrictions (strings)(Status Restrictions)non-empty

The statuses

One of:

The statuses

non-empty
eligibility_criteria.​use_organization_for_eligibilityboolean(Use Organization For Eligibility)

If checked, a person's organization is used to check for eligibility, rather than the person themselves

enable_commentsboolean(Enable Comments)

If set, users are allowed to submit comments in the directory

enable_custom_search_results_templateboolean(Enable Custom Search Results Template)

If set, a custom search results template is displayed

enable_custom_sortingboolean(Enable Custom Sorting)

If true, the directory results will be sorted differently that the query

enable_eligibility_criteriaboolean(Enable Eligibility Criteria)

If set, only certain people can access this directory

enable_messagingboolean(Enable Messaging)

When true, users are able to contact other users through the directory

enable_query_expression_filterboolean(Enable Query Expression Filter)

If set to true, an expression can be used to further filter the query

enable_query_filterboolean(Enable Query Filter)

If set to true, the directory can display a subset of records based on the provided filter. If false, the default filter is used

enable_radius_searchboolean(Enable Radius Search)

If true, the user can search across zip code radius

idstring(ID)^[\w|-]+$required

The unique, string identifier of this contact directory

is_activeboolean(Is Active)

Whether or not this directory is active

is_publicboolean(Is Public)

If true, this is a public directory that can be accessed without security

namestring(Name)required

The name of the contact directory

page_sizenumber(float)(Page Size)[ 1 .. 50 ]

The page size, used for server side page and to combat scraping attacks

query_filter_expressionstring(Query Filter Expression)required

The expression to use to filter the directory

query_filter_rulesobject(Query Filter Rules)
radius_search_optionsobject(Radius Search Options)required
radius_search_options.​postal_code_fieldstring(Postal Code Field)required

The field to use as the basis for a radius search

radius_search_options.​radius_optionsArray of numbers(float)(Radius Options)non-emptyrequired

The various default radius that can be selected

refresh_periodnumber(float)(Refresh Period)>= 5

The period of time (in minutes) after which the directory should refresh it self

searchable_fieldsArray of objectsnon-emptyrequired

The fields in the directory that are displayed as search criteria

searchable_fields[].​group_namestring(Group Name)

The group/display label

searchable_fields[].​labelstring(Label)

The label that the field should be displayed

searchable_fields[].​namestring(Name)required

The field name

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/contactDirectories/{tenantId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "additional_fields": [
      "string"
    ],
    "comment_options": {
      "comments_header_text": "string",
      "comments_instructions": "string",
      "comments_placeholder_text": "string",
      "enable_ratings": true,
      "hide_submitter_name": true,
      "leave_comment_button_text": "string",
      "max_rating": null,
      "no_comments_text": "string",
      "rating_label": "string",
      "save_comment_button": "string"
    },
    "custom_directory_entry_template": "string",
    "custom_search_results_template": "string",
    "custom_sort_fields": [
      {
        "descending": true,
        "name": "string"
      }
    ],
    "directory_entry_mode": "custom",
    "display_mode": "list",
    "eligibility_criteria": {
      "advanced_rule_error_message": "string",
      "advanced_rules": {},
      "age_restrictions": {
        "maximum_age": 0.1,
        "minimum_age": 0.1
      },
      "award_options": {
        "award_ids": [
          "string"
        ],
        "award_type_ids": [
          "string"
        ],
        "logic_operator": "and"
      },
      "award_recipients": true,
      "by_location": true,
      "certificants": true,
      "certification_options": {
        "logic_operator": "and",
        "program_ids": [
          "string"
        ]
      },
      "committee_member_options": {
        "committee_ids": [
          "string"
        ],
        "committee_position_ids": [
          "string"
        ],
        "committee_type_ids": [
          "string"
        ],
        "logic_operator": "and"
      },
      "committee_members": true,
      "custom_logic_options": {
        "lambda_function_id": "string"
      },
      "customer_type": "contact",
      "donor_options": {
        "donor_club_ids": [
          "string"
        ],
        "logic_operator": "and"
      },
      "donors": true,
      "enable_advanced_rules": true,
      "enable_age_restrictions": true,
      "enable_custom_logic": true,
      "enable_entitlement_restrictions": true,
      "enable_expression": true,
      "enable_organization_restrictions": true,
      "enable_status_restriction": true,
      "entitlement_restrictions": [
        {
          "quantity": 0.1,
          "type_id": "string"
        }
      ],
      "event_registration_options": {
        "event_ids": [
          "string"
        ],
        "logic_operator": "and",
        "registration_category_ids": [
          "string"
        ]
      },
      "event_registrations": true,
      "expression": "string",
      "expression_error_message": "string",
      "location": {
        "countries": [
          "string"
        ],
        "negate_logic": true
      },
      "logic_operator": "and",
      "member_options": {
        "chapter_member_options": {
          "chapter_ids": [
            "string"
          ],
          "chapter_type_ids": [
            "string"
          ],
          "logic_operator": "and"
        },
        "chapter_members": true,
        "member_package_ids": [
          "string"
        ],
        "member_status_reason_ids": [
          "string"
        ],
        "member_statuses": [
          "active"
        ],
        "member_type_ids": [
          "string"
        ],
        "section_member_options": {
          "logic_operator": "and",
          "section_ids": [
            "string"
          ],
          "section_type_ids": [
            "string"
          ]
        },
        "section_members": true
      },
      "members": true,
      "non_members": true,
      "organization_restrictions": {
        "contact_role_ids": [
          "string"
        ],
        "organization_type_ids": [
          "string"
        ]
      },
      "status_restrictions": {
        "0": "string"
      },
      "use_organization_for_eligibility": true
    },
    "enable_comments": true,
    "enable_custom_search_results_template": true,
    "enable_custom_sorting": true,
    "enable_eligibility_criteria": true,
    "enable_messaging": true,
    "enable_query_expression_filter": true,
    "enable_query_filter": true,
    "enable_radius_search": true,
    "id": "string",
    "is_active": true,
    "is_public": true,
    "name": "string",
    "page_size": 1,
    "query_filter_expression": "string",
    "query_filter_rules": {},
    "radius_search_options": {
      "postal_code_field": "string",
      "radius_options": [
        0.1
      ]
    },
    "refresh_period": 5,
    "searchable_fields": [
      {
        "group_name": "string",
        "label": "string",
        "name": "string"
      }
    ],
    "sys_bulk_load_at": "string",
    "sys_bulk_load_id": "string",
    "sys_bulk_load_pk": "string",
    "sys_bulk_load_record_no": 0.1,
    "sys_bulk_load_source_file": "string",
    "sys_calculated_field_error": "string",
    "sys_calculated_field_errors": [
      {
        "error": "string",
        "field": "string"
      }
    ],
    "sys_configuration_snapshot_id": "string",
    "sys_created_at": "2019-08-24T14:15:22Z",
    "sys_created_by_id": "string",
    "sys_deleted_by_id": "string",
    "sys_directive": "string",
    "sys_external_id": "string",
    "sys_has_files_in_s3": true,
    "sys_last_bulk_data_operation_id": "string",
    "sys_last_bulk_data_operation_sys_version": "string",
    "sys_last_modified_at": "2019-08-24T14:15:22Z",
    "sys_last_modified_by_id": "string",
    "sys_last_security_context": {},
    "sys_locked": true,
    "sys_snapshot_base_version": 0.1,
    "sys_version": 0.1
  }'

Responses

The contact directory was saved successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
additional_fieldsArray of strings(Additional Fields)

These are additional fields that should be in the directory query, which will be available in the search results

comment_optionsobject(Comment Options)
custom_directory_entry_templatestring(Custom Directory Entry Template)required
custom_search_results_templatestring(Custom Search Results Template)required
custom_sort_fieldsArray of objectsnon-emptyrequired
custom_sort_fields[].​descendingboolean(Descending)
custom_sort_fields[].​namestring(Name)required
directory_entry_modestring(Directory Entry Mode)
Enum"custom""do not show""use default"
display_modestring(Display Mode)

The way that the directory should be displayed

Enum"list""search"
eligibility_criteriaobject(Eligibility Criteria)required

The criteria to use

eligibility_criteria.​advanced_rule_error_messagestring(Advanced Rule Error Message)

The error message to show when the advanced rule fails

eligibility_criteria.​advanced_rulesobject(Advanced Rules)
eligibility_criteria.​age_restrictionsobject(Age Restrictions)
eligibility_criteria.​award_optionsobject(Award Options)
eligibility_criteria.​award_recipientsboolean(Award Recipients)

If set, only people who have received awards

eligibility_criteria.​by_locationboolean(By Location)

If true, then filter by location

eligibility_criteria.​certificantsboolean(Certificants)

If set, only people with specific certifications

eligibility_criteria.​certification_optionsCertification Options (object)(Certification Options)
One of:
eligibility_criteria.​committee_member_optionsCommittee Member Options (object)(Committee Member Options)
One of:
eligibility_criteria.​committee_membersboolean(Committee Members)

If set, active members who belong to a committee can purchase

eligibility_criteria.​custom_logic_optionsCustom Logic Options (object)(Custom Logic Options)
One of:
eligibility_criteria.​customer_typestring(Customer Type)
Enum"contact""organization"
eligibility_criteria.​donor_optionsobject(Donor Options)
eligibility_criteria.​donorsboolean(Donors)

If true, only donors

eligibility_criteria.​enable_advanced_rulesboolean(Enable Advanced Rules)

Enable advanced JSON rules

eligibility_criteria.​enable_age_restrictionsboolean(Enable Age Restrictions)

Age registrations

eligibility_criteria.​enable_custom_logicboolean(Enable Custom Logic)

If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion

eligibility_criteria.​enable_entitlement_restrictionsboolean(Enable Entitlement Restrictions)

If set, then you must have certain entitlements

eligibility_criteria.​enable_expressionboolean(Enable Expression)

Whether or not to enable an expression for evaluation

eligibility_criteria.​enable_organization_restrictionsboolean(Enable Organization Restrictions)

If set, you can restrict organizations

eligibility_criteria.​enable_status_restrictionboolean(Enable Status Restriction)

If set, you can restrict by status

eligibility_criteria.​entitlement_restrictionsArray of objects
eligibility_criteria.​event_registration_optionsobject(Event Registration Options)
eligibility_criteria.​event_registrationsboolean(Event Registrations)

If set, only people who have registered for events

eligibility_criteria.​expressionstring(Expression)

The expression

eligibility_criteria.​expression_error_messagestring(Expression Error Message)

The error message to show when the expression fails

eligibility_criteria.​locationLocation (object)(Location)
One of:
eligibility_criteria.​logic_operatorstring(Logic Operator)
Enum"and""not"
eligibility_criteria.​member_optionsMember Options (object)(Member Options)
One of:
eligibility_criteria.​membersboolean(Members)

If set, active members can purchase this

eligibility_criteria.​non_membersboolean(Non Members)

If set, only nonmembers can purchase

eligibility_criteria.​organization_restrictionsobject(Organization Restrictions)
eligibility_criteria.​status_restrictionsArray of Status Restrictions (strings)(Status Restrictions)non-empty

The statuses

One of:

The statuses

non-empty
eligibility_criteria.​use_organization_for_eligibilityboolean(Use Organization For Eligibility)

If checked, a person's organization is used to check for eligibility, rather than the person themselves

enable_commentsboolean(Enable Comments)

If set, users are allowed to submit comments in the directory

enable_custom_search_results_templateboolean(Enable Custom Search Results Template)

If set, a custom search results template is displayed

enable_custom_sortingboolean(Enable Custom Sorting)

If true, the directory results will be sorted differently that the query

enable_eligibility_criteriaboolean(Enable Eligibility Criteria)

If set, only certain people can access this directory

enable_messagingboolean(Enable Messaging)

When true, users are able to contact other users through the directory

enable_query_expression_filterboolean(Enable Query Expression Filter)

If set to true, an expression can be used to further filter the query

enable_query_filterboolean(Enable Query Filter)

If set to true, the directory can display a subset of records based on the provided filter. If false, the default filter is used

enable_radius_searchboolean(Enable Radius Search)

If true, the user can search across zip code radius

idstring(ID)^[\w|-]+$required

The unique, string identifier of this contact directory

is_activeboolean(Is Active)

Whether or not this directory is active

is_publicboolean(Is Public)

If true, this is a public directory that can be accessed without security

namestring(Name)required

The name of the contact directory

page_sizenumber(float)(Page Size)[ 1 .. 50 ]

The page size, used for server side page and to combat scraping attacks

query_filter_expressionstring(Query Filter Expression)required

The expression to use to filter the directory

query_filter_rulesobject(Query Filter Rules)
radius_search_optionsobject(Radius Search Options)required
radius_search_options.​postal_code_fieldstring(Postal Code Field)required

The field to use as the basis for a radius search

radius_search_options.​radius_optionsArray of numbers(float)(Radius Options)non-emptyrequired

The various default radius that can be selected

refresh_periodnumber(float)(Refresh Period)>= 5

The period of time (in minutes) after which the directory should refresh it self

searchable_fieldsArray of objectsnon-emptyrequired

The fields in the directory that are displayed as search criteria

searchable_fields[].​group_namestring(Group Name)

The group/display label

searchable_fields[].​labelstring(Label)

The label that the field should be displayed

searchable_fields[].​namestring(Name)required

The field name

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_fields": [
    "string"
  ],
  "comment_options": {
    "comments_header_text": "string",
    "comments_instructions": "string",
    "comments_placeholder_text": "string",
    "enable_ratings": true,
    "hide_submitter_name": true,
    "leave_comment_button_text": "string",
    "max_rating": null,
    "no_comments_text": "string",
    "rating_label": "string",
    "save_comment_button": "string"
  },
  "custom_directory_entry_template": "string",
  "custom_search_results_template": "string",
  "custom_sort_fields": [
    { … }
  ],
  "directory_entry_mode": "custom",
  "display_mode": "list",
  "eligibility_criteria": {
    "advanced_rule_error_message": "string",
    "advanced_rules": {},
    "age_restrictions": { … },
    "award_options": { … },
    "award_recipients": true,
    "by_location": true,
    "certificants": true,
    "certification_options": { … },
    "committee_member_options": { … },
    "committee_members": true,
    "custom_logic_options": { … },
    "customer_type": "contact",
    "donor_options": { … },
    "donors": true,
    "enable_advanced_rules": true,
    "enable_age_restrictions": true,
    "enable_custom_logic": true,
    "enable_entitlement_restrictions": true,
    "enable_expression": true,
    "enable_organization_restrictions": true,
    "enable_status_restriction": true,
    "entitlement_restrictions": [ … ],
    "event_registration_options": { … },
    "event_registrations": true,
    "expression": "string",
    "expression_error_message": "string",
    "location": { … },
    "logic_operator": "and",
    "member_options": { … },
    "members": true,
    "non_members": true,
    "organization_restrictions": { … },
    "status_restrictions": { … },
    "use_organization_for_eligibility": true
  },
  "enable_comments": true,
  "enable_custom_search_results_template": true,
  "enable_custom_sorting": true,
  "enable_eligibility_criteria": true,
  "enable_messaging": true,
  "enable_query_expression_filter": true,
  "enable_query_filter": true,
  "enable_radius_search": true,
  "id": "string",
  "is_active": true,
  "is_public": true,
  "name": "string",
  "page_size": 1,
  "query_filter_expression": "string",
  "query_filter_rules": {},
  "radius_search_options": {
    "postal_code_field": "string",
    "radius_options": [ … ]
  },
  "refresh_period": 5,
  "searchable_fields": [
    { … }
  ],
  "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
}

Execute Batch Operations

Request

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

Path
tenantIdstringrequired

The id of the tenant being accessed.

Bodyapplication/jsonrequired

The batch request

operationsArray of objects
curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/rolodex/rolodex-v1/contactDirectories/{tenantId}/batch' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "operations": [
      {
        "id": null,
        "object": {},
        "operation": "create",
        "patch_directives": {
          "0": {
            "op": "add",
            "path": "string",
            "value": "string"
          }
        }
      }
    ]
  }'

Responses

Request completed successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
error_countnumber(float)(Error Count)

Number of error results

resultsArray of objects
success_countnumber(float)(Success Count)

Number of successful results

Response
application/json
{
  "error_count": 0.1,
  "results": [
    { … }
  ],
  "success_count": 0.1
}

Gets an entry in the directory

Request

Path
tenantIdstringrequired

Parameters to the query

idstringrequired

directory

entryIdstringrequired

The id of the entry

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/rolodex/rolodex-v1/contactDirectories/{tenantId}/public/entry/{id}/{entryId}'

Responses

The contact was merged successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
object
Response
application/json
{}

Searches the directory

Request

Path
tenantIdstringrequired

Parameters to the query

idstringrequired

directory

Bodyapplication/jsonrequired

The query

criteriaobject(Criteria)
pagenumber(float)(Page)

The page being requested

radius_searchobject(Radius Search)
curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/rolodex/rolodex-v1/contactDirectories/{tenantId}/public/search/{id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "criteria": {},
    "page": 0.1,
    "radius_search": {
      "postal_code": "string",
      "radius": 1
    }
  }'

Responses

The contact was merged successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
fieldsArray of objects
queryobject(Query)
rowsArray of objects
sqlstring(Sql)
target_servicestring(Target Service)

The target service of the query

totalNumberOfRowsnumber(float)(Totalnumberofrows)
Response
application/json
{
  "fields": [
    { … }
  ],
  "query": {},
  "rows": [
    {}
  ],
  "sql": "string",
  "target_service": "string",
  "totalNumberOfRows": 0.1
}

Sends a message to an entry in the directory

Request

Path
tenantIdstringrequired

Parameters to the query

directoryIdstringrequired

directory

entryIdstringrequired

The id of the entry

Bodyapplication/jsonrequired

The message to send

bccstring(Bcc)

Anyone that should be bcc'ed on the email

bodystring(Body)required

The email body

ccstring(Cc)

Anyone that should be cc'ed on the email

fromstring(From)

From email address

from_namestring(From Name)

From name

reply_tostring(Reply To)

The reply to

subjectstring(Subject)required

The email subject

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/rolodex/rolodex-v1/contactDirectories/{tenantId}/public/sendMessage/{directoryId}/{entryId}' \
  -H 'Content-Type: application/json' \
  -d '{
    "bcc": "string",
    "body": "string",
    "cc": "string",
    "from": "string",
    "from_name": "string",
    "reply_to": "string",
    "subject": "string"
  }'

Responses

The contact was merged successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
object
Response
application/json
{}

Returns a contact directory from the system by its ID.

Request

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

Path
tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the contact directory to return.

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/contactDirectories/{tenantId}/public/{id}?consistentRead=string&fields=string'

Responses

The contact directory was retrieved successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
additional_fieldsArray of strings(Additional Fields)

These are additional fields that should be in the directory query, which will be available in the search results

comment_optionsobject(Comment Options)
custom_directory_entry_templatestring(Custom Directory Entry Template)required
custom_search_results_templatestring(Custom Search Results Template)required
custom_sort_fieldsArray of objectsnon-emptyrequired
custom_sort_fields[].​descendingboolean(Descending)
custom_sort_fields[].​namestring(Name)required
directory_entry_modestring(Directory Entry Mode)
Enum"custom""do not show""use default"
display_modestring(Display Mode)

The way that the directory should be displayed

Enum"list""search"
eligibility_criteriaobject(Eligibility Criteria)required

The criteria to use

eligibility_criteria.​advanced_rule_error_messagestring(Advanced Rule Error Message)

The error message to show when the advanced rule fails

eligibility_criteria.​advanced_rulesobject(Advanced Rules)
eligibility_criteria.​age_restrictionsobject(Age Restrictions)
eligibility_criteria.​award_optionsobject(Award Options)
eligibility_criteria.​award_recipientsboolean(Award Recipients)

If set, only people who have received awards

eligibility_criteria.​by_locationboolean(By Location)

If true, then filter by location

eligibility_criteria.​certificantsboolean(Certificants)

If set, only people with specific certifications

eligibility_criteria.​certification_optionsCertification Options (object)(Certification Options)
One of:
eligibility_criteria.​committee_member_optionsCommittee Member Options (object)(Committee Member Options)
One of:
eligibility_criteria.​committee_membersboolean(Committee Members)

If set, active members who belong to a committee can purchase

eligibility_criteria.​custom_logic_optionsCustom Logic Options (object)(Custom Logic Options)
One of:
eligibility_criteria.​customer_typestring(Customer Type)
Enum"contact""organization"
eligibility_criteria.​donor_optionsobject(Donor Options)
eligibility_criteria.​donorsboolean(Donors)

If true, only donors

eligibility_criteria.​enable_advanced_rulesboolean(Enable Advanced Rules)

Enable advanced JSON rules

eligibility_criteria.​enable_age_restrictionsboolean(Enable Age Restrictions)

Age registrations

eligibility_criteria.​enable_custom_logicboolean(Enable Custom Logic)

If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion

eligibility_criteria.​enable_entitlement_restrictionsboolean(Enable Entitlement Restrictions)

If set, then you must have certain entitlements

eligibility_criteria.​enable_expressionboolean(Enable Expression)

Whether or not to enable an expression for evaluation

eligibility_criteria.​enable_organization_restrictionsboolean(Enable Organization Restrictions)

If set, you can restrict organizations

eligibility_criteria.​enable_status_restrictionboolean(Enable Status Restriction)

If set, you can restrict by status

eligibility_criteria.​entitlement_restrictionsArray of objects
eligibility_criteria.​event_registration_optionsobject(Event Registration Options)
eligibility_criteria.​event_registrationsboolean(Event Registrations)

If set, only people who have registered for events

eligibility_criteria.​expressionstring(Expression)

The expression

eligibility_criteria.​expression_error_messagestring(Expression Error Message)

The error message to show when the expression fails

eligibility_criteria.​locationLocation (object)(Location)
One of:
eligibility_criteria.​logic_operatorstring(Logic Operator)
Enum"and""not"
eligibility_criteria.​member_optionsMember Options (object)(Member Options)
One of:
eligibility_criteria.​membersboolean(Members)

If set, active members can purchase this

eligibility_criteria.​non_membersboolean(Non Members)

If set, only nonmembers can purchase

eligibility_criteria.​organization_restrictionsobject(Organization Restrictions)
eligibility_criteria.​status_restrictionsArray of Status Restrictions (strings)(Status Restrictions)non-empty

The statuses

One of:

The statuses

non-empty
eligibility_criteria.​use_organization_for_eligibilityboolean(Use Organization For Eligibility)

If checked, a person's organization is used to check for eligibility, rather than the person themselves

enable_commentsboolean(Enable Comments)

If set, users are allowed to submit comments in the directory

enable_custom_search_results_templateboolean(Enable Custom Search Results Template)

If set, a custom search results template is displayed

enable_custom_sortingboolean(Enable Custom Sorting)

If true, the directory results will be sorted differently that the query

enable_eligibility_criteriaboolean(Enable Eligibility Criteria)

If set, only certain people can access this directory

enable_messagingboolean(Enable Messaging)

When true, users are able to contact other users through the directory

enable_query_expression_filterboolean(Enable Query Expression Filter)

If set to true, an expression can be used to further filter the query

enable_query_filterboolean(Enable Query Filter)

If set to true, the directory can display a subset of records based on the provided filter. If false, the default filter is used

enable_radius_searchboolean(Enable Radius Search)

If true, the user can search across zip code radius

idstring(ID)^[\w|-]+$required

The unique, string identifier of this contact directory

is_activeboolean(Is Active)

Whether or not this directory is active

is_publicboolean(Is Public)

If true, this is a public directory that can be accessed without security

namestring(Name)required

The name of the contact directory

page_sizenumber(float)(Page Size)[ 1 .. 50 ]

The page size, used for server side page and to combat scraping attacks

query_filter_expressionstring(Query Filter Expression)required

The expression to use to filter the directory

query_filter_rulesobject(Query Filter Rules)
radius_search_optionsobject(Radius Search Options)required
radius_search_options.​postal_code_fieldstring(Postal Code Field)required

The field to use as the basis for a radius search

radius_search_options.​radius_optionsArray of numbers(float)(Radius Options)non-emptyrequired

The various default radius that can be selected

refresh_periodnumber(float)(Refresh Period)>= 5

The period of time (in minutes) after which the directory should refresh it self

searchable_fieldsArray of objectsnon-emptyrequired

The fields in the directory that are displayed as search criteria

searchable_fields[].​group_namestring(Group Name)

The group/display label

searchable_fields[].​labelstring(Label)

The label that the field should be displayed

searchable_fields[].​namestring(Name)required

The field name

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_fields": [
    "string"
  ],
  "comment_options": {
    "comments_header_text": "string",
    "comments_instructions": "string",
    "comments_placeholder_text": "string",
    "enable_ratings": true,
    "hide_submitter_name": true,
    "leave_comment_button_text": "string",
    "max_rating": null,
    "no_comments_text": "string",
    "rating_label": "string",
    "save_comment_button": "string"
  },
  "custom_directory_entry_template": "string",
  "custom_search_results_template": "string",
  "custom_sort_fields": [
    { … }
  ],
  "directory_entry_mode": "custom",
  "display_mode": "list",
  "eligibility_criteria": {
    "advanced_rule_error_message": "string",
    "advanced_rules": {},
    "age_restrictions": { … },
    "award_options": { … },
    "award_recipients": true,
    "by_location": true,
    "certificants": true,
    "certification_options": { … },
    "committee_member_options": { … },
    "committee_members": true,
    "custom_logic_options": { … },
    "customer_type": "contact",
    "donor_options": { … },
    "donors": true,
    "enable_advanced_rules": true,
    "enable_age_restrictions": true,
    "enable_custom_logic": true,
    "enable_entitlement_restrictions": true,
    "enable_expression": true,
    "enable_organization_restrictions": true,
    "enable_status_restriction": true,
    "entitlement_restrictions": [ … ],
    "event_registration_options": { … },
    "event_registrations": true,
    "expression": "string",
    "expression_error_message": "string",
    "location": { … },
    "logic_operator": "and",
    "member_options": { … },
    "members": true,
    "non_members": true,
    "organization_restrictions": { … },
    "status_restrictions": { … },
    "use_organization_for_eligibility": true
  },
  "enable_comments": true,
  "enable_custom_search_results_template": true,
  "enable_custom_sorting": true,
  "enable_eligibility_criteria": true,
  "enable_messaging": true,
  "enable_query_expression_filter": true,
  "enable_query_filter": true,
  "enable_radius_search": true,
  "id": "string",
  "is_active": true,
  "is_public": true,
  "name": "string",
  "page_size": 1,
  "query_filter_expression": "string",
  "query_filter_rules": {},
  "radius_search_options": {
    "postal_code_field": "string",
    "radius_options": [ … ]
  },
  "refresh_period": 5,
  "searchable_fields": [
    { … }
  ],
  "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
}

Searches the directory

Request

Path
tenantIdstringrequired

Parameters to the query

idstringrequired

directory

Bodyapplication/jsonrequired

The query

criteriaobject(Criteria)
pagenumber(float)(Page)

The page being requested

radius_searchobject(Radius Search)
curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/rolodex/rolodex-v1/contactDirectories/{tenantId}/search/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "criteria": {},
    "page": 0.1,
    "radius_search": {
      "postal_code": "string",
      "radius": 1
    }
  }'

Responses

The contact was merged successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
fieldsArray of objects
queryobject(Query)
rowsArray of objects
sqlstring(Sql)
target_servicestring(Target Service)

The target service of the query

totalNumberOfRowsnumber(float)(Totalnumberofrows)
Response
application/json
{
  "fields": [
    { … }
  ],
  "query": {},
  "rows": [
    {}
  ],
  "sql": "string",
  "target_service": "string",
  "totalNumberOfRows": 0.1
}

Returns a contact directory from the system by its ID.

Request

This method will delete a contact directory with the specified ID.

Path
tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the contact directory to delete.

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

Responses

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

Request

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

Path
tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the contact directory to return.

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

Responses

The contact directory was retrieved successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
additional_fieldsArray of strings(Additional Fields)

These are additional fields that should be in the directory query, which will be available in the search results

comment_optionsobject(Comment Options)
custom_directory_entry_templatestring(Custom Directory Entry Template)required
custom_search_results_templatestring(Custom Search Results Template)required
custom_sort_fieldsArray of objectsnon-emptyrequired
custom_sort_fields[].​descendingboolean(Descending)
custom_sort_fields[].​namestring(Name)required
directory_entry_modestring(Directory Entry Mode)
Enum"custom""do not show""use default"
display_modestring(Display Mode)

The way that the directory should be displayed

Enum"list""search"
eligibility_criteriaobject(Eligibility Criteria)required

The criteria to use

eligibility_criteria.​advanced_rule_error_messagestring(Advanced Rule Error Message)

The error message to show when the advanced rule fails

eligibility_criteria.​advanced_rulesobject(Advanced Rules)
eligibility_criteria.​age_restrictionsobject(Age Restrictions)
eligibility_criteria.​award_optionsobject(Award Options)
eligibility_criteria.​award_recipientsboolean(Award Recipients)

If set, only people who have received awards

eligibility_criteria.​by_locationboolean(By Location)

If true, then filter by location

eligibility_criteria.​certificantsboolean(Certificants)

If set, only people with specific certifications

eligibility_criteria.​certification_optionsCertification Options (object)(Certification Options)
One of:
eligibility_criteria.​committee_member_optionsCommittee Member Options (object)(Committee Member Options)
One of:
eligibility_criteria.​committee_membersboolean(Committee Members)

If set, active members who belong to a committee can purchase

eligibility_criteria.​custom_logic_optionsCustom Logic Options (object)(Custom Logic Options)
One of:
eligibility_criteria.​customer_typestring(Customer Type)
Enum"contact""organization"
eligibility_criteria.​donor_optionsobject(Donor Options)
eligibility_criteria.​donorsboolean(Donors)

If true, only donors

eligibility_criteria.​enable_advanced_rulesboolean(Enable Advanced Rules)

Enable advanced JSON rules

eligibility_criteria.​enable_age_restrictionsboolean(Enable Age Restrictions)

Age registrations

eligibility_criteria.​enable_custom_logicboolean(Enable Custom Logic)

If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion

eligibility_criteria.​enable_entitlement_restrictionsboolean(Enable Entitlement Restrictions)

If set, then you must have certain entitlements

eligibility_criteria.​enable_expressionboolean(Enable Expression)

Whether or not to enable an expression for evaluation

eligibility_criteria.​enable_organization_restrictionsboolean(Enable Organization Restrictions)

If set, you can restrict organizations

eligibility_criteria.​enable_status_restrictionboolean(Enable Status Restriction)

If set, you can restrict by status

eligibility_criteria.​entitlement_restrictionsArray of objects
eligibility_criteria.​event_registration_optionsobject(Event Registration Options)
eligibility_criteria.​event_registrationsboolean(Event Registrations)

If set, only people who have registered for events

eligibility_criteria.​expressionstring(Expression)

The expression

eligibility_criteria.​expression_error_messagestring(Expression Error Message)

The error message to show when the expression fails

eligibility_criteria.​locationLocation (object)(Location)
One of:
eligibility_criteria.​logic_operatorstring(Logic Operator)
Enum"and""not"
eligibility_criteria.​member_optionsMember Options (object)(Member Options)
One of:
eligibility_criteria.​membersboolean(Members)

If set, active members can purchase this

eligibility_criteria.​non_membersboolean(Non Members)

If set, only nonmembers can purchase

eligibility_criteria.​organization_restrictionsobject(Organization Restrictions)
eligibility_criteria.​status_restrictionsArray of Status Restrictions (strings)(Status Restrictions)non-empty

The statuses

One of:

The statuses

non-empty
eligibility_criteria.​use_organization_for_eligibilityboolean(Use Organization For Eligibility)

If checked, a person's organization is used to check for eligibility, rather than the person themselves

enable_commentsboolean(Enable Comments)

If set, users are allowed to submit comments in the directory

enable_custom_search_results_templateboolean(Enable Custom Search Results Template)

If set, a custom search results template is displayed

enable_custom_sortingboolean(Enable Custom Sorting)

If true, the directory results will be sorted differently that the query

enable_eligibility_criteriaboolean(Enable Eligibility Criteria)

If set, only certain people can access this directory

enable_messagingboolean(Enable Messaging)

When true, users are able to contact other users through the directory

enable_query_expression_filterboolean(Enable Query Expression Filter)

If set to true, an expression can be used to further filter the query

enable_query_filterboolean(Enable Query Filter)

If set to true, the directory can display a subset of records based on the provided filter. If false, the default filter is used

enable_radius_searchboolean(Enable Radius Search)

If true, the user can search across zip code radius

idstring(ID)^[\w|-]+$required

The unique, string identifier of this contact directory

is_activeboolean(Is Active)

Whether or not this directory is active

is_publicboolean(Is Public)

If true, this is a public directory that can be accessed without security

namestring(Name)required

The name of the contact directory

page_sizenumber(float)(Page Size)[ 1 .. 50 ]

The page size, used for server side page and to combat scraping attacks

query_filter_expressionstring(Query Filter Expression)required

The expression to use to filter the directory

query_filter_rulesobject(Query Filter Rules)
radius_search_optionsobject(Radius Search Options)required
radius_search_options.​postal_code_fieldstring(Postal Code Field)required

The field to use as the basis for a radius search

radius_search_options.​radius_optionsArray of numbers(float)(Radius Options)non-emptyrequired

The various default radius that can be selected

refresh_periodnumber(float)(Refresh Period)>= 5

The period of time (in minutes) after which the directory should refresh it self

searchable_fieldsArray of objectsnon-emptyrequired

The fields in the directory that are displayed as search criteria

searchable_fields[].​group_namestring(Group Name)

The group/display label

searchable_fields[].​labelstring(Label)

The label that the field should be displayed

searchable_fields[].​namestring(Name)required

The field name

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_fields": [
    "string"
  ],
  "comment_options": {
    "comments_header_text": "string",
    "comments_instructions": "string",
    "comments_placeholder_text": "string",
    "enable_ratings": true,
    "hide_submitter_name": true,
    "leave_comment_button_text": "string",
    "max_rating": null,
    "no_comments_text": "string",
    "rating_label": "string",
    "save_comment_button": "string"
  },
  "custom_directory_entry_template": "string",
  "custom_search_results_template": "string",
  "custom_sort_fields": [
    { … }
  ],
  "directory_entry_mode": "custom",
  "display_mode": "list",
  "eligibility_criteria": {
    "advanced_rule_error_message": "string",
    "advanced_rules": {},
    "age_restrictions": { … },
    "award_options": { … },
    "award_recipients": true,
    "by_location": true,
    "certificants": true,
    "certification_options": { … },
    "committee_member_options": { … },
    "committee_members": true,
    "custom_logic_options": { … },
    "customer_type": "contact",
    "donor_options": { … },
    "donors": true,
    "enable_advanced_rules": true,
    "enable_age_restrictions": true,
    "enable_custom_logic": true,
    "enable_entitlement_restrictions": true,
    "enable_expression": true,
    "enable_organization_restrictions": true,
    "enable_status_restriction": true,
    "entitlement_restrictions": [ … ],
    "event_registration_options": { … },
    "event_registrations": true,
    "expression": "string",
    "expression_error_message": "string",
    "location": { … },
    "logic_operator": "and",
    "member_options": { … },
    "members": true,
    "non_members": true,
    "organization_restrictions": { … },
    "status_restrictions": { … },
    "use_organization_for_eligibility": true
  },
  "enable_comments": true,
  "enable_custom_search_results_template": true,
  "enable_custom_sorting": true,
  "enable_eligibility_criteria": true,
  "enable_messaging": true,
  "enable_query_expression_filter": true,
  "enable_query_filter": true,
  "enable_radius_search": true,
  "id": "string",
  "is_active": true,
  "is_public": true,
  "name": "string",
  "page_size": 1,
  "query_filter_expression": "string",
  "query_filter_rules": {},
  "radius_search_options": {
    "postal_code_field": "string",
    "radius_options": [ … ]
  },
  "refresh_period": 5,
  "searchable_fields": [
    { … }
  ],
  "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 contact directory with the specified ID.

Request

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

Path
tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the contact directory to patch.

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

Responses

The contact directory was patched successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
additional_fieldsArray of strings(Additional Fields)

These are additional fields that should be in the directory query, which will be available in the search results

comment_optionsobject(Comment Options)
custom_directory_entry_templatestring(Custom Directory Entry Template)required
custom_search_results_templatestring(Custom Search Results Template)required
custom_sort_fieldsArray of objectsnon-emptyrequired
custom_sort_fields[].​descendingboolean(Descending)
custom_sort_fields[].​namestring(Name)required
directory_entry_modestring(Directory Entry Mode)
Enum"custom""do not show""use default"
display_modestring(Display Mode)

The way that the directory should be displayed

Enum"list""search"
eligibility_criteriaobject(Eligibility Criteria)required

The criteria to use

eligibility_criteria.​advanced_rule_error_messagestring(Advanced Rule Error Message)

The error message to show when the advanced rule fails

eligibility_criteria.​advanced_rulesobject(Advanced Rules)
eligibility_criteria.​age_restrictionsobject(Age Restrictions)
eligibility_criteria.​award_optionsobject(Award Options)
eligibility_criteria.​award_recipientsboolean(Award Recipients)

If set, only people who have received awards

eligibility_criteria.​by_locationboolean(By Location)

If true, then filter by location

eligibility_criteria.​certificantsboolean(Certificants)

If set, only people with specific certifications

eligibility_criteria.​certification_optionsCertification Options (object)(Certification Options)
One of:
eligibility_criteria.​committee_member_optionsCommittee Member Options (object)(Committee Member Options)
One of:
eligibility_criteria.​committee_membersboolean(Committee Members)

If set, active members who belong to a committee can purchase

eligibility_criteria.​custom_logic_optionsCustom Logic Options (object)(Custom Logic Options)
One of:
eligibility_criteria.​customer_typestring(Customer Type)
Enum"contact""organization"
eligibility_criteria.​donor_optionsobject(Donor Options)
eligibility_criteria.​donorsboolean(Donors)

If true, only donors

eligibility_criteria.​enable_advanced_rulesboolean(Enable Advanced Rules)

Enable advanced JSON rules

eligibility_criteria.​enable_age_restrictionsboolean(Enable Age Restrictions)

Age registrations

eligibility_criteria.​enable_custom_logicboolean(Enable Custom Logic)

If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion

eligibility_criteria.​enable_entitlement_restrictionsboolean(Enable Entitlement Restrictions)

If set, then you must have certain entitlements

eligibility_criteria.​enable_expressionboolean(Enable Expression)

Whether or not to enable an expression for evaluation

eligibility_criteria.​enable_organization_restrictionsboolean(Enable Organization Restrictions)

If set, you can restrict organizations

eligibility_criteria.​enable_status_restrictionboolean(Enable Status Restriction)

If set, you can restrict by status

eligibility_criteria.​entitlement_restrictionsArray of objects
eligibility_criteria.​event_registration_optionsobject(Event Registration Options)
eligibility_criteria.​event_registrationsboolean(Event Registrations)

If set, only people who have registered for events

eligibility_criteria.​expressionstring(Expression)

The expression

eligibility_criteria.​expression_error_messagestring(Expression Error Message)

The error message to show when the expression fails

eligibility_criteria.​locationLocation (object)(Location)
One of:
eligibility_criteria.​logic_operatorstring(Logic Operator)
Enum"and""not"
eligibility_criteria.​member_optionsMember Options (object)(Member Options)
One of:
eligibility_criteria.​membersboolean(Members)

If set, active members can purchase this

eligibility_criteria.​non_membersboolean(Non Members)

If set, only nonmembers can purchase

eligibility_criteria.​organization_restrictionsobject(Organization Restrictions)
eligibility_criteria.​status_restrictionsArray of Status Restrictions (strings)(Status Restrictions)non-empty

The statuses

One of:

The statuses

non-empty
eligibility_criteria.​use_organization_for_eligibilityboolean(Use Organization For Eligibility)

If checked, a person's organization is used to check for eligibility, rather than the person themselves

enable_commentsboolean(Enable Comments)

If set, users are allowed to submit comments in the directory

enable_custom_search_results_templateboolean(Enable Custom Search Results Template)

If set, a custom search results template is displayed

enable_custom_sortingboolean(Enable Custom Sorting)

If true, the directory results will be sorted differently that the query

enable_eligibility_criteriaboolean(Enable Eligibility Criteria)

If set, only certain people can access this directory

enable_messagingboolean(Enable Messaging)

When true, users are able to contact other users through the directory

enable_query_expression_filterboolean(Enable Query Expression Filter)

If set to true, an expression can be used to further filter the query

enable_query_filterboolean(Enable Query Filter)

If set to true, the directory can display a subset of records based on the provided filter. If false, the default filter is used

enable_radius_searchboolean(Enable Radius Search)

If true, the user can search across zip code radius

idstring(ID)^[\w|-]+$required

The unique, string identifier of this contact directory

is_activeboolean(Is Active)

Whether or not this directory is active

is_publicboolean(Is Public)

If true, this is a public directory that can be accessed without security

namestring(Name)required

The name of the contact directory

page_sizenumber(float)(Page Size)[ 1 .. 50 ]

The page size, used for server side page and to combat scraping attacks

query_filter_expressionstring(Query Filter Expression)required

The expression to use to filter the directory

query_filter_rulesobject(Query Filter Rules)
radius_search_optionsobject(Radius Search Options)required
radius_search_options.​postal_code_fieldstring(Postal Code Field)required

The field to use as the basis for a radius search

radius_search_options.​radius_optionsArray of numbers(float)(Radius Options)non-emptyrequired

The various default radius that can be selected

refresh_periodnumber(float)(Refresh Period)>= 5

The period of time (in minutes) after which the directory should refresh it self

searchable_fieldsArray of objectsnon-emptyrequired

The fields in the directory that are displayed as search criteria

searchable_fields[].​group_namestring(Group Name)

The group/display label

searchable_fields[].​labelstring(Label)

The label that the field should be displayed

searchable_fields[].​namestring(Name)required

The field name

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_fields": [
    "string"
  ],
  "comment_options": {
    "comments_header_text": "string",
    "comments_instructions": "string",
    "comments_placeholder_text": "string",
    "enable_ratings": true,
    "hide_submitter_name": true,
    "leave_comment_button_text": "string",
    "max_rating": null,
    "no_comments_text": "string",
    "rating_label": "string",
    "save_comment_button": "string"
  },
  "custom_directory_entry_template": "string",
  "custom_search_results_template": "string",
  "custom_sort_fields": [
    { … }
  ],
  "directory_entry_mode": "custom",
  "display_mode": "list",
  "eligibility_criteria": {
    "advanced_rule_error_message": "string",
    "advanced_rules": {},
    "age_restrictions": { … },
    "award_options": { … },
    "award_recipients": true,
    "by_location": true,
    "certificants": true,
    "certification_options": { … },
    "committee_member_options": { … },
    "committee_members": true,
    "custom_logic_options": { … },
    "customer_type": "contact",
    "donor_options": { … },
    "donors": true,
    "enable_advanced_rules": true,
    "enable_age_restrictions": true,
    "enable_custom_logic": true,
    "enable_entitlement_restrictions": true,
    "enable_expression": true,
    "enable_organization_restrictions": true,
    "enable_status_restriction": true,
    "entitlement_restrictions": [ … ],
    "event_registration_options": { … },
    "event_registrations": true,
    "expression": "string",
    "expression_error_message": "string",
    "location": { … },
    "logic_operator": "and",
    "member_options": { … },
    "members": true,
    "non_members": true,
    "organization_restrictions": { … },
    "status_restrictions": { … },
    "use_organization_for_eligibility": true
  },
  "enable_comments": true,
  "enable_custom_search_results_template": true,
  "enable_custom_sorting": true,
  "enable_eligibility_criteria": true,
  "enable_messaging": true,
  "enable_query_expression_filter": true,
  "enable_query_filter": true,
  "enable_radius_search": true,
  "id": "string",
  "is_active": true,
  "is_public": true,
  "name": "string",
  "page_size": 1,
  "query_filter_expression": "string",
  "query_filter_rules": {},
  "radius_search_options": {
    "postal_code_field": "string",
    "radius_options": [ … ]
  },
  "refresh_period": 5,
  "searchable_fields": [
    { … }
  ],
  "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 contact directory with the specified ID.

Request

This method will update an existing contact directory with the specified ID.

Path
tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the contact directory to update.

Bodyapplication/jsonrequired

The updated contact directory that will be saved.

additional_fieldsArray of strings(Additional Fields)

These are additional fields that should be in the directory query, which will be available in the search results

comment_optionsobject(Comment Options)
custom_directory_entry_templatestring(Custom Directory Entry Template)required
custom_search_results_templatestring(Custom Search Results Template)required
custom_sort_fieldsArray of objectsnon-emptyrequired
custom_sort_fields[].​descendingboolean(Descending)
custom_sort_fields[].​namestring(Name)required
directory_entry_modestring(Directory Entry Mode)
Enum"custom""do not show""use default"
display_modestring(Display Mode)

The way that the directory should be displayed

Enum"list""search"
eligibility_criteriaobject(Eligibility Criteria)required

The criteria to use

eligibility_criteria.​advanced_rule_error_messagestring(Advanced Rule Error Message)

The error message to show when the advanced rule fails

eligibility_criteria.​advanced_rulesobject(Advanced Rules)
eligibility_criteria.​age_restrictionsobject(Age Restrictions)
eligibility_criteria.​award_optionsobject(Award Options)
eligibility_criteria.​award_recipientsboolean(Award Recipients)

If set, only people who have received awards

eligibility_criteria.​by_locationboolean(By Location)

If true, then filter by location

eligibility_criteria.​certificantsboolean(Certificants)

If set, only people with specific certifications

eligibility_criteria.​certification_optionsCertification Options (object)(Certification Options)
One of:
eligibility_criteria.​committee_member_optionsCommittee Member Options (object)(Committee Member Options)
One of:
eligibility_criteria.​committee_membersboolean(Committee Members)

If set, active members who belong to a committee can purchase

eligibility_criteria.​custom_logic_optionsCustom Logic Options (object)(Custom Logic Options)
One of:
eligibility_criteria.​customer_typestring(Customer Type)
Enum"contact""organization"
eligibility_criteria.​donor_optionsobject(Donor Options)
eligibility_criteria.​donorsboolean(Donors)

If true, only donors

eligibility_criteria.​enable_advanced_rulesboolean(Enable Advanced Rules)

Enable advanced JSON rules

eligibility_criteria.​enable_age_restrictionsboolean(Enable Age Restrictions)

Age registrations

eligibility_criteria.​enable_custom_logicboolean(Enable Custom Logic)

If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion

eligibility_criteria.​enable_entitlement_restrictionsboolean(Enable Entitlement Restrictions)

If set, then you must have certain entitlements

eligibility_criteria.​enable_expressionboolean(Enable Expression)

Whether or not to enable an expression for evaluation

eligibility_criteria.​enable_organization_restrictionsboolean(Enable Organization Restrictions)

If set, you can restrict organizations

eligibility_criteria.​enable_status_restrictionboolean(Enable Status Restriction)

If set, you can restrict by status

eligibility_criteria.​entitlement_restrictionsArray of objects
eligibility_criteria.​event_registration_optionsobject(Event Registration Options)
eligibility_criteria.​event_registrationsboolean(Event Registrations)

If set, only people who have registered for events

eligibility_criteria.​expressionstring(Expression)

The expression

eligibility_criteria.​expression_error_messagestring(Expression Error Message)

The error message to show when the expression fails

eligibility_criteria.​locationLocation (object)(Location)
One of:
eligibility_criteria.​logic_operatorstring(Logic Operator)
Enum"and""not"
eligibility_criteria.​member_optionsMember Options (object)(Member Options)
One of:
eligibility_criteria.​membersboolean(Members)

If set, active members can purchase this

eligibility_criteria.​non_membersboolean(Non Members)

If set, only nonmembers can purchase

eligibility_criteria.​organization_restrictionsobject(Organization Restrictions)
eligibility_criteria.​status_restrictionsArray of Status Restrictions (strings)(Status Restrictions)non-empty

The statuses

One of:

The statuses

non-empty
eligibility_criteria.​use_organization_for_eligibilityboolean(Use Organization For Eligibility)

If checked, a person's organization is used to check for eligibility, rather than the person themselves

enable_commentsboolean(Enable Comments)

If set, users are allowed to submit comments in the directory

enable_custom_search_results_templateboolean(Enable Custom Search Results Template)

If set, a custom search results template is displayed

enable_custom_sortingboolean(Enable Custom Sorting)

If true, the directory results will be sorted differently that the query

enable_eligibility_criteriaboolean(Enable Eligibility Criteria)

If set, only certain people can access this directory

enable_messagingboolean(Enable Messaging)

When true, users are able to contact other users through the directory

enable_query_expression_filterboolean(Enable Query Expression Filter)

If set to true, an expression can be used to further filter the query

enable_query_filterboolean(Enable Query Filter)

If set to true, the directory can display a subset of records based on the provided filter. If false, the default filter is used

enable_radius_searchboolean(Enable Radius Search)

If true, the user can search across zip code radius

idstring(ID)^[\w|-]+$required

The unique, string identifier of this contact directory

is_activeboolean(Is Active)

Whether or not this directory is active

is_publicboolean(Is Public)

If true, this is a public directory that can be accessed without security

namestring(Name)required

The name of the contact directory

page_sizenumber(float)(Page Size)[ 1 .. 50 ]

The page size, used for server side page and to combat scraping attacks

query_filter_expressionstring(Query Filter Expression)required

The expression to use to filter the directory

query_filter_rulesobject(Query Filter Rules)
radius_search_optionsobject(Radius Search Options)required
radius_search_options.​postal_code_fieldstring(Postal Code Field)required

The field to use as the basis for a radius search

radius_search_options.​radius_optionsArray of numbers(float)(Radius Options)non-emptyrequired

The various default radius that can be selected

refresh_periodnumber(float)(Refresh Period)>= 5

The period of time (in minutes) after which the directory should refresh it self

searchable_fieldsArray of objectsnon-emptyrequired

The fields in the directory that are displayed as search criteria

searchable_fields[].​group_namestring(Group Name)

The group/display label

searchable_fields[].​labelstring(Label)

The label that the field should be displayed

searchable_fields[].​namestring(Name)required

The field name

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/contactDirectories/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "additional_fields": [
      "string"
    ],
    "comment_options": {
      "comments_header_text": "string",
      "comments_instructions": "string",
      "comments_placeholder_text": "string",
      "enable_ratings": true,
      "hide_submitter_name": true,
      "leave_comment_button_text": "string",
      "max_rating": null,
      "no_comments_text": "string",
      "rating_label": "string",
      "save_comment_button": "string"
    },
    "custom_directory_entry_template": "string",
    "custom_search_results_template": "string",
    "custom_sort_fields": [
      {
        "descending": true,
        "name": "string"
      }
    ],
    "directory_entry_mode": "custom",
    "display_mode": "list",
    "eligibility_criteria": {
      "advanced_rule_error_message": "string",
      "advanced_rules": {},
      "age_restrictions": {
        "maximum_age": 0.1,
        "minimum_age": 0.1
      },
      "award_options": {
        "award_ids": [
          "string"
        ],
        "award_type_ids": [
          "string"
        ],
        "logic_operator": "and"
      },
      "award_recipients": true,
      "by_location": true,
      "certificants": true,
      "certification_options": {
        "logic_operator": "and",
        "program_ids": [
          "string"
        ]
      },
      "committee_member_options": {
        "committee_ids": [
          "string"
        ],
        "committee_position_ids": [
          "string"
        ],
        "committee_type_ids": [
          "string"
        ],
        "logic_operator": "and"
      },
      "committee_members": true,
      "custom_logic_options": {
        "lambda_function_id": "string"
      },
      "customer_type": "contact",
      "donor_options": {
        "donor_club_ids": [
          "string"
        ],
        "logic_operator": "and"
      },
      "donors": true,
      "enable_advanced_rules": true,
      "enable_age_restrictions": true,
      "enable_custom_logic": true,
      "enable_entitlement_restrictions": true,
      "enable_expression": true,
      "enable_organization_restrictions": true,
      "enable_status_restriction": true,
      "entitlement_restrictions": [
        {
          "quantity": 0.1,
          "type_id": "string"
        }
      ],
      "event_registration_options": {
        "event_ids": [
          "string"
        ],
        "logic_operator": "and",
        "registration_category_ids": [
          "string"
        ]
      },
      "event_registrations": true,
      "expression": "string",
      "expression_error_message": "string",
      "location": {
        "countries": [
          "string"
        ],
        "negate_logic": true
      },
      "logic_operator": "and",
      "member_options": {
        "chapter_member_options": {
          "chapter_ids": [
            "string"
          ],
          "chapter_type_ids": [
            "string"
          ],
          "logic_operator": "and"
        },
        "chapter_members": true,
        "member_package_ids": [
          "string"
        ],
        "member_status_reason_ids": [
          "string"
        ],
        "member_statuses": [
          "active"
        ],
        "member_type_ids": [
          "string"
        ],
        "section_member_options": {
          "logic_operator": "and",
          "section_ids": [
            "string"
          ],
          "section_type_ids": [
            "string"
          ]
        },
        "section_members": true
      },
      "members": true,
      "non_members": true,
      "organization_restrictions": {
        "contact_role_ids": [
          "string"
        ],
        "organization_type_ids": [
          "string"
        ]
      },
      "status_restrictions": {
        "0": "string"
      },
      "use_organization_for_eligibility": true
    },
    "enable_comments": true,
    "enable_custom_search_results_template": true,
    "enable_custom_sorting": true,
    "enable_eligibility_criteria": true,
    "enable_messaging": true,
    "enable_query_expression_filter": true,
    "enable_query_filter": true,
    "enable_radius_search": true,
    "id": "string",
    "is_active": true,
    "is_public": true,
    "name": "string",
    "page_size": 1,
    "query_filter_expression": "string",
    "query_filter_rules": {},
    "radius_search_options": {
      "postal_code_field": "string",
      "radius_options": [
        0.1
      ]
    },
    "refresh_period": 5,
    "searchable_fields": [
      {
        "group_name": "string",
        "label": "string",
        "name": "string"
      }
    ],
    "sys_bulk_load_at": "string",
    "sys_bulk_load_id": "string",
    "sys_bulk_load_pk": "string",
    "sys_bulk_load_record_no": 0.1,
    "sys_bulk_load_source_file": "string",
    "sys_calculated_field_error": "string",
    "sys_calculated_field_errors": [
      {
        "error": "string",
        "field": "string"
      }
    ],
    "sys_configuration_snapshot_id": "string",
    "sys_created_at": "2019-08-24T14:15:22Z",
    "sys_created_by_id": "string",
    "sys_deleted_by_id": "string",
    "sys_directive": "string",
    "sys_external_id": "string",
    "sys_has_files_in_s3": true,
    "sys_last_bulk_data_operation_id": "string",
    "sys_last_bulk_data_operation_sys_version": "string",
    "sys_last_modified_at": "2019-08-24T14:15:22Z",
    "sys_last_modified_by_id": "string",
    "sys_last_security_context": {},
    "sys_locked": true,
    "sys_snapshot_base_version": 0.1,
    "sys_version": 0.1
  }'

Responses

The contact directory was updated successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
additional_fieldsArray of strings(Additional Fields)

These are additional fields that should be in the directory query, which will be available in the search results

comment_optionsobject(Comment Options)
custom_directory_entry_templatestring(Custom Directory Entry Template)required
custom_search_results_templatestring(Custom Search Results Template)required
custom_sort_fieldsArray of objectsnon-emptyrequired
custom_sort_fields[].​descendingboolean(Descending)
custom_sort_fields[].​namestring(Name)required
directory_entry_modestring(Directory Entry Mode)
Enum"custom""do not show""use default"
display_modestring(Display Mode)

The way that the directory should be displayed

Enum"list""search"
eligibility_criteriaobject(Eligibility Criteria)required

The criteria to use

eligibility_criteria.​advanced_rule_error_messagestring(Advanced Rule Error Message)

The error message to show when the advanced rule fails

eligibility_criteria.​advanced_rulesobject(Advanced Rules)
eligibility_criteria.​age_restrictionsobject(Age Restrictions)
eligibility_criteria.​award_optionsobject(Award Options)
eligibility_criteria.​award_recipientsboolean(Award Recipients)

If set, only people who have received awards

eligibility_criteria.​by_locationboolean(By Location)

If true, then filter by location

eligibility_criteria.​certificantsboolean(Certificants)

If set, only people with specific certifications

eligibility_criteria.​certification_optionsCertification Options (object)(Certification Options)
One of:
eligibility_criteria.​committee_member_optionsCommittee Member Options (object)(Committee Member Options)
One of:
eligibility_criteria.​committee_membersboolean(Committee Members)

If set, active members who belong to a committee can purchase

eligibility_criteria.​custom_logic_optionsCustom Logic Options (object)(Custom Logic Options)
One of:
eligibility_criteria.​customer_typestring(Customer Type)
Enum"contact""organization"
eligibility_criteria.​donor_optionsobject(Donor Options)
eligibility_criteria.​donorsboolean(Donors)

If true, only donors

eligibility_criteria.​enable_advanced_rulesboolean(Enable Advanced Rules)

Enable advanced JSON rules

eligibility_criteria.​enable_age_restrictionsboolean(Enable Age Restrictions)

Age registrations

eligibility_criteria.​enable_custom_logicboolean(Enable Custom Logic)

If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion

eligibility_criteria.​enable_entitlement_restrictionsboolean(Enable Entitlement Restrictions)

If set, then you must have certain entitlements

eligibility_criteria.​enable_expressionboolean(Enable Expression)

Whether or not to enable an expression for evaluation

eligibility_criteria.​enable_organization_restrictionsboolean(Enable Organization Restrictions)

If set, you can restrict organizations

eligibility_criteria.​enable_status_restrictionboolean(Enable Status Restriction)

If set, you can restrict by status

eligibility_criteria.​entitlement_restrictionsArray of objects
eligibility_criteria.​event_registration_optionsobject(Event Registration Options)
eligibility_criteria.​event_registrationsboolean(Event Registrations)

If set, only people who have registered for events

eligibility_criteria.​expressionstring(Expression)

The expression

eligibility_criteria.​expression_error_messagestring(Expression Error Message)

The error message to show when the expression fails

eligibility_criteria.​locationLocation (object)(Location)
One of:
eligibility_criteria.​logic_operatorstring(Logic Operator)
Enum"and""not"
eligibility_criteria.​member_optionsMember Options (object)(Member Options)
One of:
eligibility_criteria.​membersboolean(Members)

If set, active members can purchase this

eligibility_criteria.​non_membersboolean(Non Members)

If set, only nonmembers can purchase

eligibility_criteria.​organization_restrictionsobject(Organization Restrictions)
eligibility_criteria.​status_restrictionsArray of Status Restrictions (strings)(Status Restrictions)non-empty

The statuses

One of:

The statuses

non-empty
eligibility_criteria.​use_organization_for_eligibilityboolean(Use Organization For Eligibility)

If checked, a person's organization is used to check for eligibility, rather than the person themselves

enable_commentsboolean(Enable Comments)

If set, users are allowed to submit comments in the directory

enable_custom_search_results_templateboolean(Enable Custom Search Results Template)

If set, a custom search results template is displayed

enable_custom_sortingboolean(Enable Custom Sorting)

If true, the directory results will be sorted differently that the query

enable_eligibility_criteriaboolean(Enable Eligibility Criteria)

If set, only certain people can access this directory

enable_messagingboolean(Enable Messaging)

When true, users are able to contact other users through the directory

enable_query_expression_filterboolean(Enable Query Expression Filter)

If set to true, an expression can be used to further filter the query

enable_query_filterboolean(Enable Query Filter)

If set to true, the directory can display a subset of records based on the provided filter. If false, the default filter is used

enable_radius_searchboolean(Enable Radius Search)

If true, the user can search across zip code radius

idstring(ID)^[\w|-]+$required

The unique, string identifier of this contact directory

is_activeboolean(Is Active)

Whether or not this directory is active

is_publicboolean(Is Public)

If true, this is a public directory that can be accessed without security

namestring(Name)required

The name of the contact directory

page_sizenumber(float)(Page Size)[ 1 .. 50 ]

The page size, used for server side page and to combat scraping attacks

query_filter_expressionstring(Query Filter Expression)required

The expression to use to filter the directory

query_filter_rulesobject(Query Filter Rules)
radius_search_optionsobject(Radius Search Options)required
radius_search_options.​postal_code_fieldstring(Postal Code Field)required

The field to use as the basis for a radius search

radius_search_options.​radius_optionsArray of numbers(float)(Radius Options)non-emptyrequired

The various default radius that can be selected

refresh_periodnumber(float)(Refresh Period)>= 5

The period of time (in minutes) after which the directory should refresh it self

searchable_fieldsArray of objectsnon-emptyrequired

The fields in the directory that are displayed as search criteria

searchable_fields[].​group_namestring(Group Name)

The group/display label

searchable_fields[].​labelstring(Label)

The label that the field should be displayed

searchable_fields[].​namestring(Name)required

The field name

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_fields": [
    "string"
  ],
  "comment_options": {
    "comments_header_text": "string",
    "comments_instructions": "string",
    "comments_placeholder_text": "string",
    "enable_ratings": true,
    "hide_submitter_name": true,
    "leave_comment_button_text": "string",
    "max_rating": null,
    "no_comments_text": "string",
    "rating_label": "string",
    "save_comment_button": "string"
  },
  "custom_directory_entry_template": "string",
  "custom_search_results_template": "string",
  "custom_sort_fields": [
    { … }
  ],
  "directory_entry_mode": "custom",
  "display_mode": "list",
  "eligibility_criteria": {
    "advanced_rule_error_message": "string",
    "advanced_rules": {},
    "age_restrictions": { … },
    "award_options": { … },
    "award_recipients": true,
    "by_location": true,
    "certificants": true,
    "certification_options": { … },
    "committee_member_options": { … },
    "committee_members": true,
    "custom_logic_options": { … },
    "customer_type": "contact",
    "donor_options": { … },
    "donors": true,
    "enable_advanced_rules": true,
    "enable_age_restrictions": true,
    "enable_custom_logic": true,
    "enable_entitlement_restrictions": true,
    "enable_expression": true,
    "enable_organization_restrictions": true,
    "enable_status_restriction": true,
    "entitlement_restrictions": [ … ],
    "event_registration_options": { … },
    "event_registrations": true,
    "expression": "string",
    "expression_error_message": "string",
    "location": { … },
    "logic_operator": "and",
    "member_options": { … },
    "members": true,
    "non_members": true,
    "organization_restrictions": { … },
    "status_restrictions": { … },
    "use_organization_for_eligibility": true
  },
  "enable_comments": true,
  "enable_custom_search_results_template": true,
  "enable_custom_sorting": true,
  "enable_eligibility_criteria": true,
  "enable_messaging": true,
  "enable_query_expression_filter": true,
  "enable_query_filter": true,
  "enable_radius_search": true,
  "id": "string",
  "is_active": true,
  "is_public": true,
  "name": "string",
  "page_size": 1,
  "query_filter_expression": "string",
  "query_filter_rules": {},
  "radius_search_options": {
    "postal_code_field": "string",
    "radius_options": [ … ]
  },
  "refresh_period": 5,
  "searchable_fields": [
    { … }
  ],
  "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
}

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

Statistics

Statistics

Operations