Bulk respond to customer agreements

Changed on Nov 6, 2026

Accept or reject up to 50 agreements within a single working set in one call. The request is scoped by the partner-supplied reference; each actions[] item carries an agreementId (UUID) and a type (ACCEPT or REJECT). Per-item outcomes are returned as a paginated list of AgreementActionResult: successful items have a status; failed items have an error.

post/platform/v2/agreements/actions

Request

Base URL
https://api.sandbox.bvnk.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/bvnk/apis/bvnk-api-endpoints/docs/platform/v2/agreements/actions/post.ts
A function with typed inputs. Its response is checked against the schema.

Headers

Idempotency-Keystring uuid required

Example:1e74002e-74a1-48fd-b707-147c3187a3e1

Client-generated unique identifier for the request in UUID format. Ensures that retried requests are not processed more than once.

Request body

referencestring required

Partner-supplied reference that identifies the working set. Must match the value used when the working set was created.

Response

Per-item action results

totalElementsinteger

totalPagesinteger

hasNextboolean

Changes

Nov 6, 2026c386d436bf2c Revision changes
- info
  added the non-success response with the status
Jun 16, 202697d6c0d2fe2e Revision changes
- info
  endpoint added

Operation history