Mailing lists are entities that hold a list of recipients created from either Contacts or Mailing List Imports and are used to send orders in bulk.
To begin populating a mailing list, use the Create Job endpoint to add or remove either Contacts or Mailing List Imports by their unique identifiers (beginning with either contact_ or mailing_list_import_). "Contact" and "Mailing List Import" entities must be created and processed before being added to a mailing list.
To create specific sender contacts for each recipient, create a Mailing List Import with unique senders for each recipient, and add this mailing list import to your mailing list.
Mailing List Response
| Name | Type | Description |
|---|---|---|
| id | string | A unique ID prefixed with mailing_list_ |
| object | string | Always mailing_list |
| live | boolean | true if this is a live mode mailing list else false |
| description | string or undefined | Optional description for mailing list |
| metadata | object or undefined | See metadata |
| errors | array of objects with a type and message | Errors encountered when processing mailing list |
| status | creating_contacts, removing_contacts, orcompleted | Processing status of mailing list |
Processing Errors
Errors that may be encountered when processing jobs for mailing lists are detailed below. Error information and processing status can be retrieved for mailing lists using the Get Mailing List and List Mailing Lists endpoints.
| Type | Description |
|---|---|
mailing_list_imports_not_found_error | The mailing list import specified in the request was not found |
download_file_error | An error occurred when downloading the file for the mailing list import |
operational_error | General error operational errors such as entities not found |
internal_service_error | Something went wrong on PostGrid's side |