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, match_target_id = NULL, output_table = NULL,
  max_matches = NULL, threshold = NULL)

Arguments

id

integer required. The ID for the enhancement.

name

string optional. The name of the enhancement job.

schedule

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.

parent_id

integer optional. Parent ID that triggers this enhancement.

notifications

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.

input_field_mapping

list optional. The column mapping for the input table. See /enhancements/field_mapping for list of valid fields.

input_table

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.

match_target_id

integer optional. The ID of the Civis Data match target. See /match_targets for IDs.

output_table

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.

max_matches

integer optional. The maximum number of matches per record in the input table to return. Must be between 0 and 10. 0 returns all matches.

threshold

number optional. The score threshold (between 0 and 1). Matches below this threshold will not be returned.

Value

A list containing the following elements:

id

integer, The ID for the enhancement.

name

string, The name of the enhancement job.

type

string, The type of the enhancement (e.g CASS-NCOA)

createdAt

string, The time this enhancement was created.

updatedAt

string, The time the enhancement was last updated.

author

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.

state

string, The status of the enhancement's last run

schedule

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.

parentId

integer, Parent ID that triggers this enhancement.

notifications

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.

runningAs

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.

inputFieldMapping

list, The column mapping for the input table. See /enhancements/field_mapping for list of valid fields.

inputTable

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.

matchTargetId

integer, The ID of the Civis Data match target. See /match_targets for IDs.

outputTable

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.

maxMatches

integer, The maximum number of matches per record in the input table to return. Must be between 0 and 10. 0 returns all matches.

threshold

number, The score threshold (between 0 and 1). Matches below this threshold will not be returned.