enhancements_put_civis_data_match {civis}

Replace all attributes of this Civis Data Match Enhancement

Description

Replace all attributes of this Civis Data Match Enhancement

Usage

enhancements_put_civis_data_match(
  id,
  name,
  input_field_mapping,
  input_table,
  match_target_id,
  output_table,
  schedule = NULL,
  parent_id = NULL,
  notifications = NULL,
  max_matches = NULL,
  threshold = NULL,
  archived = NULL
)

Arguments

id

integer required. The ID for the enhancement.

name

string required. The name of the enhancement job.

input_field_mapping

list required. The field (i.e., column) mapping for the input table. See https://api.civisanalytics.com/enhancements/field-mapping for a list of valid field types and descriptions. Each field type should be mapped to a string specifying a column name in the input table. For field types that support multiple values (e.g., the "phone" field), a list of column names can be provided (e.g., "phone": ["home_phone", "mobile_phone"], ...).

input_table

list required. 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 required. The ID of the Civis Data match target. See /match_targets for IDs.

output_table

list required. 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.

schedule

list optional. A list containing the following elements:

• scheduled boolean, If the item is scheduled.

• scheduledDays array, Days of the week, based on numeric value starting at 0 for Sunday. Mutually exclusive with scheduledDaysOfMonth

• scheduledHours array, Hours of the day it is scheduled on.

• scheduledMinutes array, Minutes of the day it is scheduled on.

• scheduledRunsPerHour integer, Deprecated in favor of scheduled minutes.

• scheduledDaysOfMonth array, Days of the month it is scheduled on, mutually exclusive with scheduledDays.

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.

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. The default value is 0.5.

archived

boolean optional. Whether the Civis Data Match Job has been archived.

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, Days of the week, based on numeric value starting at 0 for Sunday. Mutually exclusive with scheduledDaysOfMonth

• scheduledHours array, Hours of the day it is scheduled on.

• scheduledMinutes array, Minutes of the day it is scheduled on.

• scheduledRunsPerHour integer, Deprecated in favor of scheduled minutes.

• scheduledDaysOfMonth array, Days of the month it is scheduled on, mutually exclusive with scheduledDays.

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.

myPermissionLevel

string, Your permission level on the object. One of "read", "write", or "manage".

inputFieldMapping

list, The field (i.e., column) mapping for the input table. See https://api.civisanalytics.com/enhancements/field-mapping for a list of valid field types and descriptions. Each field type should be mapped to a string specifying a column name in the input table. For field types that support multiple values (e.g., the "phone" field), a list of column names can be provided (e.g., "phone": ["home_phone", "mobile_phone"], ...).

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. The default value is 0.5.

archived

boolean, Whether the Civis Data Match Job has been archived.

lastRun

list, A list containing the following elements:

• id integer,

• state string,

• createdAt string, The time that the run was queued.

• startedAt string, The time that the run started.

• finishedAt string, The time that the run completed.

• error string, The error message for this run, if present.