v1

latestOpenAPI 3.0.02026-07-2664192238.8 KB
Batch

Create batch

Batch operations allow for multiple actions of a similar type to be executed in a single request. Utilizing the batch endpoint is recommended to avoid hitting rate limits and to enhance overall performance.

Creating batches is an asynchronous process that initiates the creation or updating of the specified items.

  • POST batch operations to create multiple items simultaneously.
  • PUT batch operations to apply multiple updates to multiple items. Each batch operation can include up to 100 actions.

The required scopes depend on the type of batch operation being performed.

WARNING: Before sending a batch of events, ensure there are no automations configured in Omnisend that could send messages to customers based on the imported data. This could result in duplicate messages being sent to customers.

Scopes:

products.write, contacts.write, events.write

<br><a href="https://www.postman.com/omnisend-api/workspace/omnisend/overview" target="_blank">Open Postman collection</a>

post/batches

Headers

Omnisend-Versionstring required

API version that specifies the response format and behaviour

Request body

endpoint'products' | 'contacts' | 'events' | 'categories' required
method'POST' | 'PUT' required
originstring

Example request

{
  "endpoint": "contacts",
  "method": "POST",
  "origin": "omnisend"
}

Response

Batch created successfully with the given ID

batchIDstring
totalCountinteger