Intelliprint
Browse API reference
Mailing Lists

Mailing Lists

Retrieve a mailing list

gethttps://api.intelliprint.net/v1/mailing_lists/{id}

Retrieves a mailing list by ID.

Parameters

Path

idrequired
string

The ID of the mailing list to retrieve.

Responses

Sample JSON for every response shape is in the right rail. Expand a row below to see every field this endpoint can return.

200Successful response
id
string

A globally unique identifier for the mailing list.

Example"mal_eg"
object
string

The object type. Always mailing_list.

Allowed valuesmailing_list
account
string

The Intelliprint account ID that the mailing list belongs to.

Example"acc_eg"
name
string

A user-friendly name for this mailing list. This name is displayed in the dashboard.

Example"Black Friday Leads"
recipients
integer

The number of recipients present in the mailing list. This value is updated automatically when recipients are added or removed from the mailing list.

Example1000
variables
array of object

An array of the dynamic fields present in the mailing list. Dynamic fields are used to tailor templates uniquely for each recipient.

Array of object.
namestring

The name of the dynamic field. This is the value without the curly braces. For example, if the dynamic field is {exampleA}, the name will be exampleA.

Example"salutation"
longest_address_line
string

This is the longest address line present across all recipients in the mailing list. We keep track of this to ensure the address box on postcard templates is large enough to fit the longest address.

Example"123 Main St, Anytown, Anyplace"
address_validation
object

Address validation is a value-added service that we offer to ensure your mailings are only charged for and sent to real, deliverable addresses. Please contact us at hello@intelliprint.net to enable this service for your account.

requestedboolean

Whether address validation has been requested for the mailing list.

Defaultfalse
Examplefalse
completedboolean

Whether all addresses in the mailing list have been validated.

Defaultfalse
Examplefalse
recipientsobject

The number of recipients that have passed or failed address validation.

passedinteger

The number of recipients that have passed address validation.

Default0
Example0
failedinteger

The number of recipients that have failed address validation.

Default0
Example0
created
integer<int64>

The UNIX timestamp of when the mailing list was created. We use UNIX timestamps to avoid timezone-based issues.

Example1761955200
400Example error response
error
object
messagestring

A human-readable message describing the error. You can display this to your users to help them understand what went wrong.

Example"Received unknown parameter: testmood (Did you mean testmode?)"
typestring

The general category of the error.

Allowed valuesinvalid_request_errorauthentication_errorpayment_errorrate_limitedinternal_error
Example"invalid_request_error"
codestring

A unique code for the specific error that occurred.

Allowed valuesparameter_invalidparameter_missingparameter_unknownbody_too_largebody_incorrect_formatno_api_keyinvalid_api_keylogged_outforbiddenpayment_errornot_foundrate_limitedrefusedinternal_error
Example"parameter_unknown"
paramstring

The parameter that caused the error, if applicable.

Example"testmood"