Check a batch before sending

GET/v1/batches/{id}/preflight

The checklist before Send out, and the most the batch can cost.

Path parameters

idstringrequired

The batch's ID, starting bat_.

Returns

200 application/json. The checks and the estimate.

Errors have one shape; see Errors for every code.

Code language

Request

curl "https://api.parasend.com/v1/batches/bat_01M6R27T8SXWNM911FS53W4S9F/preflight" \
  -H "Authorization: Bearer $PARASEND_KEY"

const res = await fetch('https://api.parasend.com/v1/batches/bat_01M6R27T8SXWNM911FS53W4S9F/preflight', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.PARASEND_KEY}`,
  },
});
const data = await res.json();

import os, requests

res = requests.get(
    "https://api.parasend.com/v1/batches/bat_01M6R27T8SXWNM911FS53W4S9F/preflight",
    headers={
        "Authorization": f"Bearer {os.environ['PARASEND_KEY']}",
    },
)
data = res.json()

using var http = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.parasend.com/v1/batches/bat_01M6R27T8SXWNM911FS53W4S9F/preflight");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", Environment.GetEnvironmentVariable("PARASEND_KEY"));
var response = await http.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

var request = HttpRequest.newBuilder(URI.create("https://api.parasend.com/v1/batches/bat_01M6R27T8SXWNM911FS53W4S9F/preflight"))
    .header("Authorization", "Bearer " + System.getenv("PARASEND_KEY"))
    .GET()
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

$client = new GuzzleHttp\Client();
$response = $client->request('GET', 'https://api.parasend.com/v1/batches/bat_01M6R27T8SXWNM911FS53W4S9F/preflight', [
    'headers' => [
        'Authorization' => 'Bearer ' . getenv('PARASEND_KEY'),
    ],
]);
$data = json_decode($response->getBody(), true);

Response · 200

{
  "object": "batch_preflight",
  "ready": true,
  "checks": [
    {
      "id": "recipients",
      "ok": true,
      "total": 2,
      "to_send": 2,
      "row_errors": 0
    },
    {
      "id": "documents",
      "ok": true,
      "without_documents": 0
    },
    {
      "id": "brand",
      "ok": true,
      "brand_profile_id": null,
      "name": null
    },
    {
      "id": "policy",
      "ok": true,
      "follow_up_policy_id": null,
      "name": null,
      "steps": [],
      "own_policy": 0
    },
    {
      "id": "expiry",
      "ok": true,
      "steps_after_expiry": 0
    },
    {
      "id": "test_send",
      "ok": null,
      "available": true,
      "last_sent_at": null
    }
  ],
  "estimate": {
    "currency": "ISK",
    "amount": 622,
    "vat": 149,
    "total_amount": 771,
    "items": [
      {
        "kind": "delivery",
        "description": {
          "is": "Sending",
          "en": "Delivery"
        },
        "country": null,
        "quantity": 2,
        "unit_amount": 311,
        "amount": 622,
        "vat": 149,
        "total_amount": 771
      }
    ],
    "maximum": true,
    "lookups": 0
  }
}