Omnisend

Learn how to use Omnisend with Composio

Overview

SLUG

OMNISEND

Description

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

Authentication Details

client_id
stringRequired
client_secret
stringRequired
oauth_redirect_uri
stringDefaults to https://backend.composio.dev/api/v1/auth-apps/add
scopes
stringDefaults to Campaigns,Contacts,Orders,Products,Carts,Events,Brands
bearer_token
string
generic_api_key
stringRequired

Tools

SLUG: OMNISEND_CREATE_BATCH

Tool to create a new batch operation for multiple items. use when you need to process many records asynchronously in one call, e.g., bulk contacts, products, orders, or events. use after preparing the items list to avoid rate limits.

Action Parameters

endpoint
stringRequired
eventID
string
items
arrayRequired
method
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: OMNISEND_CREATE_OR_UPDATE_CONTACT

Tool to create or update a contact in omnisend. use after collecting subscriber details.

Action Parameters

address
string
birthdate
city
string
country
string
countryCode
firstName
string
gender
string
identifiers
arrayRequired
lastName
string
postalCode
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: OMNISEND_DELETE_PRODUCT

Tool to remove a product from omnisend by its id. use when you need to delete a product and ensure it is no longer available in your catalog.

Action Parameters

product_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: OMNISEND_GET_BATCHES

Tool to retrieve a list of batch operations. use after initiating a batch job to monitor its progress and results.

Action Parameters

endpoint
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: OMNISEND_GET_BATCH_INFORMATION

Tool to retrieve information about a specific batch by id. use after submitting a batch when you need a detailed status and counts.

Action Parameters

batchId
stringRequired

Action Response

batchId
stringRequired
batchType
stringRequired
createdAt
stringRequired
data
arrayRequired
error
string
errorCount
integerRequired
processedCount
integerRequired
status
stringRequired
successful
booleanRequired
totalCount
integerRequired
updatedAt
stringRequired

SLUG: OMNISEND_GET_BATCH_ITEMS

Tool to retrieve processed items of a specific batch by id. use when you need to inspect individual results of a batch operation after fetching batch details.

Action Parameters

batchId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: OMNISEND_GET_CONTACT

Tool to retrieve details of a single contact by id. use when you already have a contactid and need the full profile.

Action Parameters

contactId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: OMNISEND_LIST_CONTACTS

Tool to retrieve a paginated list of contacts with optional filtering. use when you need to fetch contacts in batches and handle cursor pagination.

Action Parameters

after
string
before
string
email
string
limit
integerDefaults to 100
phone
string
segmentID
integer
status
string
tag
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: OMNISEND_LIST_PRODUCTS

Tool to retrieve a paginated list of products. use when syncing product catalog before campaign creation.

Action Parameters

limit
integerDefaults to 100
offset
integer
sort
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: OMNISEND_UPDATE_CONTACT

Tool to update fields of an existing contact by id. use after retrieving contact id. patch https://api.omnisend.com/v3/contacts/{contactid} example: updatecontact(contactid="..., body={firstname: 'john'})

Action Parameters

body
objectRequired
contactId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired