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

Estimate a verification

How many of the target’s contacts were never verified and what verifying them would cost. Changes nothing.

POST/verifications/estimate
授权
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

响应
200

The counts and the estimated cost

objectstring必填
允许值:verification_estimate
totalinteger必填

Contacts the target names

unverifiedinteger必填

Of them, never verified: what a start would verify (verified ones are skipped)

in_runinteger必填

Of the unverified, already being verified

grant_remaininginteger必填

Free verification credit left this quota month, which a run uses first

estimated_centsinteger必填

What verifying the unverified would cost past the credit, in cents

401

Missing, malformed, unknown or revoked API key

statusCodenumber必填
namestring必填
messagestring必填
404

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

statusCodenumber必填
namestring必填
messagestring必填
422

Validation error

statusCodenumber必填
namestring必填
messagestring必填
429

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

statusCodenumber必填
namestring必填
messagestring必填
试一试
服务器
授权
请求体application/json
请求
curl -X POST 'https://api.billionsend.com/verifications/estimate' \
  -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"
    ]
  }
}'
响应
{
  "object": "verification_estimate",
  "total": 0,
  "unverified": 0,
  "in_run": 0,
  "grant_remaining": 0,
  "estimated_cents": 0
}

这个页面有帮助吗?