Create a business batch

POST

https://api.middesk.com/v1/business_batches

POST

/v1/business_batches

1 curl -X POST https://api.middesk.com/v1/business_batches \
2      -H "Content-Type: application/json" \
3      -u "<username>:<password>" \
4      -d '{
5   "name": "Q1-2025-Verification-Batch",
6   "filename": "businesses.csv",
7   "csv": "bmFtZSxhZGRyZXNzX2xpbmUxLGFkZHJlc3NfY2l0eSxhZGRyZXNzX3N0YXRlCkFjbWUgQ29ycG9yYXRpb24sMTIzIE1haW4gU3RyZWV0LFNhbiBGcmFuY2lzY28sQ0EK"
8 }'

Try it

200Business batch request

1 {
2   "object": "business_batch",
3   "id": "e1f2a3b4-c5d6-7890-4567-89abcdef0123",
4   "name": "Q1-2025-Verification-Batch",
5   "filename": "businesses.csv",
6   "business_count": 1,
7   "completed_business_count": 0,
8   "created_at": "2025-01-07T12:00:00.000Z",
9   "account": {
10     "id": "f2a3b4c5-d6e7-8901-5678-9abcdef01234",
11     "name": "Example Account",
12     "slug": "example-account",
13     "pilot": false
14   }
15 }

Authentication

AuthorizationBasic

Basic authentication of the form Basic <username:password>.

Request

This endpoint expects an object.

namestringRequired

Name for the business batch

filenamestringRequired

CSV filename

csvstringRequired

Base64 encoded CSV data

Response

business batch created

Authentication

Request

Response

Errors