The Import from Phone2Action - Advocates template uses the Phone2Action Public API to import advocates data onto Civis Platform.
Parameters
- User Credential (required): This is a custom credential on Civis Platform, where the username is the “APP_ID” and password is the “APP_KEY” from your Phone2Action user account. Please see this page for instructions on how to create a new custom credential.
- Start Date (optional): Fetch all advocates updated in Phone2Action after this date (with the YYYY-MM-DD format). If this “start date” parameter is specified, the “days” parameter cannot be used.
- Days (optional): Fetch all advocates updated most recently within this number of days. If this “days” parameter is specified, the “start date” parameter cannot be used. Data collection starts at midnight on the first day of the given range and ends at the time of the run.
- State (optional): Fetch only advocates from a state/territory specified by a two-character US postal abbreviation, e.g., “CA”, “NY”, “DC”.
- Campaign ID (optional): ID of campaign. Fetch only advocates belonging to that campaign.
- Email (optional): Fetch only advocates who have this email address on their records.
- Phone Number (optional): Fetch only advocates who have this phone number on their records. Phone numbers can be in any format.
- Exclude GDPR (optional): Return or exclude advocate information that has been expunged due to a General Data Protection Regulation (GDPR) request.
- Destination Database (required): The database to which to write records.
- Destination Database Credential (required): A valid database credential for the cluster.
- Schema and Table (required): The schema and table name you would like to import the data into, e.g., “schema.table”.
-
If Table Exists (optional): The action to take if a table with the requested name already exists. Options are:
- Fail: The sync job fails if the table exists
- Append: Records will be appended to the existing table
- Truncate: Records on the table will be wiped out while maintaining the current columns.
- Drop: Removes the entire table including column information.
- Upsert: Update or insert records into the specified table. The upsert mode modifies the table by leveraging the Primary key as well as Last modified keys values provided to modify existing records or add new ones. Visit Upsert Mode for more information on how it works.
- Max Errors (optional): The maximum number of rows with errors to remove from the Civis Platform table import before failing. Defaults to 0 (i.e., no errors allowed).
- Dist Style (optional): The distribution style for the resulting table. One of 'even', 'all' or 'key'. Defaults to 'key'.
- Dist Key (optional): The column to use as the distkey for the table. Defaults to 'id'. If you import data that doesn’t have a column named ‘id’, please provide the column name for the primary key.
- Sort Key 1 (optional): The column to use as the sortkey for the table.
- Sort Key 2 (optional): The second column in a compound sortkey for the table.
- Primary Keys (optional): A comma separated list of the primary key column(s) of the destination table that uniquely identifies a record.
- Last Modified Keys (optional): A comma separated list of the columns indicating a record has been updated.
- Log Level (optional): Which level of logging to use. The options are “INFO” (default), “DEBUG” (more verbose), and “WARNING” (less verbose).
Comments
0 comments
Please sign in to leave a comment.