List addresses a quality pause flagged

List addresses a quality pause flagged

GET/api/v1/email/campaigns/{id}/quality/affected

GET /email/campaigns/{id}/quality/affected
curl -X GET 'https://www.unitpost.com/api/v1/email/campaigns/cmp_123/quality/affected' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0'
Response · 200
{
  "object": "list",
  "has_more": false,
  "data": [
    {
      "object": "campaign_affected_recipient",
      "email": "customer@example.com",
      "contact_id": "contact_123",
      "reason": "hard_bounce"
    }
  ]
}

After an automatic quality pause: the recipients whose message hard-bounced (hard_bounce) or drew a spam complaint (complaint). They're already suppressed; this is for cleaning the source list. By address, limit per page (default and most 10,000); when has_more, pass the last row's email as after for the rest. Take them out of the campaign's segment with Remove flagged addresses. Requires the campaigns:read capability.

Parameters3 fields
FieldTypeDescription
idrequiredstring · path—
limitinteger · queryAddresses per page, 1–10,000 (default 10,000).
afterstring · queryThe last row's `email` from the previous page.
Response · 200 fields4 fields
FieldTypeDescription
objectrequiredstring—
emailrequiredstring—
contact_idrequiredstring | null—
reasonrequiredenumhard_bounce | complaintThe address doesn't exist (`hard_bounce`), or the person marked it as spam.
200401403404422503

Search docs and guides

Search the docs and product guides.