Update a batch

patch

https://api.wingspan.app/v3/platform/batches/{batchId}

Update the mutable fields of a Batch: externalId, name, notes and metadata. metadata is merged into the existing map; omitted fields are left unchanged. Allowed in any status.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

batchId

string

required

Body Params

Mutable fields of a Batch: externalId, name, notes and metadata. Omitted fields are left unchanged. metadata keys are merged into the existing map; keys not in the request are kept. A key the batch uses to hold its configuration is rejected with 422 ValidationError: payableStatus for PayableImport, and engagementId, payeeContext and isV3Batch for PayeeImport. type and configuration cannot change after creation.

externalId

string

Customer's own id for reconciliation. Unique within the account.

name

string

Display name of the batch. An empty string clears it.

notes

string

Free-text notes about the batch. An empty string clears them.

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

length between 1 and 255

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

Optional idempotency token for authenticated POST and PATCH requests. Reusing the same key and body returns the cached response for 24 hours, except credential operations that explicitly document a 409 because one-time secret material is never cached; reusing it with a different body returns 409 IdempotencyKeyConflict. 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

200Updated batch

400Malformed request syntax

401Unauthenticated

403Forbidden

404Resource not found

422Validation error