List a subscriber import's failed rows

GET

/api/v3/contacts/imports/{importUniqueId}/errors

const url = 'https://api.tryletterhead.com/api/v3/contacts/imports/example/errors?api=true';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.tryletterhead.com/api/v3/contacts/imports/example/errors?api=true' \
  --header 'Authorization: Bearer <token>'

Returns the rows a subscriber import couldn’t process — the address that failed and why.

This is a company-level (v3) read. Authenticate with a company API key as a Bearer token.

Authorizations

bearerAuth

Parameters

Path Parameters

importUniqueId

required

string

The import’s unique identifier, from List subscriber imports.

Query Parameters

api

required

boolean

Required. Set to true.

page

integer

1-based page number. Minimum 1. Defaults to 1.

limit

integer

Rows per page. Minimum 1, maximum 100. Defaults to 25.

Responses

200

200 OK

application/json

object

items

Array<object>

object

email

string

code

A stable reason code, for example missing_email or upsert_failed.

string

description

string

nullable

message

string

total

integer

Example

{
  "items": [
    {
      "email": "not-an-email",
      "code": "missing_email",
      "description": "Row 42 had no usable email address."
    }
  ],
  "message": "Subscriber import errors retrieved.",
  "total": 1
}

Still can’t find what you need? Contact support.