Batch Operation

Performs multiple record operations in a single transaction.

Path parameters

vaultIDstringRequired
ID of the vault.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
recordslist of objectsOptional
Record operations to perform.
continueOnErrorbooleanOptional
Continue performing operations on partial errors.
byotenumOptionalDefaults to DISABLE

Token insertion behavior.

  • DISABLE: Tokens aren’t allowed for any fields. If tokens are specified, the request fails.
  • ENABLE: Tokens are allowed—but not required—for all fields. If tokens are specified, they’re inserted.
  • ENABLE_STRICT: Tokens are required for all fields. If tokens are specified, they’re inserted. If not, the request fails.
Allowed values:

Response

A successful response.
vaultIDstring or null
ID of the vault.
responseslist of maps from strings to any or null

Responses in the same order as in the request. Responses have the same payload structure as their corresponding APIs:

  • POST returns an Insert Records response.
  • PUT returns an Update Record response.
  • GET returns a Get Record response.
  • DELETE returns a Delete Record response.

Errors