Omnisend
App · 23 actions
Work with your Omnisend store: find, add, update, subscribe and unsubscribe contacts, import them in bulk, manage the product catalogue and its categories, read automations, and send custom events that start automations.
Actions
| Action | What it does |
|---|---|
| Create or update contact | Add a contact by email or phone. |
| Create product | Add a product to the catalogue with one variant, so Omnisend can show it in emails. |
| Create product category | Add a product category. |
| Delete product | Delete a product from the catalogue. |
| Delete product category | Delete a product category. |
| Find contact | Look up one contact by email address or phone number. |
| Get bulk job | Get a bulk job's status and how many of its items are done or failed. |
| Get bulk job results | Get what happened to each item of a bulk job, and which items failed and why. |
| Get contact | Get one contact with its subscriptions, tags, segments and custom properties. |
| Get product | Get one product with its variants, categories and tags. |
| Get product category | Get one product category by its id. |
| Get store details | Get the Omnisend store the connection belongs to: its name, website, currency and time zone. |
| Import contacts | Create or update up to 100 contacts in one background job. |
| List automations | List the store's automations with their status, what starts them and the messages they send. |
| List bulk jobs | List the bulk jobs run for contacts, products or events, with their progress. |
| List contacts | List contacts, filtered by email, phone, subscription, segment, tag or when they last changed. |
| List product categories | List the catalogue's product categories, a page at a time. |
| List products | List the products in the store's catalogue, a page at a time. |
| Send custom event | Tell Omnisend something a contact did, such as 'trial started', so an automation you built on that event can run. |
| Subscribe or unsubscribe contact | Set whether a contact can get marketing email or SMS. |
| Update contact | Change a contact's name, details, subscriptions or custom properties. |
| Update product | Change a product's title, price, availability or other details. |
| Update product category | Rename a product category. |
Create or update contact
Add a contact by email or phone. If a contact already has that email or phone, it is updated instead. A subscription is only set when you choose one.
Inputs
- Email
emailtext - Their email address. Give this, a phone number, or both.
- Phone
phonetext - Their phone number with the country code, like +15555555555.
- Email subscription
email_statustext - Whether they can get marketing email. Only set it with their permission. Leave empty to leave it as it is.One of:
subscribed,nonSubscribed(Not subscribed (can get transactional messages only)),unsubscribed. - SMS subscription
sms_statustext - Whether they can get marketing texts. Needs a phone number. Leave empty to leave it as it is.One of:
subscribed,nonSubscribed(Not subscribed (can get transactional messages only)),unsubscribed. - First name
first_nametext - Their first name.
- Last name
last_nametext - Their last name.
- Gender
gendertext - Their gender, if you know it.One of:
f(Female),m(Male). - Birth date
birthdatedate - Their date of birth.
- Street address
addresstext - Street, house number and apartment.
- City
citytext - Their city.
- State or region
statetext - Their state, province or region.
- Country
countrytext - Their country's name, such as United States.
- Country code
country_codetext - Their country's ISO code, such as US or GB.
- Postal code
postal_codetext - Their postal or zip code.
- Tags
tagslist - Labels to organize the contact, such as where they came from (source: website).
- Custom properties
custom_propertiesobject - Your own properties on the contact, for example {"plan": "pro"}. A new property name is created for you.
- Send welcome email
send_welcome_emailtrue/false - Send the welcome email, if you have turned that automation on in Omnisend. It only goes to a contact who is subscribed.
Outputs
contactobject- The contact saved
Example output
{
"contact": {
"contactID": "60a6170920d91c215e949b5c",
"email": "jo@example.com",
"firstName": "Jo",
"lastName": "Bloggs",
"phone": ""
}
}Create product
Add a product to the catalogue with one variant, so Omnisend can show it in emails. You choose its id.
Inputs
- Product ID
product_idtextRequired - An id you choose for the product, up to 100 characters, such as your own SKU. It cannot change later.
- Title
titletextRequired - The product's name.
- Product page address
urltextRequired - The address of the product's page on your website.
- Price
pricenumberRequired - The price, such as 19.99.At least 0.
- Currency
currencytext - The 3-letter currency code, such as USD. Leave empty to use your store's currency.
- Availability
statustext - Whether it can be bought. Defaults to in stock.One of:
inStock(In stock (default)),outOfStock(Out of stock),notAvailable(Not available). - SKU
skutext - Your stock-keeping code for it.
- Compare-at price
compare_at_pricenumber - The price before a discount, shown crossed out.At least 0.
- Description
descriptiontext - A short description, up to 1,000 characters.
- Vendor
vendortext - The brand or manufacturer.
- Product type
product_typetext - A type to group products by, such as Shirt.
- Image address
image_urltext - The address of the main picture, starting with https://.
- Category
category_idtext - The category to put the product in.
- Tags
tagslist - Labels to group products by.
Outputs
productobject- The product as it was saved
product_idtext- The product's id
Example output
{
"product": {
"categoryIDs": [
"tees"
],
"createdAt": "2026-10-15T09:00:00Z",
"currency": "USD",
"defaultImageUrl": "https://example.com/blue-tee.png",
"description": "A soft blue tee.",
"id": "tee-blue-m",
"images": [
"https://example.com/blue-tee-back.png"
],
"status": "inStock",
"tags": [
"new"
],
"title": "Blue T-shirt",
"type": "Shirt",
"updatedAt": "2026-10-15T09:00:00Z",
"url": "https://example.com/blue-tee",
"variants": [
{
"defaultImageUrl": "https://example.com/blue-tee.png",
"description": "A soft blue tee.",
"id": "tee-blue-m",
"images": [
"https://example.com/blue-tee-back.png"
],
"price": 19.99,
"sku": "TEE-BLUE-M",
"status": "inStock",
"strikeThroughPrice": 24.99,
"title": "Blue T-shirt",
"url": "https://example.com/blue-tee"
}
],
"vendor": "Acme"
},
"product_id": "tee-blue-m"
}Create product category
Add a product category. You choose its id, which products then use to join it.
Inputs
- Category ID
category_idtextRequired - An id you choose, up to 100 characters. It cannot change later.
- Title
titletextRequired - The category's name.
Outputs
categoryobject- The product category
Example output
{
"category": {
"categoryID": "tees",
"createdAt": "2026-10-15T09:00:00Z",
"title": "T-shirts",
"updatedAt": "2026-10-15T09:00:00Z"
}
}Delete product
Delete a product from the catalogue.
Inputs
- Product
product_idtextRequired - The product. Pick one, or give its id from an earlier step.
Outputs
deletedtrue/false- Always true once deleted
product_idtext- The product deleted
Example output
{
"deleted": true,
"product_id": "tee-blue-m"
}Delete product category
Delete a product category. The products in it are kept.
Inputs
- Category
category_idtextRequired - The product category. Pick one, or give its id from an earlier step.
Outputs
category_idtext- The category deleted
deletedtrue/false- Always true once deleted
Example output
{
"category_id": "tees",
"deleted": true
}Find contact
Look up one contact by email address or phone number. 'found' says whether there is one.
Inputs
- Email
emailtext - The email address to look for.
- Phone
phonetext - The phone number to look for, with country code.
Outputs
contactobject- The contact; empty when not found
contact_idtext- The contact's id; empty when not found
foundtrue/false- Whether there is a contact
Example output
{
"contact": {
"address": "1 High Street",
"birthdate": "1990-01-02",
"city": "Leeds",
"consents": [
{
"channel": "email",
"createdAt": "2026-10-15T09:00:00Z",
"ip": "203.0.113.7",
"source": "api",
"userAgent": "Lodol"
}
],
"contactID": "60a6170920d91c215e949b5c",
"country": "United Kingdom",
"countryCode": "GB",
"createdAt": "2026-10-15T09:00:00Z",
"customProperties": {
"plan": "pro"
},
"email": "jo@example.com",
"firstName": "Jo",
"gender": "f",
"identifiers": [
{
"channels": {
"email": {
"status": "subscribed",
"statusDate": "2026-10-15T09:00:00Z"
}
},
"id": "jo@example.com",
"type": "email"
}
],
"lastName": "Bloggs",
"optIns": [
{
"channel": "email",
"date": "2026-10-15T09:00:00Z"
}
],
"phone": [
"+15555550100"
],
"postalCode": "LS1 1AA",
"segments": [
"70a6170920d91c215e949b5c"
],
"state": "West Yorkshire",
"status": "subscribed",
"statuses": [
{
"channel": "email",
"date": "2026-10-15T09:00:00Z",
"status": "subscribed"
}
],
"tags": [
"source: lodol"
],
"updatedAt": "2026-10-15T09:00:00Z"
},
"contact_id": "60a6170920d91c215e949b5c",
"found": true
}Get bulk job
Get a bulk job's status and how many of its items are done or failed.
Inputs
- Batch ID
batch_idtextRequired - The bulk job's id, from 'Import contacts' or 'List bulk jobs'.
Outputs
batchobject- The bulk job
Example output
{
"batch": {
"batchID": "6535d2ae8ac33f3b1e3c0a11",
"createdAt": "2026-10-15T09:00:00Z",
"endedAt": "2026-10-15T09:00:05Z",
"endpoint": "contacts",
"errors": [],
"errorsCount": 0,
"finishedCount": 1,
"method": "POST",
"origin": "api",
"responses": [
{
"itemID": "0",
"request": {},
"response": {},
"responseCode": 200,
"status": "finished"
}
],
"startedAt": "2026-10-15T09:00:01Z",
"status": "finished",
"totalCount": 1
}
}Get bulk job results
Get what happened to each item of a bulk job, and which items failed and why.
Inputs
- Batch ID
batch_idtextRequired - The bulk job's id, from 'Import contacts' or 'List bulk jobs'.
Outputs
batch_idtext- The bulk job's id
countnumber- How many items
errorslist- The items that failed
itemslist- Each item's outcome
statustext- The job's status
Example output
{
"batch_id": "6535d2ae8ac33f3b1e3c0a11",
"count": 1,
"errors": [],
"items": [
{
"itemID": "0",
"request": {},
"response": {},
"responseCode": 200,
"status": "finished"
}
],
"status": "finished"
}Get contact
Get one contact with its subscriptions, tags, segments and custom properties.
Inputs
- Contact ID
contact_idtextRequired - The contact's id (contactID), from 'List contacts', 'Find contact', 'Create or update contact' or an earlier step.
Outputs
contactobject- The contact
Example output
{
"contact": {
"address": "1 High Street",
"birthdate": "1990-01-02",
"city": "Leeds",
"consents": [
{
"channel": "email",
"createdAt": "2026-10-15T09:00:00Z",
"ip": "203.0.113.7",
"source": "api",
"userAgent": "Lodol"
}
],
"contactID": "60a6170920d91c215e949b5c",
"country": "United Kingdom",
"countryCode": "GB",
"createdAt": "2026-10-15T09:00:00Z",
"customProperties": {
"plan": "pro"
},
"email": "jo@example.com",
"firstName": "Jo",
"gender": "f",
"identifiers": [
{
"channels": {
"email": {
"status": "subscribed",
"statusDate": "2026-10-15T09:00:00Z"
}
},
"id": "jo@example.com",
"type": "email"
}
],
"lastName": "Bloggs",
"optIns": [
{
"channel": "email",
"date": "2026-10-15T09:00:00Z"
}
],
"phone": [
"+15555550100"
],
"postalCode": "LS1 1AA",
"segments": [
"70a6170920d91c215e949b5c"
],
"state": "West Yorkshire",
"status": "subscribed",
"statuses": [
{
"channel": "email",
"date": "2026-10-15T09:00:00Z",
"status": "subscribed"
}
],
"tags": [
"source: lodol"
],
"updatedAt": "2026-10-15T09:00:00Z"
}
}Get product
Get one product with its variants, categories and tags.
Inputs
- Product
product_idtextRequired - The product. Pick one, or give its id from an earlier step.
Outputs
productobject- The product
Example output
{
"product": {
"categoryIDs": [
"tees"
],
"createdAt": "2026-10-15T09:00:00Z",
"currency": "USD",
"defaultImageUrl": "https://example.com/blue-tee.png",
"description": "A soft blue tee.",
"id": "tee-blue-m",
"images": [
"https://example.com/blue-tee-back.png"
],
"status": "inStock",
"tags": [
"new"
],
"title": "Blue T-shirt",
"type": "Shirt",
"updatedAt": "2026-10-15T09:00:00Z",
"url": "https://example.com/blue-tee",
"variants": [
{
"defaultImageUrl": "https://example.com/blue-tee.png",
"description": "A soft blue tee.",
"id": "tee-blue-m",
"images": [
"https://example.com/blue-tee-back.png"
],
"price": 19.99,
"sku": "TEE-BLUE-M",
"status": "inStock",
"strikeThroughPrice": 24.99,
"title": "Blue T-shirt",
"url": "https://example.com/blue-tee"
}
],
"vendor": "Acme"
}
}Get product category
Get one product category by its id.
Inputs
- Category
category_idtextRequired - The product category. Pick one, or give its id from an earlier step.
Outputs
categoryobject- The product category
Example output
{
"category": {
"categoryID": "tees",
"createdAt": "2026-10-15T09:00:00Z",
"title": "T-shirts",
"updatedAt": "2026-10-15T09:00:00Z"
}
}Get store details
Get the Omnisend store the connection belongs to: its name, website, currency and time zone.
Inputs
None.
Outputs
accountobject- The store
Example output
{
"account": {
"brandID": "5f7b1c2d3e4f5a6b7c8d9e0f",
"connected": true,
"currency": "USD",
"name": "Example Store",
"platform": "api",
"timezone": "America/New_York",
"version": "1",
"website": "https://example.com"
}
}Import contacts
Create or update up to 100 contacts in one background job. Each contact is written the way 'Create or update contact' takes them in Omnisend's own format. Follow the job with 'Get bulk job'.
Inputs
- Contacts
itemslistRequired - A list of contacts, up to 100, each in Omnisend's contact format, for example {"identifiers": [{"type": "email", "id": "jo@example.com", "channels": {"email": {"status": "subscribed"}}}], "firstName": "Jo"}.
Outputs
batch_idtext- The bulk job's id
total_countnumber- How many contacts were sent
Example output
{
"batch_id": "6535d2ae8ac33f3b1e3c0a11",
"total_count": 1
}List automations
List the store's automations with their status, what starts them and the messages they send.
Inputs
- Changed since
updated_afterdate and time - Only those changed at or after this time. Leave empty for all.
Outputs
automationslist- The automations
countnumber- How many
Example output
{
"automations": [
{
"createdAt": "2026-09-01T09:00:00Z",
"id": "6535d2ae8ac33f3b1e3c0a13",
"messages": [
{
"channel": "email",
"id": "m1",
"title": "Welcome to Example Store"
}
],
"name": "Welcome series",
"status": "enabled",
"trigger": "contactSubscribed",
"updatedAt": "2026-09-02T09:00:00Z"
}
],
"count": 1
}List bulk jobs
List the bulk jobs run for contacts, products or events, with their progress. Filter by status or date.
Inputs
- Jobs for
endpointtextRequired - Which kind of bulk job to list.One of:
contacts,products,events. - Status
statustext - Only jobs in this state.One of:
pending(Waiting to start),inProgress(In progress),finished,stopped. - From date
date_fromdate - Only jobs started on or after this date.
- To date
date_todate - Only jobs started on or before this date.
- Page size
limitnumber - How many to return, 1 to 250. Omnisend's default is 100.From 1 to 250.
- Start at
offsetnumber - How many to skip: the 'next_offset' from an earlier page.At least 0.
Outputs
batcheslist- The bulk jobs
countnumber- How many on this page
has_moretrue/false- True when there is another page after this one
next_offsetnumber- Pass as 'offset' for the next page; empty on the last one
Example output
{
"batches": [
{
"batchID": "6535d2ae8ac33f3b1e3c0a11",
"createdAt": "2026-10-15T09:00:00Z",
"endedAt": "2026-10-15T09:00:05Z",
"endpoint": "contacts",
"errors": [],
"errorsCount": 0,
"finishedCount": 1,
"method": "POST",
"origin": "api",
"responses": [
{
"itemID": "0",
"request": {},
"response": {},
"responseCode": 200,
"status": "finished"
}
],
"startedAt": "2026-10-15T09:00:01Z",
"status": "finished",
"totalCount": 1
}
],
"count": 1,
"has_more": false,
"next_offset": null
}List contacts
List contacts, filtered by email, phone, subscription, segment, tag or when they last changed. Pages by cursor.
Inputs
- Email
emailtext - Only the contact with this email address.
- Phone
phonetext - Only the contact with this phone number, with country code.
- Email subscription
statustext - Only contacts with this email subscription status.One of:
subscribed,nonSubscribed(Not subscribed (can get transactional messages only)),unsubscribed. - Segment ID
segment_idtext - Only contacts in this segment. Copy the id from the segment's address in Omnisend.
- Tag
tagtext - Only contacts with this tag.
- Changed since
updated_afterdate and time - Only contacts changed at or after this time. Cannot be combined with the filters above.
- Page size
limitnumber - How many to return, 1 to 250. Omnisend's default is 100.From 1 to 250.
- Next page cursor
aftertext - The 'next_cursor' from an earlier page, to get the page after it.
- Previous page cursor
beforetext - The 'previous_cursor' from an earlier page, to get the page before it.
Outputs
contactslist- The contacts
countnumber- How many on this page
next_cursortext- Pass as 'after' for the next page; empty on the last one
previous_cursortext- Pass as 'before' for the previous page; empty on the first
Example output
{
"contacts": [
{
"address": "1 High Street",
"birthdate": "1990-01-02",
"city": "Leeds",
"consents": [
{
"channel": "email",
"createdAt": "2026-10-15T09:00:00Z",
"ip": "203.0.113.7",
"source": "api",
"userAgent": "Lodol"
}
],
"contactID": "60a6170920d91c215e949b5c",
"country": "United Kingdom",
"countryCode": "GB",
"createdAt": "2026-10-15T09:00:00Z",
"customProperties": {
"plan": "pro"
},
"email": "jo@example.com",
"firstName": "Jo",
"gender": "f",
"identifiers": [
{
"channels": {
"email": {
"status": "subscribed",
"statusDate": "2026-10-15T09:00:00Z"
}
},
"id": "jo@example.com",
"type": "email"
}
],
"lastName": "Bloggs",
"optIns": [
{
"channel": "email",
"date": "2026-10-15T09:00:00Z"
}
],
"phone": [
"+15555550100"
],
"postalCode": "LS1 1AA",
"segments": [
"70a6170920d91c215e949b5c"
],
"state": "West Yorkshire",
"status": "subscribed",
"statuses": [
{
"channel": "email",
"date": "2026-10-15T09:00:00Z",
"status": "subscribed"
}
],
"tags": [
"source: lodol"
],
"updatedAt": "2026-10-15T09:00:00Z"
}
],
"count": 1,
"next_cursor": "",
"previous_cursor": ""
}List product categories
List the catalogue's product categories, a page at a time.
Inputs
- Sort by
sorttext - Which date to sort by. Omnisend's own order if left empty.One of:
createdAt(Date created),updatedAt(Date updated),date. - Page size
limitnumber - How many to return, 1 to 250. Omnisend's default is 100.From 1 to 250.
- Start at
offsetnumber - How many to skip: the 'next_offset' from an earlier page.At least 0.
Outputs
categorieslist- The product categories
countnumber- How many on this page
has_moretrue/false- True when there is another page after this one
next_offsetnumber- Pass as 'offset' for the next page; empty on the last one
Example output
{
"categories": [
{
"categoryID": "tees",
"createdAt": "2026-10-15T09:00:00Z",
"title": "T-shirts",
"updatedAt": "2026-10-15T09:00:00Z"
}
],
"count": 1,
"has_more": false,
"next_offset": null
}List products
List the products in the store's catalogue, a page at a time.
Inputs
- Sort by
sorttext - Which date to sort by. Omnisend's own order if left empty.One of:
createdAt(Date created),updatedAt(Date updated),date. - Page size
limitnumber - How many to return, 1 to 250. Omnisend's default is 100.From 1 to 250.
- Start at
offsetnumber - How many to skip: the 'next_offset' from an earlier page.At least 0.
Outputs
countnumber- How many on this page
has_moretrue/false- True when there is another page after this one
next_offsetnumber- Pass as 'offset' for the next page; empty on the last one
productslist- The products
Example output
{
"count": 1,
"has_more": false,
"next_offset": null,
"products": [
{
"categoryIDs": [
"tees"
],
"createdAt": "2026-10-15T09:00:00Z",
"currency": "USD",
"defaultImageUrl": "https://example.com/blue-tee.png",
"description": "A soft blue tee.",
"id": "tee-blue-m",
"images": [
"https://example.com/blue-tee-back.png"
],
"status": "inStock",
"tags": [
"new"
],
"title": "Blue T-shirt",
"type": "Shirt",
"updatedAt": "2026-10-15T09:00:00Z",
"url": "https://example.com/blue-tee",
"variants": [
{
"defaultImageUrl": "https://example.com/blue-tee.png",
"description": "A soft blue tee.",
"id": "tee-blue-m",
"images": [
"https://example.com/blue-tee-back.png"
],
"price": 19.99,
"sku": "TEE-BLUE-M",
"status": "inStock",
"strikeThroughPrice": 24.99,
"title": "Blue T-shirt",
"url": "https://example.com/blue-tee"
}
],
"vendor": "Acme"
}
]
}Send custom event
Tell Omnisend something a contact did, such as 'trial started', so an automation you built on that event can run. This can send the contact messages.
Inputs
- Event name
event_nametextRequired - The name of your custom event, exactly as the automation's trigger in Omnisend spells it.
- Email
emailtext - The contact's email address. Give this or a phone number.
- Phone
phonetext - The contact's phone number, with country code.
- Event details
propertiesobject - Details of the event your messages can use, for example {"plan": "pro"}.
- When it happened
event_timedate and time - Defaults to now. Cannot be more than 10 years ago.
Outputs
acceptedtrue/false- True once Omnisend has accepted the event
event_nametext- The event sent
Example output
{
"accepted": true,
"event_name": "trial started"
}Subscribe or unsubscribe contact
Set whether a contact can get marketing email or SMS. Nothing changes if it is already that way. Only subscribe people who have agreed to it.
Inputs
- Contact ID
contact_idtextRequired - The contact's id (contactID), from 'List contacts', 'Find contact', 'Create or update contact' or an earlier step.
- Channel
channeltextRequired - Email or SMS.One of:
email,sms. - Subscription
statustextRequired - What the contact should be on that channel.One of:
subscribed,nonSubscribed(Not subscribed (can get transactional messages only)),unsubscribed.
Outputs
changedtrue/false- False if it was already that way
contactobject- The contact
Example output
{
"changed": true,
"contact": {
"address": "1 High Street",
"birthdate": "1990-01-02",
"city": "Leeds",
"consents": [
{
"channel": "email",
"createdAt": "2026-10-15T09:00:00Z",
"ip": "203.0.113.7",
"source": "api",
"userAgent": "Lodol"
}
],
"contactID": "60a6170920d91c215e949b5c",
"country": "United Kingdom",
"countryCode": "GB",
"createdAt": "2026-10-15T09:00:00Z",
"customProperties": {
"plan": "pro"
},
"email": "jo@example.com",
"firstName": "Jo",
"gender": "f",
"identifiers": [
{
"channels": {
"email": {
"status": "subscribed",
"statusDate": "2026-10-15T09:00:00Z"
}
},
"id": "jo@example.com",
"type": "email"
}
],
"lastName": "Bloggs",
"optIns": [
{
"channel": "email",
"date": "2026-10-15T09:00:00Z"
}
],
"phone": [
"+15555550100"
],
"postalCode": "LS1 1AA",
"segments": [
"70a6170920d91c215e949b5c"
],
"state": "West Yorkshire",
"status": "unsubscribed",
"statuses": [
{
"channel": "email",
"date": "2026-10-15T09:00:00Z",
"status": "subscribed"
}
],
"tags": [
"source: lodol"
],
"updatedAt": "2026-10-15T09:00:00Z"
}
}Update contact
Change a contact's name, details, subscriptions or custom properties. Only the fields given change. Returns the contact as it is now.
Inputs
- Contact ID
contact_idtextRequired - The contact's id (contactID), from 'List contacts', 'Find contact', 'Create or update contact' or an earlier step.
- Email
emailtext - Add or change their email address. It is only used if no other contact has it. Leave empty to keep it.
- Phone
phonetext - Add or change their phone number, with country code. Leave empty to keep it.
- Email subscription
email_statustext - Whether they can get marketing email. Only set it with their permission. Leave empty to leave it as it is.One of:
subscribed,nonSubscribed(Not subscribed (can get transactional messages only)),unsubscribed. - SMS subscription
sms_statustext - Whether they can get marketing texts. Needs a phone number. Leave empty to leave it as it is.One of:
subscribed,nonSubscribed(Not subscribed (can get transactional messages only)),unsubscribed. - First name
first_nametext - Their first name.
- Last name
last_nametext - Their last name.
- Gender
gendertext - Their gender, if you know it.One of:
f(Female),m(Male). - Birth date
birthdatedate - Their date of birth.
- Street address
addresstext - Street, house number and apartment.
- City
citytext - Their city.
- State or region
statetext - Their state, province or region.
- Country
countrytext - Their country's name, such as United States.
- Country code
country_codetext - Their country's ISO code, such as US or GB.
- Postal code
postal_codetext - Their postal or zip code.
- Custom properties
custom_propertiesobject - Your own properties on the contact, for example {"plan": "pro"}. A new property name is created for you.
Outputs
contactobject- The updated contact
Example output
{
"contact": {
"address": "1 High Street",
"birthdate": "1990-01-02",
"city": "Leeds",
"consents": [
{
"channel": "email",
"createdAt": "2026-10-15T09:00:00Z",
"ip": "203.0.113.7",
"source": "api",
"userAgent": "Lodol"
}
],
"contactID": "60a6170920d91c215e949b5c",
"country": "United Kingdom",
"countryCode": "GB",
"createdAt": "2026-10-15T09:00:00Z",
"customProperties": {
"plan": "pro"
},
"email": "jo@example.com",
"firstName": "Joanne",
"gender": "f",
"identifiers": [
{
"channels": {
"email": {
"status": "subscribed",
"statusDate": "2026-10-15T09:00:00Z"
}
},
"id": "jo@example.com",
"type": "email"
}
],
"lastName": "Bloggs",
"optIns": [
{
"channel": "email",
"date": "2026-10-15T09:00:00Z"
}
],
"phone": [
"+15555550100"
],
"postalCode": "LS1 1AA",
"segments": [
"70a6170920d91c215e949b5c"
],
"state": "West Yorkshire",
"status": "subscribed",
"statuses": [
{
"channel": "email",
"date": "2026-10-15T09:00:00Z",
"status": "subscribed"
}
],
"tags": [
"source: lodol"
],
"updatedAt": "2026-10-15T09:00:00Z"
}
}Update product
Change a product's title, price, availability or other details. Only the fields given change.
Inputs
- Product
product_idtextRequired - The product. Pick one, or give its id from an earlier step.
- Title
titletext - A new name. Leave empty to keep it.
- Product page address
urltext - A new page address. Leave empty to keep it.
- Price
pricenumber - A new price. Only for a product with one variant. Leave empty to keep it.At least 0.
- Currency
currencytext - A new 3-letter currency code. Leave empty to keep it.
- Availability
statustext - Change whether it can be bought. Leave empty to keep it.One of:
inStock(In stock (default)),outOfStock(Out of stock),notAvailable(Not available). - SKU
skutext - A new stock-keeping code. Only for a product with one variant.
- Compare-at price
compare_at_pricenumber - A new before-discount price. Only for a product with one variant.At least 0.
- Description
descriptiontext - A short description, up to 1,000 characters.
- Vendor
vendortext - The brand or manufacturer.
- Product type
product_typetext - A type to group products by, such as Shirt.
- Image address
image_urltext - The address of the main picture, starting with https://.
- Category
category_idtext - The category to put the product in.
- Tags
tagslist - Labels to group products by.
Outputs
productobject- The product as it was saved
product_idtext- The product's id
Example output
{
"product": {
"categoryIDs": [
"tees"
],
"createdAt": "2026-10-15T09:00:00Z",
"currency": "USD",
"defaultImageUrl": "https://example.com/blue-tee.png",
"description": "A soft blue tee.",
"id": "tee-blue-m",
"images": [
"https://example.com/blue-tee-back.png"
],
"status": "inStock",
"tags": [
"new"
],
"title": "Blue T-shirt (new)",
"type": "Shirt",
"updatedAt": "2026-10-15T09:00:00Z",
"url": "https://example.com/blue-tee",
"variants": [
{
"defaultImageUrl": "https://example.com/blue-tee.png",
"description": "A soft blue tee.",
"id": "tee-blue-m",
"images": [
"https://example.com/blue-tee-back.png"
],
"price": 19.99,
"sku": "TEE-BLUE-M",
"status": "inStock",
"strikeThroughPrice": 24.99,
"title": "Blue T-shirt",
"url": "https://example.com/blue-tee"
}
],
"vendor": "Acme"
},
"product_id": "tee-blue-m"
}Update product category
Rename a product category.
Inputs
- Category
category_idtextRequired - The product category. Pick one, or give its id from an earlier step.
- Title
titletextRequired - The category's new name.
Outputs
categoryobject- The product category
Example output
{
"category": {
"categoryID": "tees",
"createdAt": "2026-10-15T09:00:00Z",
"title": "Tees",
"updatedAt": "2026-10-15T09:00:00Z"
}
}