跳到内容
Esc
↑↓导航↵打开⌘J预览

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
授权
AuthorizationBearer 令牌 · header必填

A BillionSend API key (bs_…).

请求体
必填application/json
targetVerificationTarget必填
显示属性
其中之一:
object
kindstring必填
允许值:contacts
contact_idsstring<uuid>[]必填

Contacts of the team, by id

最少 1 项 · 最多 50000 项
object
kindstring必填
允许值:segment
segment_idstring<uuid>必填

Every contact in this segment

object
kindstring必填
允许值:broadcast
broadcast_idstring<uuid>必填

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

响应
200

The runs started

objectstring必填
允许值:verification_start
runsobject[]必填

The runs started, one per 50,000 contacts

显示属性
object 数组
idstring<uuid>必填
totalinteger必填
contactsinteger必填

Contacts that joined a run

already_verifiedinteger必填

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

in_runinteger必填

Contacts skipped because a run already holds them

401

Missing, malformed, unknown or revoked API key

statusCodenumber必填
namestring必填
messagestring必填
403

The team is on the Free plan (plan_limit_reached)

statusCodenumber必填
namestring必填
messagestring必填
404

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

statusCodenumber必填
namestring必填
messagestring必填
422

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

statusCodenumber必填
namestring必填
messagestring必填
429

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

statusCodenumber必填
namestring必填
messagestring必填
503

Deep verification is not available right now

statusCodenumber必填
namestring必填
messagestring必填
试一试
服务器
授权
请求体application/json
请求
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
}'
响应
{
  "object": "verification_start",
  "runs": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "total": 0
    }
  ],
  "contacts": 0,
  "already_verified": 0,
  "in_run": 0
}

这个页面有帮助吗?