Update some attributes of this Civis Data Match Enhancement
enhancements_patch_civis_data_match(id, name = NULL, schedule = NULL,
parent_id = NULL, notifications = NULL, input_field_mapping = NULL,
input_table = NULL, input_file_id = NULL, match_target_id = NULL,
output_table = NULL, output_filename = NULL, max_matches = NULL,
threshold = NULL)integer required. The ID for the enhancement.
string optional. The name of the enhancement job.
list optional. A list containing the following elements:
scheduled boolean, If the item is scheduled.
scheduledDays array, Day based on numeric value starting at 0 for Sunday.
scheduledHours array, Hours of the day it is scheduled on.
scheduledMinutes array, Minutes of the day it is scheduled on.
scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour.
integer optional. Parent ID that triggers this enhancement.
list optional. A list containing the following elements:
urls array, URLs to receive a POST request at job completion
successEmailSubject string, Custom subject line for success e-mail.
successEmailBody string, Custom body text for success e-mail, written in Markdown.
successEmailAddresses array, Addresses to notify by e-mail when the job completes successfully.
successEmailFromName string, Name from which success emails are sent; defaults to "Civis."
successEmailReplyTo string, Address for replies to success emails; defaults to the author of the job.
failureEmailAddresses array, Addresses to notify by e-mail when the job fails.
stallWarningMinutes integer, Stall warning emails will be sent after this amount of minutes.
successOn boolean, If success email notifications are on.
failureOn boolean, If failure email notifications are on.
list optional. The column mapping for the input table/file. See /enhancements/field_mapping for list of valid fields.
list optional. A list containing the following elements:
databaseName string, The Redshift database name for the table.
schema string, The schema name for the table.
table string, The table name.
integer optional. The ID for the input file. This should be set if and only if inputTable and outputTable are not set.
integer optional. The ID of the Civis Data match target. See /match_targets for IDs.
list optional. A list containing the following elements:
databaseName string, The Redshift database name for the table.
schema string, The schema name for the table.
table string, The table name.
string optional. The name of the output file. This should be set if and only if inputFileId is set.
integer optional. The maximum number of matches per record in the input table/file to return. Must be between 0 and 10. 0 returns all matches.
number optional. The score threshold (between 0 and 1). Matches below this threshold will not be returned.
A list containing the following elements:
integer, The ID for the enhancement.
string, The name of the enhancement job.
string, The type of the enhancement (e.g CASS-NCOA)
string, The time this enhancement was created.
string, The time the enhancement was last updated.
list, A list containing the following elements:
id integer, The ID of this user.
name string, This user's name.
username string, This user's username.
initials string, This user's initials.
online boolean, Whether this user is online.
string, The status of the enhancement's last run
list, A list containing the following elements:
scheduled boolean, If the item is scheduled.
scheduledDays array, Day based on numeric value starting at 0 for Sunday.
scheduledHours array, Hours of the day it is scheduled on.
scheduledMinutes array, Minutes of the day it is scheduled on.
scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour.
integer, Parent ID that triggers this enhancement.
list, A list containing the following elements:
urls array, URLs to receive a POST request at job completion
successEmailSubject string, Custom subject line for success e-mail.
successEmailBody string, Custom body text for success e-mail, written in Markdown.
successEmailAddresses array, Addresses to notify by e-mail when the job completes successfully.
successEmailFromName string, Name from which success emails are sent; defaults to "Civis."
successEmailReplyTo string, Address for replies to success emails; defaults to the author of the job.
failureEmailAddresses array, Addresses to notify by e-mail when the job fails.
stallWarningMinutes integer, Stall warning emails will be sent after this amount of minutes.
successOn boolean, If success email notifications are on.
failureOn boolean, If failure email notifications are on.
list, A list containing the following elements:
id integer, The ID of this user.
name string, This user's name.
username string, This user's username.
initials string, This user's initials.
online boolean, Whether this user is online.
list, The column mapping for the input table/file. See /enhancements/field_mapping for list of valid fields.
list, A list containing the following elements:
databaseName string, The Redshift database name for the table.
schema string, The schema name for the table.
table string, The table name.
integer, The ID for the input file. This should be set if and only if inputTable and outputTable are not set.
integer, The ID of the Civis Data match target. See /match_targets for IDs.
list, A list containing the following elements:
databaseName string, The Redshift database name for the table.
schema string, The schema name for the table.
table string, The table name.
string, The name of the output file. This should be set if and only if inputFileId is set.
integer, The maximum number of matches per record in the input table/file to return. Must be between 0 and 10. 0 returns all matches.
number, The score threshold (between 0 and 1). Matches below this threshold will not be returned.