Zum Inhalt springen
Esc
↑↓navigieren↵öffnen⌘Jvorschau

Start a verification

Starts deep verification of the target’s contacts, one run per 50,000 of them. Contacts verified before are skipped unless recheck is true, and a contact already being verified never joins a second run. Paid plans only; billed per verified address on the monthly invoice.

POST/verifications
Autorisierung
AuthorizationBearer-Token · headererforderlich

A BillionSend API key (bs_…).

Request-Body
erforderlichapplication/json
targetVerificationTargeterforderlich
Eigenschaften anzeigen
Genau eines von:
object
kindstringerforderlich
Erlaubt:contacts
contact_idsstring<uuid>[]erforderlich

Contacts of the team, by id

min. 1 Elemente · max. 50000 Elemente
object
kindstringerforderlich
Erlaubt:segment
segment_idstring<uuid>erforderlich

Every contact in this segment

object
kindstringerforderlich
Erlaubt:broadcast
broadcast_idstring<uuid>erforderlich

The broadcast's audience: the contacts it would mail, leaving out everyone who unsubscribed

recheckboolean

Verify contacts verified before too; by default they are skipped

Antworten
200

The runs started

objectstringerforderlich
Erlaubt:verification_start
runsobject[]erforderlich

The runs started, one per 50,000 contacts

Eigenschaften anzeigen
Array von object
idstring<uuid>erforderlich
totalintegererforderlich
contactsintegererforderlich

Contacts that joined a run

already_verifiedintegererforderlich

Contacts skipped because they were verified before (pass recheck to include them)

in_runintegererforderlich

Contacts skipped because a run already holds them

401

Missing, malformed, unknown or revoked API key

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
403

The team is on the Free plan (plan_limit_reached)

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
404

The segment or broadcast is not one of the team's

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
422

Nothing left to verify, too many contacts at once, or a validation error

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
429

Over the rate limit (rate_limit_exceeded, with Retry-After)

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
503

Deep verification is not available right now

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
Ausprobieren
Server
Autorisierung
Bodyapplication/json
Anfrage
curl -X POST 'https://api.billionsend.com/verifications' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "target": {
    "kind": "contacts",
    "contact_ids": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ]
  },
  "recheck": true
}'
Antwort
{
  "object": "verification_start",
  "runs": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "total": 0
    }
  ],
  "contacts": 0,
  "already_verified": 0,
  "in_run": 0
}

War diese Seite hilfreich?