Update a dynamic field of a document.

Find the download URL of the latest revision of the document.

Finds a dynamic field of a document.

Finds all dynamic fields for the selected document.

Removes the specified tags from contacts selected by contact IDs, emails, phone numbers or a segment.

Create a copy of an existing automation workflow.

Create a new automation workflow.

Creates a new email campaign in Omnisend. The campaign will be created as a draft and can be scheduled or sent immediately.

Declares a new brand-custom event schema.

Creates a new product

Creates a new segment.

With this endpoint you can create a new universal layout.

Permanently deletes a campaign from your Omnisend account by its ID. Warning: this action cannot be undone.

Deletes an image from your Omnisend image library by its ID.

With this endpoint you can delete product category.

With this endpoint you can delete a universal layout by ID.

Enable an automation workflow. Once enabled, the workflow starts processing trigger events in real time.

Retrieve UTM tracking tags for all send-action blocks in an automation. Each block's tags include default-value synthesis for missing fields.

Get batches. This endpoint is rate limited to 400 requests per minute.

Get batch items by batch id

Returns the contact with the specified ID.

Get product category by ID.

With this endpoint you can get a universal layout by ID.

Retrieve UTM tracking tags for a specific send-action block. Missing or cleared tags are returned with their default values.

List automation workflows with filtering, sorting, and cursor-based pagination.

Returns a paginated list of contacts filtered by the provided query parameters.

List products categories

Returns event metadata entries for the given category, optionally filtered by event names and/or origins.

Renders an email template by ID and returns the full HTML output. Useful for previewing template content or passing rendered HTML to other steps in your Zap.

Replace product by ID

Manually pick a variant as the winner. The chosen variant is routed into the send pipeline immediately.

Render the campaign draft and email it to up to 5 recipients so the merchant (or their AI tool) can preview it without leaving the API. The test uses the campaign's saved subject, sender, and content; only email campaigns are supported.

Halt the A/B test winner-selection phase. While stopped, automatic winner selection no longer considers this campaign until it is resumed. Available only while the campaign is in started status.

Replace UTM tag settings for a campaign. For regular campaigns send a tags object. For A/B test campaigns send a variants object. The campaign must be in draft status.

Updates the contact matching the provided email address.

With this endpoint you can update (fully replace) email content by ID. The full content structure must be provided in the request body.

Update product category by ID.

With this endpoint you can update (fully replace) a universal layout by ID.

Uploads an image to your Omnisend image library, making it available for use in email templates.

Returns a list of campaigns from your Omnisend account. Supports filtering by status, channel, name, and date ranges.

Returns a list of email templates from your Omnisend account. Supports filtering by name and sorting by creation date or name.

Returns a single segment from your Omnisend account by its ID.

Returns statistics for a segment, including the total number of matching contacts.

Update a party of a document.

Finds a specific metadata value of a document.

Finds the signatories of a document.

Adds the specified tags to contacts selected by contact IDs, emails, phone numbers or a segment.

Cancels a scheduled, sending, or paused campaign. Note: for campaigns that are already sending, cancellation is best-effort — messages already in flight may still be delivered.

Creates a draft copy of an existing campaign, including its content, audience, and settings. The copied campaign name will be prefixed with "Copy of: ".

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.

Send new customer event

With this endpoint you can create a new email template.

Creates a new product category

Creates or updates a subscriber with all provided values, i.e. name, phone number, tag, etc. Use tag to be able to add subscribers to segment in Omnisend.

Delete a single automation workflow by ID. This operation is idempotent — deleting a non-existent automation returns a success response.

Permanently deletes an email template from your Omnisend account by its ID. Warning: this action cannot be undone.

Delete product by ID

Permanently deletes a segment from your Omnisend account by its ID. Note: segments that are currently being built cannot be deleted.

Disable an automation workflow. Once disabled, the workflow stops accepting new trigger events.

Returns a single image from your Omnisend image library by its ID.

Get a single automation workflow by ID.

Get batch information

Campaign ID (24 character hexadecimal)

With this endpoint you can get email content by ID.

Get product by it's ID

Returns a segment by its unique identifier.

With this endpoint you can get a paginated list of universal layouts.

Imports an email template from raw HTML content into Omnisend. The HTML will be parsed and structured into a reusable template.

List campaigns with filtering, sorting, and cursor-based pagination.

List products of store

Partially update an automation workflow. Only the fields provided in the request body are updated.

With this endpoint you can render email content to HTML by ID. The content is rendered with an empty data context (no contact, no marketing activity).

Replace the full block tree for an automation workflow.

Resume a stopped A/B test. Automatic winner selection becomes eligible to pick this campaign again. Available only while the campaign is in stopped status.

Starts the sending process for a campaign. Immediate campaigns are sent right away; scheduled campaigns are queued for their scheduled send time.

Send the saved email content of a specific email block as a test email to up to 5 recipients. The email is rendered and delivered asynchronously.

Updates an existing draft campaign in Omnisend. Only campaigns in draft status can be updated. Note: sending settings use full object replacement — if updating any sending setting, all sending fields must be provided.

Updates the contact with the specified ID.

Merges changes into an existing brand-custom event, identified by name and origin

With this endpoint you can update (fully replace) an email template by ID.

Updates an existing segment by ID. The segment must not be in a building state to be updated. If the segment is currently being built, a 409 Conflict error is returned.

Set UTM tracking tags for a specific send-action block. All three tag fields are replaced atomically. Send an empty string to clear a field — the next read will return its default value.

Returns a single campaign from your Omnisend account by its ID.

Returns a single email template from your Omnisend account by its ID.

Returns a list of images from your Omnisend image library. Optionally filter by name or other parameters.

Returns a list of segments from your Omnisend account. Supports filtering by name and sorting by creation date or name.