Skip to content
Changelog

Report a bug

Omnisend integration: operations for AI agents

Omnisend connects to Type.com as an integration. This page lists the 105 operations documented for Claude and Codex in Type.com: 37 read, 48 write, 20 destructive.

About Omnisend

Omnisend is a marketing automation platform for ecommerce businesses, focusing on email and SMS marketing.

Categories: Marketing & Social

How to connect Omnisend to Type.com

Access
Organization connection: one shared account for the workspace.

To add the connection, follow the steps in Space connections.

Documented operations

105 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.

105 operations listed.

Accounts

  • Write

    Create account

    Create a new Omnisend account with a primary user and brand. Returns identifiers needed for subsequent session and brand operations. Scopes: accounts.write

Brands

  • Read

    Get information about brand

    With this endpoint you can get brand's information. Scopes: brands.read Rate Limiting: This endpoint is rate limited to 400 requests per minute. Open Postman collection

  • Write

    Update brand

    Update brand information. All fields are optional — include only the fields you want to change. Scopes: brands.write

  • Write

    Connect brand

    With this endpoint you can connect your site to Omnisend. Note it's only possible to connect store with oAuth flow. Scopes: brands.write Rate Limiting: This endpoint is rate limited to 400 requests per minute. Open Postman collection

Sessions

  • Write

    Create session token

    Create a one-time login token. Use this token in the session creation endpoint to log the user in and redirect them to Omnisend. Scopes: sessions.write

  • Write

    Create session from token

    Exchange a one-time login token for a browser session. On success the user is redirected (302) to Omnisend with session cookies set. This endpoint must be called from the user's browser (e.g. via a form POST) so that cookies are stored in the browser context.

Reports

  • Write

    Generate report

    Returns aggregated marketing analytics grouped by message send date. Covers delivery, engagement, and revenue attribution metrics for campaigns and automations. Supports optional dimensions (timestamp, channel, activity), filters, and up to 4 queries per request.

Statistics

  • Write

    Generate report

    Returns aggregated marketing analytics grouped by event date (when opens, clicks, orders actually occurred). Covers delivery, engagement, revenue attribution, and audience growth metrics. Requires a timestamp dimension.

Batch

  • Read

    Get batches

    Get batches Scopes: products.read, contacts.read, events.read Rate Limiting: This endpoint is rate limited to 400 requests per minute. Open Postman collection

  • Read

    Get batch information

    Get batch information Scopes: products.read, contacts.read, events.read Rate Limiting: This endpoint is rate limited to 400 requests per minute. Open Postman collection

  • Read

    Get batch items

    Get batch items Scopes: products.read, contacts.read, events.read Rate Limiting: This endpoint is rate limited to 400 requests per minute. Open Postman collection

  • Write

    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.

Contacts

  • Read

    List contacts

    Returns a paginated list of contacts filtered by the provided query parameters. Scopes: contacts.read Rate Limiting: This endpoint is rate limited to 400 requests per minute. Filter restrictions: - tag and status cannot be used together in the same request.

  • Read

    Get contact

    Returns the contact with the specified ID. Scopes: contacts.read Rate Limiting: This endpoint is rate limited to 400 requests per minute.

  • Write

    Create or update existing contact

    Creates a new contact. If a contact with the provided email identifier already exists, it will be updated instead. Returns 201 Created for new contacts and 200 OK when an existing contact was updated.

  • Write

    Update contact by email

    Updates the contact matching the provided email address. Scopes: contacts.write Rate Limiting: This endpoint is rate limited to 400 requests per minute.

  • Write

    Update contact by ID

    Updates the contact with the specified ID. Scopes: contacts.write Rate Limiting: This endpoint is rate limited to 400 requests per minute.

  • Write

    Batch add tags

    Adds the specified tags to contacts selected by contact IDs, emails, phone numbers or a segment. At least one of contactIDs, emails, phones or segmentID is required.

  • Destructive

    Batch remove tags

    Removes the specified tags from contacts selected by contact IDs, emails, phone numbers or a segment. At least one of contactIDs, emails, phones or segmentID is required.

Email Content

  • Read

    Get email content

    With this endpoint you can get email content by ID. Content of a campaign that has started sending is locked: its universal layout sections keep the layout content the email was sent with, and it cannot be updated.

  • Write

    Render email content

    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). Scopes: email-templates.write Rate Limiting: This endpoint is rate limited to 40 requests per minute.

  • Destructive

    Update email content

    With this endpoint you can update (fully replace) email content by ID. The full content structure must be provided in the request body. Scopes: email-templates.write Rate Limiting: This endpoint is rate limited to 400 requests per minute.

Email Templates

  • Read

    Get email templates

    With this endpoint you can get a paginated list of email templates. Sorting: Use sort and direction to control the order of results. Supported sort fields: createdAt (default), name. Supported directions: asc, desc (default).

  • Read

    Get email template

    With this endpoint you can get email template by ID. Scopes: email-templates.read Rate Limiting: This endpoint is rate limited to 400 requests per minute.

  • Write

    Create email template

    With this endpoint you can create a new email template. Scopes: email-templates.write Rate Limiting: This endpoint is rate limited to 400 requests per minute.

  • Write

    Render email template

    With this endpoint you can render an email template by ID and get the full HTML body for preview purposes. Scopes: email-templates.write Rate Limiting: This endpoint is rate limited to 40 requests per minute.

  • Write

    Import email template from HTML

    With this endpoint you can import email template from raw HTML content. The HTML will be parsed, styles extracted, and structured into a template. Request body size limit: 1 MB Scopes: email-templates.write Rate Limiting: This endpoint is rate limited to 400 requests per minute.

  • Destructive

    Update email template

    With this endpoint you can update (fully replace) an email template by ID. Scopes: email-templates.write Rate Limiting: This endpoint is rate limited to 400 requests per minute.

  • Destructive

    Delete email template

    With this endpoint you can delete email template by ID. Scopes: email-templates.write Rate Limiting: This endpoint is rate limited to 400 requests per minute.

Email Universal Layouts

  • Read

    Get universal layouts

    With this endpoint you can get a paginated list of universal layouts. Sorting: Items are returned in descending order by creation time (newest first). This is based on the internal document ID which contains a timestamp.

  • Read

    Get universal layout

    With this endpoint you can get a universal layout by ID. Scopes: email-templates.read Rate Limiting: This endpoint is rate limited to 400 requests per minute.

  • Write

    Create universal layout

    With this endpoint you can create a new universal layout. Scopes: email-templates.write Rate Limiting: This endpoint is rate limited to 400 requests per minute.

  • Destructive

    Update universal layout

    With this endpoint you can update (fully replace) a universal layout by ID. Scopes: email-templates.write Rate Limiting: This endpoint is rate limited to 400 requests per minute.

  • Destructive

    Delete universal layout

    With this endpoint you can delete a universal layout by ID. Scopes: email-templates.write Rate Limiting: This endpoint is rate limited to 400 requests per minute.

Events

  • Write

    Send Customer event

    With this endpoint you can send customer events to Omnisend. Customer events are used to track customer behavior and trigger automations based on that behavior. You can either format and send custom customer events or use predefined events.

Form A/B Setups

  • Read

    List form A/B setups

    List form A/B setups with sorting and cursor-based pagination support. Each setup includes the auto-close policy configured when the test was started (if any). Scopes: forms.read Rate Limiting: This endpoint is rate limited to 400 requests per minute.

  • Read

    Get a form A/B setup

    Get a single form A/B setup by ID, including its main form, variant forms with their weights, status, lifecycle timestamps, and the auto-close policy configured when the test was started (if any).

  • Write

    Create a form A/B setup

    Create a draft form A/B setup from an existing popup, flyout or fullscreen form. Only those display types are eligible; the source form becomes the setup's main form and its two variants start as identical copies that can be edited independently afterward.

  • Write

    Start a form A/B setup

    Start a form A/B test by ID. Launches the A/B setup so its variants begin serving to visitors according to their weights, moving the setup to enabled status. Starting a form A/B setup that has already been started returns a conflict.

  • Write

    Select a form A/B setup winner

    Select a winning variant for a form A/B setup by its version form ID. A winner can only be selected for an enabled (started) setup; selecting one concludes the test in favor of the chosen variant.

  • Destructive

    Delete a form A/B setup

    Delete a single form A/B setup by ID. Only draft form A/B setups can be deleted; enabled or completed setups cannot. Deleting a non-existent form A/B setup succeeds (idempotent). Scopes: forms.write Rate Limiting: This endpoint is rate limited to 400 requests per minute.

Form Templates

  • Read

    List form templates

    List form templates with sorting, filtering and cursor-based pagination support. Only templates available in the brand's library are returned, each with its full content and brand assets applied.

  • Read

    Get template

    Get a single form template by ID. Scopes: forms.read Rate Limiting: This endpoint is rate limited to 400 requests per minute.

  • Write

    Render a form template

    Render a single form template by ID and return its display steps as HTML. Scopes: forms.write Rate Limiting: This endpoint is rate limited to 40 requests per minute.

Forms

  • Read

    List forms

    List forms with sorting and cursor-based pagination support. Scopes: forms.read Rate Limiting: This endpoint is rate limited to 400 requests per minute. Pagination: This endpoint uses cursor-based pagination.

  • Read

    Get form

    Get a single form by ID, including its content, styling, targeting rules, and status. When the form is part of an A/B test, abSetupID and abStatus identify the setup it belongs to. Scopes: forms.read Rate Limiting: This endpoint is rate limited to 400 requests per minute.

  • Write

    Create form

    Create a form with its full content and styling. New forms start in draft status and are not shown to visitors until enabled via POST /forms/{formID}/enable. Choosing a display type: - popup — modal centered over the page that dims the background.

  • Write

    Update form

    Partially update a form. Only the fields present in the request body are changed; omitted fields are left unchanged. Nested objects must be sent complete, as they fully replace the stored value.

  • Write

    Disable form

    Disable a single form by ID. Disabling stops serving the form to visitors and moves it to disabled status; the form and its content are preserved and can be enabled again later. Disabling an already disabled form succeeds (idempotent).

  • Write

    Enable form

    Enable a single form by ID. Enabling publishes the form and starts serving it to visitors according to its targeting rules; the form moves to enabled status. Enabling an already enabled form succeeds (idempotent).

  • Write

    Render a form

    Render a single form by ID and return its display steps as HTML. The form is rendered from its current stored content without enabling it or serving it to visitors, so the response can be used to preview how the form will look.

  • Destructive

    Delete form

    Delete a single form by ID. Forms can be deleted in any state (draft, enabled, disabled). Deleting a non-existent form succeeds (idempotent). When the form owns an A/B test setup, the setup and its version forms are deleted as well.

Forms reports

  • Read

    List A/B setup reports for a form

    Returns the results of the A/B tests of the given form. Each report covers one A/B setup and contains the period it ran for (startedAt, and completedAt once it finished), the winning version, and per-version statistics.

  • Read

    Get form submitted contacts

    Get the contacts that signed up through the given form, most recent first by default, together with the values they submitted (email, phone, name, address fields, discount code, and custom properties). Pagination: results are cursor-based.

  • Read

    Get form report

    Get aggregated performance statistics for a single form within a date range. The response contains statistics (totals across all devices) and statisticsByDevice, the same counters split into the desktop, mobile, and tablet buckets.

  • Read

    Get form periodic report

    Get a time series of form performance statistics within a date range.

Images

  • Read

    List images

    With this endpoint you can get a paginated list of images for a brand.

  • Read

    Get image

    With this endpoint you can get a single image by ID. Scopes: images.read Rate Limiting: This endpoint is rate limited to 400 requests per minute.

  • Write

    Upload image by URL

    With this endpoint you can upload an image from a publicly accessible URL. If the name is not provided, the filename will be extracted from the URL. Scopes: images.write Rate Limiting: This endpoint is rate limited to 400 requests per minute.

  • Write

    Upload image file

    With this endpoint you can upload an image file directly from your computer. File Requirements: - Supported formats: JPEG, PNG, GIF, WebP - Maximum file size: 5MB Scopes: images.write Rate Limiting: This endpoint is rate limited to 400 requests per minute.

  • Destructive

    Delete image

    With this endpoint you can delete an image by ID. Scopes: images.write Rate Limiting: This endpoint is rate limited to 400 requests per minute.

Product Categories

  • Read

    List product categories

    List products categories Scopes: products.read Rate Limiting: This endpoint is rate limited to 400 requests per minute. Guide: Sync products catalog, categories Check POSTMAN documentation

  • Read

    Get product category

    Get product category by ID. Scopes: products.read Rate Limiting: This endpoint is rate limited to 400 requests per minute. Check POSTMAN documentation

  • Write

    Create product category

    Creates a new product category Scopes: products.write Rate Limiting: This endpoint is rate limited to 400 requests per minute. Check POSTMAN documentation

  • Write

    Update product category

    Update product category by ID. Scopes: products.write Rate Limiting: This endpoint is rate limited to 400 requests per minute. Check POSTMAN documentation

  • Destructive

    Delete product category

    With this endpoint you can delete product category. Scopes: products.write Rate Limiting: This endpoint is rate limited to 400 requests per minute. Check POSTMAN documentation

Products

  • Read

    List products

    List products Scopes: products.read Rate Limiting: This endpoint is rate limited to 400 requests per minute. Guide: Sync products catalog, categories Open Postman collection

  • Read

    Get product

    Get product by ID Scopes: products.read Rate Limiting: This endpoint is rate limited to 400 requests per minute. Open Postman collection

  • Write

    Create product

    Creates a new product Scopes: products.write Rate Limiting: This endpoint is rate limited to 400 requests per minute. Open Postman collection

  • Destructive

    Replace product

    Replace product by ID Scopes: products.write Rate Limiting: This endpoint is rate limited to 400 requests per minute. Open Postman collection

  • Destructive

    Delete product

    Delete product by ID Scopes: products.write Rate Limiting: This endpoint is rate limited to 400 requests per minute. Open Postman collection

Segments

  • Read

    List segments

    List segments with sorting and cursor-based pagination support. Scopes: segments.read Pagination: This endpoint uses cursor-based pagination. Use the after cursor from the response to get the next page, or the before cursor to get the previous page.

  • Read

    Get segment

    Returns a segment by its unique identifier. Scopes: segments.read Rate Limiting: This endpoint is rate limited to 100 requests per minute.

  • Read

    Get segment statistics

    Returns statistics for a segment, including the total number of matching contacts. Scopes: segments.read Rate Limiting: This endpoint is rate limited to 100 requests per minute.

  • Write

    Create segment

    Creates a new segment. Scopes: segments.write Rate Limiting: This endpoint is rate limited to 15 requests per minute.

  • Destructive

    Update segment

    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. Scopes: segments.write Rate Limiting: This endpoint is rate limited to 15 requests per minute.

  • Destructive

    Delete segment

    Permanently deletes a segment by its unique identifier. The segment must not be in a building state to be deleted. If the segment is currently being built, a 409 Conflict error is returned.

Automations

  • Read

    List automation workflows

    List automation workflows with filtering, sorting, and cursor-based pagination. Scopes: automations.read Rate Limiting: This endpoint is rate limited to 400 requests per minute. Pagination: This endpoint uses cursor-based pagination.

  • Read

    Get automation workflow

    Get a single automation workflow by ID. Scopes: automations.read Rate Limiting: This endpoint is rate limited to 400 requests per minute.

  • Read

    Get UTM tags for an automation block

    Retrieve UTM tracking tags for a specific send-action block. Missing or cleared tags are returned with their default values. Scopes: automations.read Rate Limiting: This endpoint is rate limited to 400 requests per minute.

  • Read

    Get aggregated UTM tags for all blocks

    Retrieve UTM tracking tags for all send-action blocks in an automation. Each block's tags include default-value synthesis for missing fields. Scopes: automations.read Rate Limiting: This endpoint is rate limited to 400 requests per minute.

  • Write

    Create automation workflow

    Create a new automation workflow. Scopes: automations.write Rate Limiting: This endpoint is rate limited to 400 requests per minute. Trigger condition examples The trigger.condition field defines the event that enrolls contacts into the automation.

  • Write

    Patch automation workflow

    Partially update an automation workflow. Only the fields provided in the request body are updated. Enabled automations cannot be patched. Disable the automation via POST /automations/{id}/disable, make changes, then re-enable via POST /automations/{id}/enable when ready.

  • Write

    Send test email

    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. Scopes: automations.write Rate Limiting: This endpoint is rate limited to 400 requests per minute.

  • Write

    Copy automation workflow

    Create a copy of an existing automation workflow. The copy is always created in a disabled state, regardless of the source automation's status. The request body is optional. When provided, you can specify a custom name for the copy.

  • Write

    Disable automation workflow

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

  • Write

    Enable automation workflow

    Enable an automation workflow. Once enabled, the workflow starts processing trigger events in real time. The request body is optional. Use enrollExisting to also enroll contacts who already qualify at the time of enabling.

  • Destructive

    Delete automation workflow

    Delete a single automation workflow by ID. This operation is idempotent — deleting a non-existent automation returns a success response. Scopes: automations.write Rate Limiting: This endpoint is rate limited to 400 requests per minute.

  • Destructive

    Replace automation workflow blocks

    Replace the full block tree for an automation workflow. Blocks identified by id are updated in place. Blocks identified by temporaryID are created as new blocks. Existing blocks not included in this array are removed. Enabled automations cannot be restructured.

  • Destructive

    Update UTM tags for an automation block

    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.

Campaigns

  • Read

    List campaigns with filtering, sorting, and cursor pagination

    List campaigns with filtering, sorting, and cursor-based pagination. Scopes: campaigns.read Rate Limiting: This endpoint is rate limited to 400 requests per minute.

  • Read

    Get campaign

    Get a single campaign by ID. Scopes: campaigns.read Rate Limiting: This endpoint is rate limited to 400 requests per minute.

  • Read

    Get campaign UTM settings

    Get UTM tag settings for a campaign. The response shape is the same for all campaign types: tags is populated for regular campaigns, variants for A/B campaigns. The absent field is omitted.

  • Write

    Create campaign

    Create a new campaign draft. Boosters (type: booster): - The parent campaign (boosterSettings.campaignID) must be a regular email campaign in 'draft' or 'sent' status; 'scheduled' and 'started' parents return 409.

  • Write

    Update campaign (draft status only)

    Update a campaign draft. Only campaigns in 'draft' status can be updated; any other status returns 409. To change a campaign that is no longer a draft, copy it and edit the new draft copy.

  • Write

    Resume A/B test

    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. Scopes: campaigns.write Rate Limiting: This endpoint is rate limited to 400 requests per minute.

  • Write

    Stop A/B test

    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.

  • Write

    Select A/B test winner

    Manually pick a variant as the winner. The chosen variant is routed into the send pipeline immediately. Scopes: campaigns.write Rate Limiting: This endpoint is rate limited to 400 requests per minute.

  • Write

    Copy campaign

    Create a draft copy of an existing campaign, copying content, audience, and settings from the original. The copy is a new draft campaign with its own ID; the original campaign is left unchanged. The copied campaign name will be prefixed with "Copy of: ".

  • Write

    Restore campaign to draft

    Restore a scheduled campaign to draft while preserving its ID and name. Only campaigns in scheduled status are supported. Regular email, SMS, push, and A/B test parent campaigns can be restored. Booster campaigns are not supported.

  • Write

    Send campaign

    Submit a campaign draft for sending. Only campaigns in 'draft' status can be sent; to send a campaign again, copy it and send the copy. Supports both email and SMS campaigns.

  • Write

    Send campaign test email

    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.

  • Destructive

    Delete campaign

    Delete a campaign. Scopes: campaigns.write Rate Limiting: This endpoint is rate limited to 400 requests per minute.

  • Destructive

    Cancel campaign

    Cancel a campaign and mark it as canceled. Cancelable source states: scheduled or paused (all channel types), or started (email only). Any other status (e.g. draft, sent, canceled) returns 409.

  • Destructive

    Update campaign UTM settings

    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. Scopes: campaigns.write Rate Limiting: This endpoint is rate limited to 400 requests per minute.

See How connections work for access and permissions, or browse all integrations.