Uploads Reference: Accepted Headers ListΒΆ

Following are the accepted header names for import files:

  • action_[FIELD_NAME]: Custom action field name (e.g. action_comment) Enter the value for the user in this column. The field name can only include letters, numbers, and _ (no spaces or other characters). You do not need to create the field first.
  • address1: User's street address, (e.g. 123 ABC Street). Used to find the user's plus4 if possible.
  • address2: Second line of user's street address (e.g. apt A).
  • akid: User identifier. Required (unless user_id or email is provided).
  • city: User's city.
  • country: User's country. Defaults to United States. Also, "US" and "USA" are changed to "United States". In an import, you can change a user's country without additional address information.
  • created_at: Sets core_action.created_at. Must use a supported date format. Defaults to the time of the import. If a donation_amount column is included, this date is also used to set the created_at timestamp in core_order, core_transaction.
  • donation_amount: Required to record a donation. No negatives. Saved to core_order.total and core_transaction.amount. For product and candidate orders, the amount must be at least as much as the total of all product/candidate columns.
  • donation_candidate_[ID]: Required to record a candidate contribution. Replace ID with the number in core_candidate.id (e.g., donation_candidate_20 for core_candidate.id=20). Enter the amount of money donated to the candidate in this column (e.g., "9.99").
  • donation_card_num_last_four: The last 4 digits of the credit card used.
  • donation_currency: Defaults to US Dollars. To change, provide the three-letter ISO code for the currency of the donation. You can import donations in currencies other than the ones for which you have payment accounts. Conversions into approximate US dollars will be done using ActionKit's exchange rate estimate at upload time, regardless of the actual date of the donation.
  • donation_date: Set the created_at timestamp in core_order and core_transaction only. Core_action.created_at is set to the time of the import.
  • donation_exp_date: The credit card expiration date. Enter in MMYY format.
  • donation_import_id: Unique identifier for each donation per account, saved to core_order.import_id. Use up to 32 characters. Use to avoid accidental duplication - you cannot import two donations with the same import id in the same payment account.
  • donation_product_[ID]: Required to record a product order. Replace ID with the number in core_product.id (e.g., donation_product_75 for the product with an id of 75). Values for this column can be either a quantity number (e.g. "10") or a pair of numbers giving quantity and total paid separated by a pipe (e.g. "10|50.00"). If the price for your product in ActionKit is accurate then you can use just a quantity and the amount paid will be calculated for you. However, if the price doesn't include everything (i.e., if the total also includes shipping charges), then use the compound format above and include the actual total amount paid by the user.
  • email: User identifier. Required (unless user_id or akid is provided).
  • event_venue: Venue name for each event. Required for event uploads.
  • event_address1: Address of the event venue. Required for event uploads.
  • event_city: City of the event venue. Required for event uploads.
  • event_country: Country of the event venue. Required for non-US events.
  • event_state: State of the event venue. Not required but may be needed to locate the event on the map.
  • event_zip: Zip of the event venue. Not required but may be needed to locate the event on the map.
  • event_public_description: Description of event for event sign up page. Required for event uploads.
  • event_starts_at_date: mm/dd/yyyy or yyyy-mm-dd. Required for event uploads.
  • event_starts_at_time: hh:mm. Required for event uploads.
  • event_starts_at_ampm: "am" or "pm". Required for event uploads.
  • first_name: User's first name. Not needed if you have a name column.
  • group: Name of a group to add the user to. Does not create new groups; you must create groups in advance. Can't be used if your file has a group_id column, you must choose one. Can't be used if the import page itself has a group associated with it.
  • group_id: ID of a group to add the user to. Can't be used if your file has a group column, you must choose one. Can't be used if the import page itself has a group associated with it.
  • group_remove: Name of a group to remove the user from. Can't be used if your file has a group_id_remove column, you must choose one.
  • group_id_remove: ID of a group to remove the user from. Can't be used if your file has a group_remove column, you must choose one.
  • initial_source: Overwrites the user's original source, saved to core_user.source. Not to be confused with source, which sets the action source.
  • lang: User's language. Saved to core_user.lang_id. English is the default language. Set a different language for any user by including a value for the language name (e.g. "English", "Espanol", etc.), or the ISO code (e.g. "en", "es", "ru", etc.), or the ISO name (e.g. "Spanish", "Russian", etc.).
  • last_name: User's last name. Not needed if you have a name column.
  • lists: List to subscribe a user to. Only one list is allowed per row, and when blank the user's subscriptions won't be changed at all. Not needed if you are subscribing all users in the file to the same list; instead use the option on the Import Basics section. If this column is present, the option on the Import Basics will be ignored!
  • mailing_id: Saved to core_action.mailing_id. Sets action source to mailing. Row will error if the user didn't receive the mailing.
  • middle_name: User's middle name.
  • name: User's name. The entry will be parsed into first, middle and last name based on spacing. If the field contains characters with no space the characters are saved as first_name.
  • phone: User's phone number. Entry is not validated. The number, with no letters or punctuation, is saved to core_phone.normalized_phone.
  • phone_type: The type corresponding to the number in the phone column. Defaults to home. Saved to core_phone.type. Accepted types are: home, work, mobile, emergency, home_fax, work_fax.
  • postal: User's zip or postal code. If the user's country is "United States" and you enter a valid zip in the postal field, it will be saved to the zip field instead and used for address validation. If the zip is not the correct number of digits the row will error and your data will not be saved. If the country is not "United States", your entry is saved in the postal field; it is not validated.
  • prefix: User's name prefix.
  • recurring_first_payment: Optional when importing a recurring donation. By default an initial payment is created when you upload your recurring profile. If you do not want to create an initial payment at the time of your upload, put a 0 in this column.
  • recurring_id: Required to import a recurring donation. The profile ID from the payment processor for an existing recurring donation.
  • recurring_payment_account: Required to import a recurring donation, IF you have more than one payment processor configured. If you do not include this column or the value does not match one of your payment accounts an error is returned.
  • recurring_start_date: Required to import a recurring donation. Date of the first payment made toward the profile.
  • region: User's region.
  • skip_confirmation: Include for any row in an event upload for which you don't want the confirmation email for the page to be sent.
  • source: Recorded as the action source in the core_action row for the import; overrides default action source for the import page, if one is set.
  • state:Two character abbreviation for user state (e.g. CA).
  • suffix: Part of user name.
  • [TYPE_phone]: Alternate method of designating phone type. Accepted column headers are: home_phone, work_phone, mobile_phone, emergency_phone, bat_phone. If you use one of these, enter the number in the column.
  • unsub_lists: List to unsubscribe a user from. Only one list is allowed per row, and when blank the user's subscriptions won't be changed at all. Not needed if you are unsubscribing all users in the file to the same list; instead use the option on the Import Basics section. If this column is present, the option on the Import Basics will be ignored!
  • user_[FIELD_NAME]: Custom user field name. Column header must start user_ (e.g. user_occupation). The field name can only include letters, numbers, and _ (no spaces or other characters). You must create the user field from the link on the Users Tab first, or leave the auto-create user fields option checked when performing your upload.
  • user_id: User identifier. Required (unless email or akid is provided).
  • zip: User zip or postal code. Entries with either 5-digits (ex. "10001") or 9-digits with a dash separating the two parts (ex. "10001-1234") are saved to core_user.zip (and core_user.plus4 if appropriate), unless the user's country is not United States. If the zip is not the correct number of digits, even if the country is United States, or if the country is not United States, the entry is saved to core_user.postal. Four-digit zip codes will have a zero pre-pended to help work around a common Excel error (i.e. 2905 is treated as 02905).