Omnisend
omnisendOmnisend is a marketing automation platform for ecommerce businesses, focusing on email and SMS marketing.
Acciones disponibles (10)
Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.
Create BatchOMNISEND_CREATE_BATCHAcciónTool 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.
OMNISEND_CREATE_BATCHAcciónTool 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.
Parámetros de entrada
itemsobject[]ObligatorioArray of payload objects for each operation.
methodstringObligatorioenumHTTP method for all operations in this batch. Must be POST or PUT.
POSTPUTeventIDstringRequired when endpoint is 'events'; the ID of the event to trigger.
endpointstringObligatorioenumTarget endpoint for the operations.
contactsordersproductseventscategories
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create or Update ContactOMNISEND_CREATE_OR_UPDATE_CONTACTAcciónTool to create or update a contact in omnisend. use after collecting subscriber details.
OMNISEND_CREATE_OR_UPDATE_CONTACTAcciónTool to create or update a contact in omnisend. use after collecting subscriber details.
Parámetros de entrada
citystringCity name
genderstringenumContact's gender ('m' or 'f')
mfaddressstringStreet address
countrystringFull country name
lastNamestringContact's last name
birthdateanydateBirthdate in YYYY-MM-DD format
firstNamestringContact's first name
postalCodestringPostal or ZIP code
countryCodeanyISO 3166-1 alpha-2 country code
identifiersobject[]ObligatorioOne or more ways to identify the contact; at least one required
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete ProductOMNISEND_DELETE_PRODUCTAcciónTool 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.
OMNISEND_DELETE_PRODUCTAcciónTool 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.
Parámetros de entrada
product_idstringObligatorioUnique identifier of the product to delete.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get BatchesOMNISEND_GET_BATCHESAcciónTool to retrieve a list of batch operations. use after initiating a batch job to monitor its progress and results.
OMNISEND_GET_BATCHESAcciónTool to retrieve a list of batch operations. use after initiating a batch job to monitor its progress and results.
Parámetros de entrada
endpointstringObligatorioenumTarget endpoint for the batch operations to retrieve.
contactsordersproductseventscategories
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Batch InformationOMNISEND_GET_BATCH_INFORMATIONAcciónTool to retrieve information about a specific batch by id. use after submitting a batch when you need a detailed status and counts.
OMNISEND_GET_BATCH_INFORMATIONAcciónTool to retrieve information about a specific batch by id. use after submitting a batch when you need a detailed status and counts.
Parámetros de entrada
batchIdstringObligatorioThe unique identifier of the batch to retrieve
Parámetros de salida
dataobject[]ObligatorioDetailed list of batch item records; structure depends on batchType
errorstringError if any occurred during the execution of the action
statusstringObligatorioCurrent status of the batch (e.g., 'pending', 'completed')
batchIdstringObligatorioThe unique identifier for the batch
batchTypestringObligatorioType of batch, e.g., 'import' or 'export'
createdAtstringObligatorioISO 8601 timestamp when the batch was created
updatedAtstringObligatorioISO 8601 timestamp when the batch was last updated
errorCountintegerObligatorioNumber of items that encountered errors
successfulbooleanObligatorioWhether or not the action execution was successful or not
totalCountintegerObligatorioTotal number of items in the batch
processedCountintegerObligatorioNumber of successfully processed items
Get Batch ItemsOMNISEND_GET_BATCH_ITEMSAcciónTool 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.
OMNISEND_GET_BATCH_ITEMSAcciónTool 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.
Parámetros de entrada
batchIdstringObligatorioThe unique identifier of the batch whose items you want to retrieve.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get ContactOMNISEND_GET_CONTACTAcciónTool to retrieve details of a single contact by id. use when you already have a contactid and need the full profile.
OMNISEND_GET_CONTACTAcciónTool to retrieve details of a single contact by id. use when you already have a contactid and need the full profile.
Parámetros de entrada
contactIdstringObligatorioUnique identifier of the contact to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List ContactsOMNISEND_LIST_CONTACTSAcciónTool to retrieve a paginated list of contacts with optional filtering. use when you need to fetch contacts in batches and handle cursor pagination.
OMNISEND_LIST_CONTACTSAcciónTool to retrieve a paginated list of contacts with optional filtering. use when you need to fetch contacts in batches and handle cursor pagination.
Parámetros de entrada
tagstringFilter contacts by tag.
afterstringCursor for pagination: contacts after this base64-encoded ContactID.
emailstringFilter contacts by exact email address.
limitintegerNumber of results per page. Defaults to 100, maximum 250.
phonestringFilter contacts by full phone number including country code.
beforestringCursor for pagination: contacts before this base64-encoded ContactID.
statusstringenumFilter contacts by email channel status.
subscribednonSubscribedunsubscribedsegmentIDintegerFilter contacts by segment ID.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List ProductsOMNISEND_LIST_PRODUCTSAcciónTool to retrieve a paginated list of products. use when syncing product catalog before campaign creation.
OMNISEND_LIST_PRODUCTSAcciónTool to retrieve a paginated list of products. use when syncing product catalog before campaign creation.
Parámetros de entrada
sortstringenumField to sort by. Allowed values: 'date', 'createdAt', or 'updatedAt'.
datecreatedAtupdatedAtlimitintegerMaximum number of products to return. Defaults to 100.
offsetintegerZero-based index of the first product to return. Use to page through results.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update ContactOMNISEND_UPDATE_CONTACTAcciónTool 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'})
OMNISEND_UPDATE_CONTACTAcciónTool 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'})
Parámetros de entrada
bodyobjectObligatorioFields to update on the contact
contactIdstringObligatorioUnique identifier of the contact to update
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not