Create a batch

post

https://api.wingspan.app/v3/platform/batches

Create an empty Batch. type is immutable and determines the configuration and item data shapes the batch accepts; items are added one at a time with POST /platform/batches/{batchId}/items. Idempotency-Key is required; repeating a request with the same key returns the original batch. externalId is the caller's own reconciliation id and is echoed on read. Supplying an externalId already in use for this account returns 409 ResourceConflict — create is not an upsert.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

type

string

enum

required

Allowed:

configuration

object

required

Settings for a PayeeImport batch. context is required. When engagementId is also given, that engagement's type must agree with context (only an Employee engagement agrees with Employee), or the create is rejected with 422.

externalId

string

Customer's own id for reconciliation.

name

string

Display name of the batch.

notes

string

Free-text notes about the batch.

metadata

object

Free-form key-value pairs. Max 50 keys; key length at most 40 characters; value length at most 500 characters. Where a list endpoint declares metadata filtering, it uses the QueryQL namespace via filter[metadata.{key}][eq]=value or filter[metadata.{key}][in][]=value. Endpoints that do not declare the dynamic Metadata filter do not support Metadata filtering.

Headers

Idempotency-Key

string

required

length between 1 and 255

^[\x21-\x7e]{1,255}$

REQUIRED idempotency token for money-moving requests (e.g. transfers). The token is used by the API so a retry after a 5xx/timeout replays the original result instead of moving funds twice. Reuse the same key to retry safely; use a NEW key to issue a genuinely new transfer. Use 1-255 printable ASCII characters.

X-Wingspan-Account

string

^(?:[A-Za-z0-9_.]{22}|[a-f0-9]{24})$

Select the Account for an Account-scoped operation. A direct ServiceAccount API key MUST supply this header, and the target must be within the ServiceAccount owner's or Authorization grant's Account boundary. A Person bearer may select an Account on which it has an active Stakeholder, and an Account session may select its bound Account (or a descendant only when the session explicitly includes descendants).

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

201Batch created

401Unauthenticated

403Forbidden

409Conflict

422Validation error