GreenArrow Email Software Documentation

Subscriber Imports API

Remote Lists

Subscriber Imports are not available on Remote Lists. API calls to these endpoints will return an error message if attempted on a Remote List.

Definitions

Subscriber Import States

scheduled

The import has been scheduled and is waiting to start

downloading

The import is downloading its data from a URL (1)

splitting

The import is being prepared and analyzed

importing

The import is now being processed

paused

The import has been paused

finished

The import finished successfully

failed

There was an internal error during this import

cancelled

The import was permanently cancelled

Mapping Array

The mapping array declares how each column of the CSV import maps to the subscriber record.

email

Required The email address for this subscriber record.

status

The status for this subscriber record. See the “Subscriber Statuses” table for a list of values.

email_format

The email format for this subscriber. Can be html, text or both. Only applies if the mailing list has the email format field enabled.

subscribe_time

The time at which the subscriber subscribed.

subscribe_ip

The IP from which the subscriber subscribed.

remove_time

The time at which the subscriber was removed from the list.

remove_ip

The IP from which the subscriber was removed from the list.

Custom Fields can be mapped to columns in the import file using their name. For example, for a CSV file that contains four columns (Email, Subscribe Time, Subscribe IP and data for a custom field First Name).

"mapping": [
  "email",
  "subscribe_time",
  "subscribe_ip",
  "First Name"
]

Default Custom Fields

The default_custom_fields on a subscriber import are values that are set for each new subscriber in the import.

If overwrite_custom_fields is set, then these values will also be applied to updated subscribers.

The default_custom_fields values should be set as a hash of custom field names to values.

Here is an example, with Subscriber Name as a text field and Preferred Cars as a checkboxes field:

"default_custom_fields": {
  "Subscriber Name": "Bob Example",
  "Preferred Cars": [ "Toyota", "Kia" ]
}

Date/Time Fields

Custom field import data can include date/times for the following fields:

  • Date Custom Fields
  • Day of Year Custom Fields
  • Subscribe Time
  • Remove Time
  • Confirm Time

The following date/time formats are accepted for these values.

  • 1994-03-11T14:30:47-06:00
  • March 11, 1994 14:30
  • March 11, 1994
  • 11 March 1994
  • 03-11-1994 2:30:47pm
  • 03-11-1994 14:30:47
  • 03-11-1994 2:30pm
  • 03-11-1994 14:30
  • 03-11-1994
  • 03/11/1994 2:30:47pm
  • 03/11/1994 14:30:47
  • 03/11/1994 2:30pm
  • 03/11/1994 14:30
  • 03/11/1994
  • 1994-03-11 14:30
  • 1994-03-11

Note: Other formats may be parsed successfully, but we recommend that you stick to this list of accepted formats.

Note: The ambiguous date formats (for example, should 5/11/2014 be May 11, 2014 or November 5, 2014) are clarified by the date_format field. See the documentation below for details on how to set it.

Get a list of subscriber imports

Get a list of subscriber imports, filterable by state.

URL

GET /ga/api/v2/subscriber_imports

GET /ga/api/v2/subscriber_imports?scope=active

GET /ga/api/v2/subscriber_imports?scope=finished

GET /ga/api/v2/subscriber_imports?scope=all

To get the subscriber imports for a specific mailing list:

GET /ga/api/v2/mailing_lists/:mailing_list_id/subscriber_imports

GET /ga/api/v2/mailing_lists/:mailing_list_id/subscriber_imports?scope=:scope

Request Parameters

Provide a scope parameter to filter the subscriber imports returned.

finished

All finished subscriber imports

active

All incomplete subscriber imports

recent

Default All incomplete and recently (within 2 weeks) finished subscriber imports

all

All subscriber imports

This API returns the first 100 records by default and supports pagination.

Pagination

To query additional records, provide page and per_page parameters. The page parameter starts at 0. The per_page parameter defaults to 100 and the maximum allowed is 500.

For example to get the second page:

GET /ga/api/v2/subscriber_imports?scope=all&page=1&per_page=100

The response will also contain the following extra parameters:

page

The current page number

per_page

The number of records per page

num_records

The total number of records that match the query

num_pages

The total number of pages that match the query

Order

Imports are returned in this order:

  1. Non-finished/cancelled imports with the soonest scheduled time first (oldest begins_at first)
  2. Finished/cancelled imports with the most recently completed first (newest finished_at first)

Response

The response will be a JSON array where each element contains the following keys.

id

integer

The internal identifier for this subscriber import

mailing_list_id

integer

The ID of the mailing list this import is adding to.

mailing_list_name

string

The name of the mailing list this import is adding to.

created_at

datetime

Timestamp when this import was originally created.

state

string

The current state of this import.

begins_at

datetime

The time at which this import is scheduled to begin.

finished_at

datetime

The time at which this import finished.

file_source

hash


type

string

The source of the data to use for this import. This can be json, upload_directory, or url.

filename

string

For upload_directory imports, this is the filename of the local file in the user upload directory.

url

string

For url imports, this is the URL of the file to fetch for this import.

stats

hash


number_of_records

integer

The total number of rows that were detected in the import’s input file.

records_imported

integer

The total number of rows that were processed during the import.

Example

> GET /ga/api/mailing_lists/1/subscriber_imports HTTP/1.1
> Authorization: Basic MToyMTk5MzY2YTAzYWM3OWE1N2YwYTRlNzYwZWQyZTNkOGJkNzBjOWYw
> Accept: application/json
> Content-Type: application/json

< Content-Type: application/json; charset=utf-8
< X-UA-Compatible: IE=Edge
< ETag: "d64fa2907baedf9f003a3dc9c5f6c483"
< Cache-Control: max-age=0, private, must-revalidate
< Set-Cookie: _session_id=f1e4a07566f9b284bd84cac355afde56; path=/; HttpOnly
< X-Request-Id: 2478536084b570ad8c223c0f3ad11010
< X-Runtime: 0.023404
< Connection: close
< Server: thin 1.5.0 codename Knife

{
  "success": true,
  "error_code": null,
  "error_message": null,
  "page": 0,
  "per_page": 100,
  "data": [
    {
      "id": 15,
      "mailing_list_id": 1,
      "mailing_list_name": "Default Mailing List",
      "created_at": "2015-01-15T20:53:18Z",
      "state": "finished",
      "begins_at": "2015-01-15T20:53:18Z",
      "finished_at": "2015-01-15T20:53:20Z",
      "stats": {
        "number_of_records": 2,
        "records_imported": 2
      },
      "file_source": {
        "type": "json",
        "filename": "data"
      }
    },
    {
      "id": 14,
      "mailing_list_id": 1,
      "mailing_list_name": "Default Mailing List",
      "created_at": "2015-01-15T20:51:31Z",
      "state": "finished",
      "begins_at": "2015-01-15T20:51:31Z",
      "finished_at": "2015-01-15T20:51:33Z",
      "stats": {
        "number_of_records": 1,
        "records_imported": 1
      },
      "file_source": {
        "type": "json",
        "filename": "data"
      }
    }
  ],
  "num_records": 2,
  "num_pages": 1
}

Get expanded details about a subscriber import

Get details about a single subscriber import, with more details than the index provides.

URL

GET /ga/api/v2/subscriber_imports/:id

Response

The response will be a JSON object with the following keys.

id

integer

The internal identifier for this subscriber import

mailing_list_id

integer

The ID of the mailing list this import is adding to.

mailing_list_name

string

The name of the mailing list this import is adding to.

created_at

datetime

Timestamp when this import was originally created.

state

string

The current state of this import. See the “Subscriber Import States” table above for more information.

begins_at

datetime

The time at which this import is scheduled to begin.

finished_at

datetime

The time at which this import finished.

overwrite

boolean

This import should overwrite existing subscribers with the same email address.

deactivate_subscribers_not_in_import

boolean

Any subscribers that are active and not included in this import will have their status updated to “deactivated” upon completion of this import.

error_message

string

An error message describing why this import failed.

autoresponders

hash


subscription

hash


trigger

boolean

When adding new subscribers, trigger any “On Subscription” autoresponders on this mailing list. Only autoresponders with “Run from import” set will be triggered in this way.

also_trigger_on_updated_subscribers

boolean

If trigger is set to true, existing subscribers that are updated by this import will also be sent the “On Subscription” autoresponders.

api

hash


trigger_new

hash



An API autoresponder to trigger when adding new subscribers. Set to null for none.

id

integer

The id of the autoresponder to trigger.

name

string

The case-insensitive name of the autoresponder to trigger. If both id and name are present, the value in name is ignored.

trigger_updated

hash



An API autoresponder to trigger when updating existing subscribers. Set to null for none.

id

integer

The id of the autoresponder to trigger.

name

string

The case-insensitive name of the autoresponder to trigger. If both id and name are present, the value in name is ignored.

overwrite_what

hash


custom_fields

boolean

When overwriting existing subscribers, this import should overwrite the custom fields.

confirmed

boolean

When overwriting existing subscribers, this import should update the confirmed field.

format

boolean

When overwriting existing subscribers, this import should update the format field.

status

boolean

When overwriting existing subscribers, this import should update the status field.

overwrite_when_status

hash


active

boolean

This import should overwrite existing active subscribers.

unsubscribed

boolean

This import should overwrite existing unsubscribed subscribers.

bounced

boolean

This import should overwrite existing bounced subscribers.

deactivated

boolean

This import should overwrite existing deactivated subscribers.

scomp

boolean

This import should overwrite existing spam complaint subscribers.

column_mapping

definition subscriber import mapping

Import mapping to use, see the “Mapping Array” documentation above.

default_custom_fields

definition subscriber import default custom fields

The custom field values to assign to all subscribers in this import.

file_source

hash


type

string

The source of the data to use for this import. This can be json, upload_directory, or url.

filename

string

For upload_directory imports, this is the filename of the local file in the user upload directory. For files that were uploaded on the web interface, this is the filename as uploaded.

url

string

For url imports, this is the URL of the file to fetch for this import.

file_format

hash


csv_has_headers

boolean

The top line of this file is headers, don’t use it as a record.

character_set

string

The character set to use for this import. Defaults to UTF-8, can also be ISO-8859-1.

csv_field_separator

string

The character to use to separate fields. Defaults to ,, can also be a literal tab ("\t" in JSON) for tabs.

csv_field_enclosure

string

The character to use to enclose fields. Defaults to ", can also be ' for single quotes.

date format

string

The date format to use when parsing Date custom fields, Subscribe Time, Remove Time, and Confirm Time. Defaults to mdy.

A value of mdy will parse 01/02/2014 as January 2, 2014.

A value of dmy will parse 01/02/2014 as February 1, 2014.

stats

hash


number_of_records

integer

The total number of rows that were detected in the import’s input file.

records_imported

integer

The total number of rows that were processed during the import.

subscribers

hash


added

integer

The number of subscribers that were added to the mailing list in this import.

updated

integer

The number of existing subscribers that were updated on the mailing list in this import.

failed

integer

The number of rows that failed to be processed in this import.

skipped_overwrite

integer

The number of subscribers that were skipped because this import is not set to overwrite.

skipped_active

integer

The number of subscribers that were skipped because this import is not set to overwrite active subscribers.

skipped_unsubscribed

integer

The number of subscribers that were skipped because this import is not set to overwrite unsubscribed subscribers.

skipped_scomp

integer

The number of subscribers that were skipped because this import is not set to overwrite spam complaint subscribers.

skipped_bounced

integer

The number of subscribers that were skipped because this import is not set to overwrite bounced subscribers.

skipped_deactivated

integer

The number of subscribers that were skipped because this import is not set to overwrite deactivated subscribers.

skipped_duplicate

integer

The number of subscribers that were skipped because the same email address appeared earlier in the import.

skipped_over_limit

integer

The number of subscribers that were skipped because the organization subscriber limit had been reached.

Example

> GET /ga/api/mailing_lists/1/subscriber_imports/15 HTTP/1.1
> Authorization: Basic MToyMTk5MzY2YTAzYWM3OWE1N2YwYTRlNzYwZWQyZTNkOGJkNzBjOWYw
> Accept: application/json
> Content-Type: application/json

< Content-Type: application/json; charset=utf-8
< X-UA-Compatible: IE=Edge
< ETag: "d36e7bf33aa83b076d172cce7cd19e0e"
< Cache-Control: max-age=0, private, must-revalidate
< Set-Cookie: _session_id=a023e6220d8d6929013c6035f8a0ae5c; path=/; HttpOnly
< X-Request-Id: 42b255c3d98d4a86928afd5bd87deb69
< X-Runtime: 0.020476
< Connection: close
< Server: thin 1.5.0 codename Knife

{
  "success": true,
  "data": {
    "id": 15,
    "mailing_list_id": 1,
    "mailing_list_name": "Default Mailing List",
    "created_at": "2015-01-15T20:53:18Z",
    "state": "finished",
    "begins_at": "2015-01-15T20:53:18Z",
    "finished_at": "2015-01-15T20:53:20Z",
    "stats": {
      "number_of_records": 2,
      "records_imported": 2,
      "subscribers": {
        "added": 1,
        "updated": 1,
        "failed": 0,
        "skipped_overwrite": 0,
        "skipped_active": 0,
        "skipped_unsubscribed": 0,
        "skipped_scomp": 0,
        "skipped_bounced": 0,
        "skipped_deactivated": 0,
        "skipped_duplicate": 0,
        "skipped_over_limit": 0
      }
    },
    "autoresponders": {
      "subscription": {
        "trigger": true,
        "also_trigger_on_updated_subscribers": false,
      },
      "api": {
        "trigger_new": null,
        "trigger_updated": null
      }
    },
    "file_source": {
      "type": "json",
      "filename": "data"
    },
    "file_format": {
      "character_set": "utf-8",
      "csv_has_headers": true,
      "csv_field_enclosure": "\"",
      "csv_field_separator": ",",
      "date_format": "mdy"
    },
    "subscriber_defaults": {
      "status": "active"
    },
    "overwrite": true,
    "overwrite_when_status": {
      "active": true,
      "unsubscribed": false,
      "bounced": false,
      "deactivated": false,
      "scomp": false
    },
    "column_mapping": [
      "email"
    ],
    "default_custom_fields": {
    },
    "overwrite_what": {
      "custom_fields": true,
      "confirmed": false,
      "format": false,
      "status": false
    }
  },
  "error_code": null,
  "error_message": null
}

Create a new subscriber import

Start a new subscriber import, providing all details needed to run.

Subscriber imports that retrieve data from a URL will attempt to download from that URL up to three times. The first retry will be 10 seconds after the first failure. The final retry will occur 50 seconds after the second failure. For these imports, the data will be loaded at the time the imports is scheduled to begin. This retry schedule does not apply if the URL did not finish sending after 15 minutes of downloading. In such cases, the URL will not be retried.

URL

POST /ga/api/v2/mailing_lists/:mailing_list_id/subscriber_imports

Request

The request should be a JSON object under the subscriber_import key with the keys listed below. See the example request below.

begins_at

datetime

The time at which this import is scheduled to begin. Default: the current time

overwrite

boolean

This import should overwrite existing subscribers with the same email address. Default: false

deactivate_subscribers_not_in_import

boolean, default: false

Any subscribers that are active and not included in this import will have their status updated to “deactivated” upon completion of this import.

autoresponders

hash


subscription

hash


trigger

boolean

When adding new subscribers, trigger any “On Subscription” autoresponders on this mailing list. Only autoresponders with “Run from import” set will be triggered in this way.

also_trigger_on_updated_subscribers

boolean

If trigger is set to true, existing subscribers that are updated by this import will also be sent the “On Subscription” autoresponders.

api

hash


trigger_new

hash



An API autoresponder to trigger when adding new subscribers. Set to null for none.

id

integer

The id of the autoresponder to trigger.

name

string

The case-insensitive name of the autoresponder to trigger. If both id and name are present, the value in name is ignored.

trigger_updated

hash



An API autoresponder to trigger when updating existing subscribers. Set to null for none.

id

integer

The id of the autoresponder to trigger.

name

string

The case-insensitive name of the autoresponder to trigger. If both id and name are present, the value in name is ignored.

overwrite_what

hash


custom_fields

boolean

When overwriting existing subscribers, this import should overwrite the custom fields. Default: true.

confirmed

boolean

When overwriting existing subscribers, this import should update the confirmed field. Default: false.

format

boolean

When overwriting existing subscribers, this import should update the format field. Default: false.

status

boolean

When overwriting existing subscribers, this import should update the status field. Default: false.

overwrite_when_status

hash


active

boolean

This import should overwrite existing active subscribers. Default: true.

unsubscribed

boolean

This import should overwrite existing unsubscribed subscribers. Default: false.

bounced

boolean

This import should overwrite existing bounced subscribers. Default: false.

deactivated

boolean

This import should overwrite existing deactivated subscribers. Default: false.

scomp

boolean

This import should overwrite existing spam complaint subscribers. Default: false.

column_mapping

array: definition subscriber import mapping

Import mapping to use, see the “Mapping Array” documentation above. Required.

default_custom_fields

hash: definition subscriber import default custom fields

The custom field values to assign to all subscribers in this import. Default: empty hash {}.

file_source

hash


type

string

The source of the data to use for this import. This can be json, upload_directory, or url. Required.

content

string

For json imports, this is the CSV content of the import file. This string may be up to 10MB in length. Larger string sizes may work, but they are not recommended nor guaranteed.

filename

string

For upload_directory imports, this is the filename of the local file in the user upload directory. There is no file size limit on local files.

url

string

For url imports, this is the URL of the file to fetch for this import. The file downloaded from this URL may be up to 200MB in length.

file_format

hash


csv_has_headers

boolean

The top line of this file is headers, don’t use it as a record. Default: true.

character_set

string

The character set to use for this import. Defaults to UTF-8, can also be ISO-8859-1.

csv_field_separator

string

The character to use to separate fields. Defaults to ,, can also be "\t" for tabs.

csv_field_enclosure

string

The character to use to enclose fields. Defaults to ", can also be ' for single quotes.

date_format

string

The date format to use when parsing Date custom fields, Subscribe Time, Remove Time, and Confirm Time. Defaults to mdy.

A value of mdy will parse 01/02/2014 as January 2, 2014.

A value of dmy will parse 01/02/2014 as February 1, 2014.

Response

The response will be a JSON object in the same format as the subscriber import show endpoint.

Example

> POST /ga/api/mailing_lists/1/subscriber_imports HTTP/1.1
> Authorization: Basic MTo0MDRhYzkzZTVjYmY4NzI4YjcyMzU5M2FmM2VkMTcwZDk0Yjc0Mjg4
> Accept: application/json
> Content-Type: application/json

{
  "subscriber_import": {
    "begins_at": "now",
    "column_mapping": [
      "email"
    ],
    "file_source": {
      "type": "json",
      "content": "email\[email protected]\[email protected]\n"
    },
    "autoresponders": {
      "subscription": {
        "trigger": true,
        "also_trigger_on_updated_subscribers": false,
      },
      "api": {
        "trigger_new": null,
        "trigger_updated": null
      }
    },
    "file_format": {
      "character_set": "iso-8859-1",
      "csv_has_headers": true,
      "csv_field_separator": ",",
      "csv_field_enclosure": "\"",
      "date_format": "mdy"
    },
    "overwrite": true,
    "overwrite_what": {
      "custom_fields": true,
      "confirmed": false,
      "format": false,
      "status": false
    },
    "overwrite_when_status": {
      "active": true,
      "unsubscribed": false,
      "bounced": false,
      "deactivated": false,
      "scomp": false
    },
    "subscriber_defaults": {
      "status": "active",
      "confirmed": true,
      "format": "html"
    },
    "default_custom_fields": {
      "First Name": "Bobbie"
    }
  }
}

< Content-Type: application/json; charset=utf-8
< X-UA-Compatible: IE=Edge
< ETag: "ad1f04869c6928097908511b2b7333e0"
< Cache-Control: max-age=0, private, must-revalidate
< Set-Cookie: _session_id=09d7790d36289b7d7ab61dd863c14514; path=/; HttpOnly
< X-Request-Id: 5963b6949c36a75cf0c5c93d845c3af8
< X-Runtime: 0.122245
< Connection: close
< Server: thin 1.5.0 codename Knife

{
  "success": true,
  "data": {
    "id": 1,
    "mailing_list_id": 1,
    "mailing_list_name": "Default Mailing List",
    "created_at": "2015-01-15T21:07:30Z",
    "state": "scheduled",
    "begins_at": "2015-01-15T21:07:30Z",
    "finished_at": null,
    "stats": {
      "number_of_records": null,
      "records_imported": 0,
      "subscribers": {
        "added": 0,
        "updated": 0,
        "failed": 0,
        "skipped_overwrite": 0,
        "skipped_active": 0,
        "skipped_unsubscribed": 0,
        "skipped_scomp": 0,
        "skipped_bounced": 0,
        "skipped_deactivated": 0,
        "skipped_duplicate": 0,
        "skipped_over_limit": 0
      }
    },
    "autoresponders": {
      "subscription": {
        "trigger": true,
        "also_trigger_on_updated_subscribers": false,
      },
      "api": {
        "trigger_new": null,
        "trigger_updated": null
      }
    },
    "file_source": {
      "type": "json",
      "filename": "data"
    },
    "file_format": {
      "character_set": "iso-8859-1",
      "csv_has_headers": true,
      "csv_field_enclosure": "\"",
      "csv_field_separator": ",",
      "date_format": "mdy"
    },
    "subscriber_defaults": {
      "status": "active"
    },
    "overwrite": true,
    "overwrite_when_status": {
      "active": true,
      "unsubscribed": false,
      "bounced": false,
      "deactivated": false,
      "scomp": false
    },
    "column_mapping": [
      "email"
    ],
    "default_custom_fields": {
      "First Name": "Bobbie"
    },
    "overwrite_what": {
      "custom_fields": true,
      "confirmed": false,
      "format": false,
      "status": false
    }
  },
  "error_code": null,
  "error_message": null
}

Pause or unpause a subscriber import

Subscriber imports that are in progress can be paused and later unpaused.

URL

POST /ga/api/v2/subscriber_imports/:id/pause

POST /ga/api/v2/subscriber_imports/:id/unpause

Response

The response will be a JSON object in the same format to the subscriber import show endpoint.

If the subscriber import cannot be paused (or unpaused), this endpoint will return a validation_failed error.

Cancel a subscriber import

Subscriber imports that haven’t yet finished can be cancelled.

URL

POST /ga/api/v2/subscriber_imports/:id/cancel

Response

The response will be a JSON object in the same format to the subscriber import show endpoint.

If the subscriber import cannot be cancelled (because it has finished), this endpoint will return a validation_failed error.

Read import logs

Subscriber imports generate a variety of logs. These logs can be accessed at the included URLs below.

URL

GET /ga/api/v2/subscriber_imports/:id/logs/added

GET /ga/api/v2/subscriber_imports/:id/logs/updated

GET /ga/api/v2/subscriber_imports/:id/logs/failed

GET /ga/api/v2/subscriber_imports/:id/logs/skipped_overwrite

GET /ga/api/v2/subscriber_imports/:id/logs/skipped_active

GET /ga/api/v2/subscriber_imports/:id/logs/skipped_unsubscribed

GET /ga/api/v2/subscriber_imports/:id/logs/skipped_scomp

GET /ga/api/v2/subscriber_imports/:id/logs/skipped_bounced

GET /ga/api/v2/subscriber_imports/:id/logs/skipped_deactivated

GET /ga/api/v2/subscriber_imports/:id/logs/skipped_duplicate

GET /ga/api/v2/subscriber_imports/:id/logs/skipped_over_limit

Types of logs

added

Email addresses that were added

updated

Email addresses that were updated

failed

A CSV file of failed rows in the import - the last column is an error message

skipped_overwrite

Email addresses that were skipped because overwriting is not enabled

skipped_active

Email addresses that were skipped because this import does not update active subscribers

skipped_unsubscribed

Email addresses that were skipped because this import does not update unsubscribed subscribers

skipped_scomp

Email addresses that were skipped because this import does not update spam complaint subscribers

skipped_bounced

Email addresses that were skipped because this import does not update bounced subscribers

skipped_deactivated

Email addresses that were skipped because this import does not update deactivated subscribers

skipped_duplicate

Email addresses that were skipped because the record was a duplicate found earlier in the file

skipped_over_limit

Email addresses that were skipped because the organization subscriber limit was reached

Response

For the log_failed endpoint, the response will be a CSV file. The last row will be the errors that prevented the subscriber record from being saved.

For the rest of the endpoints, the response will be a flat list of email addresses, separated by newlines, that meet the description listed above.

If the log file cannot be found, a not_found error will be returned. This can be the case in any of the following situations:

  • The import hasn’t yet started
  • The import has no logs for that classification, because no items in that classification were generated
  • The import has had its logs purged

Note: Logs are purged 7 days after the import finished running.


Copyright © 2012–2019 GreenArrow Email