Skip to main content
Server path: /omnisend | Type: Application | PCID required: Yes

Tools

ToolDescription
omnisend_create_eventSend a customer event
omnisend_create_or_update_contactCreate or update a contact
omnisend_create_productCreate a product
omnisend_create_product_categoryCreate a product category
omnisend_delete_productDelete a product
omnisend_delete_product_categoryDelete a product category
omnisend_get_contactGet a contact
omnisend_get_productGet a product
omnisend_get_product_categoryGet a product category
omnisend_list_campaignsList campaigns
omnisend_list_contactsList contacts
omnisend_list_product_categoriesList product categories
omnisend_list_productsList products
omnisend_list_segmentsList segments
omnisend_replace_productReplace a product
omnisend_update_contactUpdate a contact
omnisend_update_product_categoryUpdate a product category

omnisend_create_event

Send a customer event Parameters:
ParameterTypeRequiredDefaultDescription
contactobjectYesContact identifier for the event
eventIDstringNoUnique identifier for deduplication
eventNamestringYesName of the event (e.g., ‘placed order’, ‘added to cart’, or a custom event name)
eventTimestringNoEvent timestamp in ISO 8601 format
eventVersionstringNoVersion of the event schema (for recommended events)
originstringNoOrigin of the event. Use ‘api’ for API-submitted events.
propertiesobjectNoCustom event properties as key-value pairs

omnisend_create_or_update_contact

Create or update a contact Parameters:
ParameterTypeRequiredDefaultDescription
addressstringNoContact street address
birthdatestringNoContact birthdate (YYYY-MM-DD)
citystringNoContact city
countrystringNoContact country
countryCodestringNoISO 3166-1 alpha-2 country code
customPropertiesobjectNoCustom properties as key-value pairs. Keys: Latin chars, numbers, underscores (max 128 chars). Values: strings up to 2048 chars.
firstNamestringNoContact first name
genderstringNoContact gender
identifiersobject[]YesContact identifiers (email, phone). At least one identifier is required.
lastNamestringNoContact last name
postalCodestringNoContact postal/zip code
statestringNoContact state/region
tagsstring[]NoTags to assign to the contact

omnisend_create_product

Create a product Parameters:
ParameterTypeRequiredDefaultDescription
categoryIDsstring[]NoArray of category IDs
currencystringYesThree-letter ISO currency code (e.g., USD)
descriptionstringNoProduct description
idstringYesUnique product identifier
imagesobject[]NoProduct images
statusstringYesProduct availability status
tagsstring[]NoProduct tags
titlestringYesProduct title
typestringNoProduct type
urlstringYesProduct URL
variantsobject[]YesProduct variants
vendorstringNoProduct vendor

omnisend_create_product_category

Create a product category Parameters:
ParameterTypeRequiredDefaultDescription
categoryIDstringYesUnique category identifier (1-100 characters)
titlestringYesCategory display title (max 255 characters)

omnisend_delete_product

Delete a product Parameters:
ParameterTypeRequiredDefaultDescription
productIDstringYesThe product ID

omnisend_delete_product_category

Delete a product category Parameters:
ParameterTypeRequiredDefaultDescription
categoryIDstringYesThe category ID

omnisend_get_contact

Get a contact Parameters:
ParameterTypeRequiredDefaultDescription
contactIDstringYesThe contact ID

omnisend_get_product

Get a product Parameters:
ParameterTypeRequiredDefaultDescription
productIDstringYesThe product ID

omnisend_get_product_category

Get a product category Parameters:
ParameterTypeRequiredDefaultDescription
categoryIDstringYesThe category ID

omnisend_list_campaigns

List campaigns Parameters:
ParameterTypeRequiredDefaultDescription
updatedAtFromstringNoFilter campaigns modified after this ISO 8601 datetime (e.g., 2024-01-01T00:00:00Z)

omnisend_list_contacts

List contacts Parameters:
ParameterTypeRequiredDefaultDescription
emailstringNoFilter by email address
phonestringNoFilter by full phone number (e.g., +1234567890)
statusstringNoFilter by subscription status
segmentIDstringNoFilter by segment identifier
tagstringNoFilter by contact tag
limitintegerNoNumber of results to return (default: 100, max: 250)
afterstringNoBase64-encoded pagination cursor for next page
beforestringNoBase64-encoded pagination cursor for previous page
updatedAfterstringNoFilter contacts updated after this RFC3339 timestamp (e.g., 2024-01-01T00:00:00Z)

omnisend_list_product_categories

List product categories Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNoNumber of results to return (default: 100, max: 250)
offsetintegerNoNumber of items to skip (default: 0)

omnisend_list_products

List products Parameters:
ParameterTypeRequiredDefaultDescription
offsetintegerNoNumber of items to skip (default: 0)
limitintegerNoNumber of items to return (default: 100, max: 250)
sortstringNoSort field

omnisend_list_segments

List segments Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNoNumber of results to return (default: 100, max: 250)
offsetintegerNoNumber of items to skip (default: 0)

omnisend_replace_product

Replace a product Parameters:
ParameterTypeRequiredDefaultDescription
productIDstringYesThe product ID
categoryIDsstring[]NoArray of category IDs
currencystringYesThree-letter ISO currency code (e.g., USD)
descriptionstringNoProduct description
idstringYesUnique product identifier
imagesobject[]NoProduct images
statusstringYesProduct availability status
tagsstring[]NoProduct tags
titlestringYesProduct title
typestringNoProduct type
urlstringYesProduct URL
variantsobject[]YesProduct variants
vendorstringNoProduct vendor

omnisend_update_contact

Update a contact Parameters:
ParameterTypeRequiredDefaultDescription
contactIDstringYesThe contact ID
addressstringNoThe address value
birthdatestringNoThe birthdate value
citystringNoThe city value
countrystringNoThe country value
countryCodestringNoCountry Code
customPropertiesobjectNoCustom Properties
firstNamestringNoFirst Name
genderstringNoThe gender value
identifiersobject[]NoUpdated contact identifiers
lastNamestringNoLast Name
postalCodestringNoPostal Code
statestringNoThe state value
tagsstring[]NoThe tags value

omnisend_update_product_category

Update a product category Parameters:
ParameterTypeRequiredDefaultDescription
categoryIDstringYesThe category ID
titlestringNoUpdated category title (max 255 characters)