Create a New Batch

Create a new Customer Batch

post

Creates a new new batch. Called by frontend when the user is submitting a batch request.

Body
batchServiceIdstring · uuidRequired

The id of the batch service to use

Example: 8600aa22-e4bf-4fe3-96be-7978832807a0
userBatchReferencestring · min: 1 · max: 255Required

A user supplied reference for the batch

Example: customer_vehicle_registration_statuses-sep_2022
emailstring · emailOptional

The designated email for recieving batch status updates

Example: john.smith@company.co.nz
scheduledDateanyOptional

A user supplied date to begin processing

Example: 2023-01-01T00:00:00Z
Responses
201

Response after a batch is created

application/json
post
POST /batch/v1/batches HTTP/1.1
Host: api.tst.motorweb.app
Content-Type: application/json
Accept: */*
Content-Length: 202

{
  "batchServiceId": "8600aa22-e4bf-4fe3-96be-7978832807a0",
  "userBatchReference": "customer_vehicle_registration_statuses-sep_2022",
  "email": "john.smith@company.co.nz",
  "scheduledDate": "2023-01-01T00:00:00Z"
}
{
  "url": "https://storage.googleapis.com/user-upload/123-2022-08-08T22:22:21-qwerty.csv?X-Goog-Algorithm= GOOG4-RSA-SHA256&X-Goog-Credential=example%40batch-self-service.iam.gserviceaccount.com%2F20181026%2Fus-central1%2Fstorage%2Fgoog4_request&X-Goog-Date=20221026T18 1309Z&X-Goog-Expires=900&X-Goog-SignedHeaders=host&X-Goog-Signature=247a2aa45f16 2ea7abedc098d2eb14a7",
  "expiry": "123-2022-08-09T06:22:21",
  "batchId": "c87e2a4a-5169-4726-b078-7e9538ae28cd"
}
PreviousManaging a Batch Job APIsNextGet Information about a specific Batch

Last updated