Rolodex

Execute Batch Operations

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

Servers

Mock server

https://docs.api.rhythmsoftware.com/_mock/apis/rolodex/rolodex-v1/

https://rolodex.api.rhythmsoftware.com/

Account Delegation Processes

Operations

Address Types

Operations

Communication Types

Operations

Contact Directories

Operations

Contact Districts

Operations

Contact Duplicates

Operations

Contact Login Profiles

Operations

Contact Role Rule Sets

Operations

Contact Roles

Operations

Contacts

Operations

Custom Activities

Operations

Custom Activity Types

Operations

Custom Engagement Metrics

Operations

Engagement Categories

Operations

Engagement Models

Operations

Gets all of the engagement models in the system.

Request

This method will scan all engagement models 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/engagementModels/{tenantId}?exclusiveStartKey=string&fields=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The engagement modelswere retrieved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/jsonArray [

componentsArray of objects

enable_engagement_categoriesboolean(Enable Engagement Categories)

If true, contacts are assigned categories based on engagement scores

engagement_category_rulesArray of objectsnon-emptyrequired

engagement_category_rules[].category_idstring(Category)required

The engagement category

engagement_category_rules[].maximum_percentile_ranknumber(float)(Maximum Percentile Rank)

Maximum percentile rank to match this rule

engagement_category_rules[].maximum_scorenumber(float)(Maximum Score)required

Maximum score to match this rule

engagement_category_rules[].minimum_percentile_ranknumber(float)(Minimum Percentile Rank)

Minimum percentile rank to match this rule

engagement_category_rules[].minimum_scorenumber(float)(Minimum Score)required

Minimum score to match this rule

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

The unique, string identifier of this engagement model

is_activeboolean(Is Active)

Whether or not the model is active

namestring(Name)required

The name of the engagement model

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

typestring(Type)

The target of this engagement model

Enum"contact""organization"

]

Response

application/json

[
  {
    "components": [ … ],
    "enable_engagement_categories": true,
    "engagement_category_rules": [ … ],
    "id": "string",
    "is_active": true,
    "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": [ … ],
    "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,
    "type": "contact"
  }
]

Creates a new engagement model record that does not already exist.

Request

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

Path

tenantIdstringrequired

The id of the tenant being accessed.

Bodyapplication/jsonrequired

The engagement model that you would like to be saved.

componentsArray of objects

enable_engagement_categoriesboolean(Enable Engagement Categories)

If true, contacts are assigned categories based on engagement scores

engagement_category_rulesArray of objectsnon-emptyrequired

engagement_category_rules[].category_idstring(Category)required

The engagement category

engagement_category_rules[].maximum_percentile_ranknumber(float)(Maximum Percentile Rank)

Maximum percentile rank to match this rule

engagement_category_rules[].maximum_scorenumber(float)(Maximum Score)required

Maximum score to match this rule

engagement_category_rules[].minimum_percentile_ranknumber(float)(Minimum Percentile Rank)

Minimum percentile rank to match this rule

engagement_category_rules[].minimum_scorenumber(float)(Minimum Score)required

Minimum score to match this rule

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

The unique, string identifier of this engagement model

is_activeboolean(Is Active)

Whether or not the model is active

namestring(Name)required

The name of the engagement model

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

typestring(Type)

The target of this engagement model

Enum"contact""organization"

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/rolodex/rolodex-v1/engagementModels/{tenantId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "components": [
      {
        "custom_metric_id": null,
        "metric_rules": [
          {
            "ending_range": 0.1,
            "points": 100,
            "starting_range": 0.1
          }
        ],
        "metric_type": "custom",
        "name": "string",
        "system_metric": null,
        "weight": 1
      }
    ],
    "enable_engagement_categories": true,
    "engagement_category_rules": [
      {
        "category_id": "string",
        "maximum_percentile_rank": 0.1,
        "maximum_score": 0.1,
        "minimum_percentile_rank": 0.1,
        "minimum_score": 0.1
      }
    ],
    "id": "string",
    "is_active": true,
    "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,
    "type": "contact"
  }'

Responses

The engagement model was saved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

componentsArray of objects

enable_engagement_categoriesboolean(Enable Engagement Categories)

If true, contacts are assigned categories based on engagement scores

engagement_category_rulesArray of objectsnon-emptyrequired

engagement_category_rules[].category_idstring(Category)required

The engagement category

engagement_category_rules[].maximum_percentile_ranknumber(float)(Maximum Percentile Rank)

Maximum percentile rank to match this rule

engagement_category_rules[].maximum_scorenumber(float)(Maximum Score)required

Maximum score to match this rule

engagement_category_rules[].minimum_percentile_ranknumber(float)(Minimum Percentile Rank)

Minimum percentile rank to match this rule

engagement_category_rules[].minimum_scorenumber(float)(Minimum Score)required

Minimum score to match this rule

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

The unique, string identifier of this engagement model

is_activeboolean(Is Active)

Whether or not the model is active

namestring(Name)required

The name of the engagement model

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

typestring(Type)

The target of this engagement model

Enum"contact""organization"

Response

application/json

{
  "components": [
    { … }
  ],
  "enable_engagement_categories": true,
  "engagement_category_rules": [
    { … }
  ],
  "id": "string",
  "is_active": true,
  "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": [
    { … }
  ],
  "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,
  "type": "contact"
}

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/engagementModels/{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
}

Returns a engagement model from the system by its ID.

Request

This method will delete a engagement model with the specified ID.

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the engagement model to delete.

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

Responses

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

Request

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

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the engagement model 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/engagementModels/{tenantId}/{id}?consistentRead=string&fields=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The engagement model was retrieved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

componentsArray of objects

enable_engagement_categoriesboolean(Enable Engagement Categories)

If true, contacts are assigned categories based on engagement scores

engagement_category_rulesArray of objectsnon-emptyrequired

engagement_category_rules[].category_idstring(Category)required

The engagement category

engagement_category_rules[].maximum_percentile_ranknumber(float)(Maximum Percentile Rank)

Maximum percentile rank to match this rule

engagement_category_rules[].maximum_scorenumber(float)(Maximum Score)required

Maximum score to match this rule

engagement_category_rules[].minimum_percentile_ranknumber(float)(Minimum Percentile Rank)

Minimum percentile rank to match this rule

engagement_category_rules[].minimum_scorenumber(float)(Minimum Score)required

Minimum score to match this rule

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

The unique, string identifier of this engagement model

is_activeboolean(Is Active)

Whether or not the model is active

namestring(Name)required

The name of the engagement model

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

typestring(Type)

The target of this engagement model

Enum"contact""organization"

Response

application/json

{
  "components": [
    { … }
  ],
  "enable_engagement_categories": true,
  "engagement_category_rules": [
    { … }
  ],
  "id": "string",
  "is_active": true,
  "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": [
    { … }
  ],
  "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,
  "type": "contact"
}

Partially updates a engagement model with the specified ID.

Request

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

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

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

Responses

The engagement model was patched successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

componentsArray of objects

enable_engagement_categoriesboolean(Enable Engagement Categories)

If true, contacts are assigned categories based on engagement scores

engagement_category_rulesArray of objectsnon-emptyrequired

engagement_category_rules[].category_idstring(Category)required

The engagement category

engagement_category_rules[].maximum_percentile_ranknumber(float)(Maximum Percentile Rank)

Maximum percentile rank to match this rule

engagement_category_rules[].maximum_scorenumber(float)(Maximum Score)required

Maximum score to match this rule

engagement_category_rules[].minimum_percentile_ranknumber(float)(Minimum Percentile Rank)

Minimum percentile rank to match this rule

engagement_category_rules[].minimum_scorenumber(float)(Minimum Score)required

Minimum score to match this rule

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

The unique, string identifier of this engagement model

is_activeboolean(Is Active)

Whether or not the model is active

namestring(Name)required

The name of the engagement model

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

typestring(Type)

The target of this engagement model

Enum"contact""organization"

Response

application/json

{
  "components": [
    { … }
  ],
  "enable_engagement_categories": true,
  "engagement_category_rules": [
    { … }
  ],
  "id": "string",
  "is_active": true,
  "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": [
    { … }
  ],
  "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,
  "type": "contact"
}

Updates a engagement model with the specified ID.

Request

This method will update an existing engagement model with the specified ID.

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the engagement model to update.

Bodyapplication/jsonrequired

The updated engagement model that will be saved.

componentsArray of objects

enable_engagement_categoriesboolean(Enable Engagement Categories)

If true, contacts are assigned categories based on engagement scores

engagement_category_rulesArray of objectsnon-emptyrequired

engagement_category_rules[].category_idstring(Category)required

The engagement category

engagement_category_rules[].maximum_percentile_ranknumber(float)(Maximum Percentile Rank)

Maximum percentile rank to match this rule

engagement_category_rules[].maximum_scorenumber(float)(Maximum Score)required

Maximum score to match this rule

engagement_category_rules[].minimum_percentile_ranknumber(float)(Minimum Percentile Rank)

Minimum percentile rank to match this rule

engagement_category_rules[].minimum_scorenumber(float)(Minimum Score)required

Minimum score to match this rule

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

The unique, string identifier of this engagement model

is_activeboolean(Is Active)

Whether or not the model is active

namestring(Name)required

The name of the engagement model

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

typestring(Type)

The target of this engagement model

Enum"contact""organization"

curl -i -X PUT \
  'https://docs.api.rhythmsoftware.com/_mock/apis/rolodex/rolodex-v1/engagementModels/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "components": [
      {
        "custom_metric_id": null,
        "metric_rules": [
          {
            "ending_range": 0.1,
            "points": 100,
            "starting_range": 0.1
          }
        ],
        "metric_type": "custom",
        "name": "string",
        "system_metric": null,
        "weight": 1
      }
    ],
    "enable_engagement_categories": true,
    "engagement_category_rules": [
      {
        "category_id": "string",
        "maximum_percentile_rank": 0.1,
        "maximum_score": 0.1,
        "minimum_percentile_rank": 0.1,
        "minimum_score": 0.1
      }
    ],
    "id": "string",
    "is_active": true,
    "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,
    "type": "contact"
  }'

Responses

The engagement model was updated successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

componentsArray of objects

enable_engagement_categoriesboolean(Enable Engagement Categories)

If true, contacts are assigned categories based on engagement scores

engagement_category_rulesArray of objectsnon-emptyrequired

engagement_category_rules[].category_idstring(Category)required

The engagement category

engagement_category_rules[].maximum_percentile_ranknumber(float)(Maximum Percentile Rank)

Maximum percentile rank to match this rule

engagement_category_rules[].maximum_scorenumber(float)(Maximum Score)required

Maximum score to match this rule

engagement_category_rules[].minimum_percentile_ranknumber(float)(Minimum Percentile Rank)

Minimum percentile rank to match this rule

engagement_category_rules[].minimum_scorenumber(float)(Minimum Score)required

Minimum score to match this rule

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

The unique, string identifier of this engagement model

is_activeboolean(Is Active)

Whether or not the model is active

namestring(Name)required

The name of the engagement model

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

typestring(Type)

The target of this engagement model

Enum"contact""organization"

Response

application/json

{
  "components": [
    { … }
  ],
  "enable_engagement_categories": true,
  "engagement_category_rules": [
    { … }
  ],
  "id": "string",
  "is_active": true,
  "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": [
    { … }
  ],
  "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,
  "type": "contact"
}

Engagement Scores

Operations

Organization Directories

Operations

Organization Duplicates

Operations

Organization Types

Operations

Organizations

Operations

Phone Number Types

Operations

Query Definitions

Operations

Region Configurations

Operations

Regions

Operations

Relationship Types

Operations

Relationships

Operations

Settings

Operations

Statistics

Operations

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

Account Delegation Processes

Address Types

Communication Types

Contact Directories

Contact Districts

Contact Duplicates

Contact Login Profiles

Contact Role Rule Sets

Contact Roles

Contacts

Custom Activities

Custom Activity Types

Custom Engagement Metrics

Engagement Categories

Engagement Models

Gets all of the engagement models in the system.

Request

Responses

Was this helpful?

Creates a new engagement model record that does not already exist.

RequestExpand all

Responses

Was this helpful?

Execute Batch Operations

RequestExpand all

Responses

Was this helpful?

Returns a engagement model from the system by its ID.

Request

Responses

Was this helpful?

Returns a engagement model from the system by its ID.

Request

Responses

Was this helpful?

Partially updates a engagement model with the specified ID.

Request

Responses

Was this helpful?

Updates a engagement model with the specified ID.

RequestExpand all

Responses

Was this helpful?

Engagement Scores

Organization Directories

Organization Duplicates

Organization Types

Organizations

Phone Number Types

Query Definitions

Region Configurations

Regions

Relationship Types

Relationships

Settings

Statistics

Request

Request

Request