Engagement Models

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

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.

Request

Security:

knox-authorizer

path Parameters

tenantId

required

string

The id of the tenant being accessed.

Request Body schema: application/json

The engagement model that you would like to be saved.

id required	string (ID) /^[\w:\|-]+$/ The unique, string identifier of this engagement model
name required	string (Name) The name of the engagement model
type	string (Type) The target of this engagement model Enum: "contact" "organization"
	Array of objects
enable_engagement_categories	boolean (Enable Engagement Categories) If true, contacts are assigned categories based on engagement scores
required	Array of objects non-empty
is_active	boolean (Is Active) Whether or not the model is active
sys_deleted_by_id	string (Sys Deleted By) The ID of the user that deleted (or last tried to delete) this object
sys_version	number <float> (Sys Version) A number representing the version of this record in the database
sys_created_at required	string <date-time> (Sys Created At) The date/time that this record was created, expressed in ISO-8601 date format
sys_last_modified_at required	string <date-time> (Sys Last Modified At) The date/time that this record record was last modified, expressed in ISO-8601 date format
sys_created_by_id required	string (Sys Created By) The ID of the user that created this record
sys_last_modified_by_id required	string (Sys Last Modified By) The ID of the user that last modified this record
sys_external_id	string (Sys External) The ID that a record has from an external system or data import
sys_locked	boolean (Sys Locked) If set, this record is locked and cannot be changed via the API
sys_bulk_load_pk	string (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_at	string (Sys Bulk Load At) If this record was loaded via bulk, the timestamp when the record was processed
sys_bulk_load_id	string (Sys Bulk Load) If this record was loaded via bulk, the ID of the bulk load process
sys_bulk_load_record_no	number <float> (Sys Bulk Load Record No) If this record was loaded via bulk, the record number in the source file
sys_bulk_load_source_file	string (Sys Bulk Load Source File) If this record was loaded via bulk, the source file
sys_last_bulk_data_operation_id	string (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_version	string (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_directive	string (Sys Directive) Means for passing directive information into an object processing logic
sys_calculated_field_error	string (Sys Calculated Field Error) The error associated with the calculated field
sys_snapshot_base_version	number <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_has_files_in_s3	boolean (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_configuration_snapshot_id	string (Sys Configuration Snapshot) If a snapshot was restored/applies to this record, the ID of the snapshot
sys_last_security_context	object (Sys Last Security Context) The security context of the last insert, modify, or delete performed on this item
	Array of objects

Responses

200The engagement model was saved successfully.

400The engagement model you supplied was invalid.

401Unauthorized.

403Forbidden.

404The resource could not be found

409The engagement model could not be saved because it refers to/depends on a non-existent object.

429Limit exceeded... unable to add engagement model based on tenant limits.

500General server error.

post/engagementModels/{tenantId}

Request samples

application/json

{"id": "string",
"name": "string",
"type": "contact",
"components": [{"name": "string",
"weight": 1,
"metric_type": "system",
"system_metric": "string",
"custom_metric_id": "string",
"metric_rules": [{"starting_range": 0,
"ending_range": 0,
"points": 100
}
]
}
],
"enable_engagement_categories": true,
"engagement_category_rules": [{"minimum_score": 0,
"maximum_score": 0,
"minimum_percentile_rank": 0,
"maximum_percentile_rank": 0,
"category_id": "string"
}
],
"is_active": true,
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}

Response samples

application/json

{"id": "string",
"name": "string",
"type": "contact",
"components": [{"name": "string",
"weight": 1,
"metric_type": "system",
"system_metric": "string",
"custom_metric_id": "string",
"metric_rules": [{"starting_range": 0,
"ending_range": 0,
"points": 100
}
]
}
],
"enable_engagement_categories": true,
"engagement_category_rules": [{"minimum_score": 0,
"maximum_score": 0,
"minimum_percentile_rank": 0,
"maximum_percentile_rank": 0,
"category_id": "string"
}
],
"is_active": true,
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}

Gets all of the engagement models in the system.

This method will scan all engagement models and and return them to the caller.

Request

Security:

knox-authorizer

path Parameters

tenantId

required

string

The id of the tenant being accessed.

query Parameters

fields	string The fields that you want to retrieve; if omitted, the entire object is returned.
exclusiveStartKey	string The start key, if you're making a subsequent request

Responses

200The engagement modelswere retrieved successfully.

400The request was invalid.

401Unauthorized.

403Forbidden.

404The resource could not be found

429Limit exceeded... unable to add contact role based on tenant limits.

500General server error.

get/engagementModels/{tenantId}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  'https://rolodex.api.756794052567.rhythmsoftware.com/engagementModels/:tenantId?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

[{"id": "string",
"name": "string",
"type": "contact",
"components": [{"name": "string",
"weight": 1,
"metric_type": "system",
"system_metric": "string",
"custom_metric_id": "string",
"metric_rules": [{"starting_range": 0,
"ending_range": 0,
"points": 100
}
]
}
],
"enable_engagement_categories": true,
"engagement_category_rules": [{"minimum_score": 0,
"maximum_score": 0,
"minimum_percentile_rank": 0,
"maximum_percentile_rank": 0,
"category_id": "string"
}
],
"is_active": true,
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}
]

Returns a engagement model from the system by its ID.

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

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The id of the tenant being accessed.
id required	string The ID of the engagement model to return.

query Parameters

fields	string The fields that you want to retrieve; if omitted, the entire object is returned.
consistentRead	string Indicates the API should force a consistent read on the data source.

Responses

200The engagement model was retrieved successfully.

400The request was not valid.

401Unauthorized.

403Forbidden.

404The engagement model could not be found.

429Limit exceeded... unable to retrieve engagement model based on tenant limits.

500General server error.

get/engagementModels/{tenantId}/{id}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  'https://rolodex.api.756794052567.rhythmsoftware.com/engagementModels/:tenantId/:id?fields=string&consistentRead=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"id": "string",
"name": "string",
"type": "contact",
"components": [{"name": "string",
"weight": 1,
"metric_type": "system",
"system_metric": "string",
"custom_metric_id": "string",
"metric_rules": [{"starting_range": 0,
"ending_range": 0,
"points": 100
}
]
}
],
"enable_engagement_categories": true,
"engagement_category_rules": [{"minimum_score": 0,
"maximum_score": 0,
"minimum_percentile_rank": 0,
"maximum_percentile_rank": 0,
"category_id": "string"
}
],
"is_active": true,
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}

Updates a engagement model with the specified ID.

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

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The id of the tenant being accessed.
id required	string The ID of the engagement model to update.

Request Body schema: application/json

The updated engagement model that will be saved.

id required	string (ID) /^[\w:\|-]+$/ The unique, string identifier of this engagement model
name required	string (Name) The name of the engagement model
type	string (Type) The target of this engagement model Enum: "contact" "organization"
	Array of objects
enable_engagement_categories	boolean (Enable Engagement Categories) If true, contacts are assigned categories based on engagement scores
required	Array of objects non-empty
is_active	boolean (Is Active) Whether or not the model is active
sys_deleted_by_id	string (Sys Deleted By) The ID of the user that deleted (or last tried to delete) this object
sys_version	number <float> (Sys Version) A number representing the version of this record in the database
sys_created_at required	string <date-time> (Sys Created At) The date/time that this record was created, expressed in ISO-8601 date format
sys_last_modified_at required	string <date-time> (Sys Last Modified At) The date/time that this record record was last modified, expressed in ISO-8601 date format
sys_created_by_id required	string (Sys Created By) The ID of the user that created this record
sys_last_modified_by_id required	string (Sys Last Modified By) The ID of the user that last modified this record
sys_external_id	string (Sys External) The ID that a record has from an external system or data import
sys_locked	boolean (Sys Locked) If set, this record is locked and cannot be changed via the API
sys_bulk_load_pk	string (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_at	string (Sys Bulk Load At) If this record was loaded via bulk, the timestamp when the record was processed
sys_bulk_load_id	string (Sys Bulk Load) If this record was loaded via bulk, the ID of the bulk load process
sys_bulk_load_record_no	number <float> (Sys Bulk Load Record No) If this record was loaded via bulk, the record number in the source file
sys_bulk_load_source_file	string (Sys Bulk Load Source File) If this record was loaded via bulk, the source file
sys_last_bulk_data_operation_id	string (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_version	string (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_directive	string (Sys Directive) Means for passing directive information into an object processing logic
sys_calculated_field_error	string (Sys Calculated Field Error) The error associated with the calculated field
sys_snapshot_base_version	number <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_has_files_in_s3	boolean (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_configuration_snapshot_id	string (Sys Configuration Snapshot) If a snapshot was restored/applies to this record, the ID of the snapshot
sys_last_security_context	object (Sys Last Security Context) The security context of the last insert, modify, or delete performed on this item
	Array of objects

Responses

200The engagement model was updated successfully.

400The engagement model supplied was not valid.

401Unauthorized.

403Forbidden.

404The engagement model could not be found.

409The engagement model could not be saved because it refers to/depends on a non-existent object.

429Limit exceeded... unable to retrieve engagement model based on tenant limits.

500General server error.

put/engagementModels/{tenantId}/{id}

Request samples

application/json

{"id": "string",
"name": "string",
"type": "contact",
"components": [{"name": "string",
"weight": 1,
"metric_type": "system",
"system_metric": "string",
"custom_metric_id": "string",
"metric_rules": [{"starting_range": 0,
"ending_range": 0,
"points": 100
}
]
}
],
"enable_engagement_categories": true,
"engagement_category_rules": [{"minimum_score": 0,
"maximum_score": 0,
"minimum_percentile_rank": 0,
"maximum_percentile_rank": 0,
"category_id": "string"
}
],
"is_active": true,
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}

Response samples

application/json

{"id": "string",
"name": "string",
"type": "contact",
"components": [{"name": "string",
"weight": 1,
"metric_type": "system",
"system_metric": "string",
"custom_metric_id": "string",
"metric_rules": [{"starting_range": 0,
"ending_range": 0,
"points": 100
}
]
}
],
"enable_engagement_categories": true,
"engagement_category_rules": [{"minimum_score": 0,
"maximum_score": 0,
"minimum_percentile_rank": 0,
"maximum_percentile_rank": 0,
"category_id": "string"
}
],
"is_active": true,
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}

Partially updates a engagement model with the specified ID.

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

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The id of the tenant being accessed.
id required	string The ID of the engagement model to patch.

Request Body schema: application/json

The patch directives conforming to RFC 6902.

Array

op required	string (Op) The operation Enum: "add" "remove" "replace" "move" "copy" "test"
path required	string (Path) The JSON path
value	string (Value) The updated value

Responses

200The engagement model was patched successfully.

400The JSON patch directive you supplied was not valid.

401Unauthorized.

403Forbidden.

404The engagement model could not be found.

409The engagement model could not be saved because it refers to/depends on a non-existent object.

429Limit exceeded... unable to retrieve engagement model based on tenant limits.

500General server error.

patch/engagementModels/{tenantId}/{id}

Request samples

application/json

[{"op": "add",
"path": "string",
"value": "string"
}
]

Response samples

application/json

{"id": "string",
"name": "string",
"type": "contact",
"components": [{"name": "string",
"weight": 1,
"metric_type": "system",
"system_metric": "string",
"custom_metric_id": "string",
"metric_rules": [{"starting_range": 0,
"ending_range": 0,
"points": 100
}
]
}
],
"enable_engagement_categories": true,
"engagement_category_rules": [{"minimum_score": 0,
"maximum_score": 0,
"minimum_percentile_rank": 0,
"maximum_percentile_rank": 0,
"category_id": "string"
}
],
"is_active": true,
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}

Returns a engagement model from the system by its ID.

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

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The id of the tenant being accessed.
id required	string The ID of the engagement model to delete.

Responses

200The engagement model was deleted successfully.

400The request was not valid.

401Unauthorized.

403Forbidden.

404The engagement model could not be found.

409The engagement model could not be deleted because other objects refers to/depends on this one.

429Limit exceeded... unable to delete engagement model based on tenant limits.

500General server error.

delete/engagementModels/{tenantId}/{id}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X DELETE \
  https://rolodex.api.756794052567.rhythmsoftware.com/engagementModels/:tenantId/:id \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

"string"

Execute Batch Operations

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

Request

Security:

knox-authorizer

path Parameters

tenantId

required

string

The id of the tenant being accessed.

Request Body schema: application/json

The batch request

Array of objects

Responses

200Request completed successfully.

400The request was not valid.

401Unauthorized.

403Forbidden.

404The engagement model could not be found.

429Limit exceeded... unable to retrieve engagement model based on tenant limits.

500General server error.

post/engagementModels/{tenantId}/batch

Request samples

application/json

{"operations": [{"operation": "create",
"id": "string",
"patch_directives": [{"op": "add",
"path": "string",
"value": "string"
}
],
"object": { }
}
]
}

Response samples

application/json

{"success_count": 0,
"error_count": 0,
"results": [{"operation": "create",
"id": "string",
"outcome": "success",
"error_message": "string",
"object": { }
}
]
}