Get a bulk import's verify stats (sendable / suppressed / pending)

GET

people

bulk

{id}

import { createClient } from "@norbelys/sdk";

const norbelys = createClient({ apiKey: process.env.NORBELYS_API_KEY });

const { data, error } = await norbelys.people.getBulk("con_b2n4x8mq1w7e");
if (error) {
  throw new Error(error.error.message);
}
console.log(data);

{
  "created": 412,
  "id": "imp_tz4a98xat96iws9zmbrgj3a",
  "pending": 62,
  "processed": 350,
  "reasons": [
    {
      "count": 12,
      "outcome": "sendable",
      "reasonCode": "no_mail_server"
    }
  ],
  "sendable": 300,
  "status": "processing",
  "suppressedExisting": 10,
  "suppressedNew": 40,
  "object": "person_import"
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Org-scoped Norbelys API key. Create one in Settings → API keys and send it as Authorization: Bearer ak_….

Path Parameters

string

required

The resource id (path).

Response

created

integer

required

New people this import inserted.

Required range: x >= 0

Example:

412

string

required

The import id.

Example:

"imp_tz4a98xat96iws9zmbrgj3a"

pending

integer

required

Created people still awaiting a verdict (created − processed).

Required range: x >= 0

Example:

62

processed

integer

required

How many of the created people have been verified so far.

Required range: x >= 0

Example:

350

reasons

PersonImportReason · object[]

required

The cleaning report: WHAT the verification found, per reason — which addresses were removed as dead domains, likely typos, disposables, previously bounced, and so on. Ordered by count, descending.

Show child attributes

sendable

integer

required

Verified and safe to email.

Required range: x >= 0

Example:

300

status

enum<string>

required

processing while addresses are still being verified, completed once every created person has a verdict.

Available options:

processing,

completed

suppressedExisting

integer

required

Already on the suppression list before the import, so verification was skipped.

Required range: x >= 0

Example:

10

suppressedNew

integer

required

Newly suppressed by an undeliverable verdict.

Required range: x >= 0

Example:

40

object

any

default:person_import

Always "person_import". Identifies the resource type.

import { createClient } from "@norbelys/sdk";

const norbelys = createClient({ apiKey: process.env.NORBELYS_API_KEY });

const { data, error } = await norbelys.people.getBulk("con_b2n4x8mq1w7e");
if (error) {
  throw new Error(error.error.message);
}
console.log(data);

{
  "created": 412,
  "id": "imp_tz4a98xat96iws9zmbrgj3a",
  "pending": 62,
  "processed": 350,
  "reasons": [
    {
      "count": 12,
      "outcome": "sendable",
      "reasonCode": "no_mail_server"
    }
  ],
  "sendable": 300,
  "status": "processing",
  "suppressedExisting": 10,
  "suppressedNew": 40,
  "object": "person_import"
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

Analytics

Domains

Fields

Files

Groups

Integrations

Messages

Organization

People

Programs

Segments

Senders

Suppressions

Verify

Get a bulk import's verify stats (sendable / suppressed / pending)

Authorizations

Path Parameters

Response