Saltar al contenido
Esc
↑↓navegar↵abrir⌘Jvista previa

Estimate a verification

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

POST/verifications/estimate
Autorización
AuthorizationToken Bearer · headerobligatorio

A BillionSend API key (bs_…).

Cuerpo de la solicitud
obligatorioapplication/json
targetVerificationTargetobligatorio
Mostrar propiedades
Exactamente uno de:
object
kindstringobligatorio
Valores permitidos:contacts
contact_idsstring<uuid>[]obligatorio

Contacts of the team, by id

mín. 1 elementos · máx. 50000 elementos
object
kindstringobligatorio
Valores permitidos:segment
segment_idstring<uuid>obligatorio

Every contact in this segment

object
kindstringobligatorio
Valores permitidos:broadcast
broadcast_idstring<uuid>obligatorio

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

Respuestas
200

The counts and the estimated cost

objectstringobligatorio
Valores permitidos:verification_estimate
totalintegerobligatorio

Contacts the target names

unverifiedintegerobligatorio

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

in_runintegerobligatorio

Of the unverified, already being verified

grant_remainingintegerobligatorio

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

estimated_centsintegerobligatorio

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

401

Missing, malformed, unknown or revoked API key

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
404

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

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
422

Validation error

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
429

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

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
Pruébalo
Servidor
Autorización
Cuerpoapplication/json
Solicitud
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"
    ]
  }
}'
Respuesta
{
  "object": "verification_estimate",
  "total": 0,
  "unverified": 0,
  "in_run": 0,
  "grant_remaining": 0,
  "estimated_cents": 0
}

¿Te ha resultado útil esta página?