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

Estimate a verification

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

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

Antworten
200

The counts and the estimated cost

objectstringerforderlich
Erlaubt:verification_estimate
totalintegererforderlich

Contacts the target names

unverifiedintegererforderlich

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

in_runintegererforderlich

Of the unverified, already being verified

grant_remainingintegererforderlich

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

estimated_centsintegererforderlich

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

401

Missing, malformed, unknown or revoked API key

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
404

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

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
422

Validation error

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
429

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

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
Ausprobieren
Server
Autorisierung
Bodyapplication/json
Anfrage
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"
    ]
  }
}'
Antwort
{
  "object": "verification_estimate",
  "total": 0,
  "unverified": 0,
  "in_run": 0,
  "grant_remaining": 0,
  "estimated_cents": 0
}

War diese Seite hilfreich?