GreenArrow Email Software Documentation

Seed Lists API

Seed List Attributes

id

integer

The id of the seed list

name

string

The name of the seed list

addresses_array

array of strings

The list of addresses

Get a List of Seed Lists

Get a list of the basic details of all seed lists available to user’s organization.

URL

GET /ga/api/v2/seed_lists

Request Parameters

order_by

string

Specify a seed list field to sort the results by. Can be name or id. name will be ordered case-insensitively.

Defaults to id.

Response

The response will be a JSON array where each element contains the “Seed List Attributes” listed above.

This endpoint returns paginated records with a default page size of 2000.

Example

Note that the JSON response will not be “pretty formatted” as it is below.

GET /ga/api/v2/seed_lists

HTTP/1.1 200 OK

{
  "success": true,
  "data": [
    {
      "id": 34,
      "name": "GreenArrow Monitor",
      "addresses_array": [
        "[email protected]",
        "[email protected]"
      ]
    },
    {
      "id": 35,
      "name": "Deliverability Analysis",
      "addresses_array": [
        "[email protected]",
        "[email protected]"
      ]
    },
    {
      "id": 36,
      "name": "External List",
      "addresses_array": [
        "[email protected]",
        "[email protected]"
      ]
    }
  ],
  "error_code": null,
  "error_message": null,
  "page": 0,
  "per_page": 2000,
  "num_records": 3,
  "num_pages": 1
}

Create a New Seed List

URL

POST /ga/api/v2/seed_lists

Request Parameters

This API method accepts the parameters listed in the “Seed List Attributes” section above within the seed_list key.

Response

The response will be the “Seed List Attributes” listed above.

Example

Note that the JSON response will not be “pretty formatted” as it is below.

POST /ga/api/v2/seed_lists

{
  "seed_list": {
    "name": "My new seed list",
    "addresses_array": [
      "[email protected]",
      "[email protected]"
    ]
  }
}

HTTP/1.1 200 OK

{
  "success": true,
  "data": {
    "id": 40,
    "name": "My new seed list",
    "addresses_array": [
      "[email protected]",
      "[email protected]"
    ]
  },
  "error_code": null,
  "error_message": null
}

Update an Existing Seed List

URL

PUT /ga/api/v2/seed_lists/:id

Request Parameters

This API method accepts the parameters listed in the “Seed List Attributes” section above within the seed_list key.

Response

The response will be the “Seed List Attributes” listed above.

Example

Note that the JSON response will not be “pretty formatted” as it is below.

PUT /ga/api/v2/seed_lists/41

{
  "seed_list": {
    "name": "My updated seed list"
  }
}

HTTP/1.1 200 OK

{
  "success": true,
  "data": {
    "id": 41,
    "name": "My updated seed list",
    "addresses_array": [
      "[email protected]",
      "[email protected]"
    ]
  },
  "error_code": null,
  "error_message": null
}

Delete a Seed List

Seed lists that are currently used by other records may not be deleted.

URL

DELETE /ga/api/v2/seed_lists/:id

Request Parameters

This API method does not require any additional parameters.

Response

The response will be an empty successful response.

Example

Note that the JSON response will not be “pretty formatted” as it is below.

DELETE /ga/api/v2/seed_lists/44

HTTP/1.1 200 OK

{
  "success": true,
  "data": null,
  "error_code": null,
  "error_message": null
}


Copyright © 2012–2019 GreenArrow Email