Skip to main content
SendPulse logo
  • Category: marketing automation
  • Auth: API_KEY, S2S_OAUTH2
  • Composio-managed OAuth available? No
  • Tools: 617
  • Triggers: 0
  • Slug: SEND_PULSE
  • Version: 20261101_00

Tools

Slug: SEND_PULSE_A360_DELETE_LOGSPermanently clear SendPulse Automation 360 event logs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_A360_GET_ACTION_STATSGet execution statistics for an Automation 360 action element.

Input Parameters

integer
required
Action element ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_A360_GET_CONDITION_STATSGet branch statistics for an Automation 360 condition element.

Input Parameters

integer
required
Condition element ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_A360_GET_CONVERSIONSGet conversion metrics for an Automation 360 flow.

Input Parameters

integer
required
Automation flow ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_A360_GET_EMAIL_STATSGet engagement statistics for an Automation 360 email element.

Input Parameters

integer
required
Email element ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_A360_GET_FILTER_STATSGet branch statistics for an Automation 360 filter element.

Input Parameters

integer
required
Filter element ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_A360_GET_GOAL_STATSGet achievement statistics for an Automation 360 goal element.

Input Parameters

integer
required
Goal element ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_A360_GET_MESSENGER_STATSGet execution statistics for an Automation 360 messenger element.

Input Parameters

integer
required
Messenger element ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_A360_GET_PUSH_STATSGet delivery and engagement statistics for an Automation 360 push element.

Input Parameters

integer
required
Push element ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_A360_GET_SMS_STATSGet delivery statistics for an Automation 360 SMS element.

Input Parameters

integer
required
SMS element ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_A360_GET_START_STATSGet execution statistics for an Automation 360 start element.

Input Parameters

integer
required
Start element ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_ACCOUNT_LIST_INVITED_USERSList all team members invited to the connected SendPulse account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_ADD_MAILING_LIST_CONTACTSAdd a batch of contacts to a Bulk Email mailing list, optionally assign tags, and optionally send a double-opt-in confirmation email.

Input Parameters

array
Optional unique IDs of existing tags to assign to every added contact.
array
required
Contacts to add; each contact requires an email address.
string
Optional SendPulse confirmation-email template ID for double opt-in.
string
Set to force to send a double-opt-in confirmation email.
string ("en" | "ru" | "ua" | "tr" | "es" | "pt")
Language of the double-opt-in confirmation email.
string
Activated sender address for the double-opt-in confirmation email.
integer
required
ID of the mailing list that will receive the contacts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_BULK_EMAIL_ACTIVATE_SENDERVerify and activate a SendPulse sender email address using its code.

Input Parameters

string
required
Verification code sent to the sender email address.
string
required
Sender email address to activate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_BULK_EMAIL_ADD_SENDERRegister a new sender email address and begin its verification process.

Input Parameters

string
required
Sender display name.
string
required
Email address to register as a sender.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_BULK_EMAIL_ADD_TO_BLACKLISTGlobally suppress one or more email addresses from SendPulse email communications.

Input Parameters

string
required
Base64-encoded comma-separated email addresses to blacklist.
string
Optional reason for the suppression.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_BULK_EMAIL_CANCEL_CAMPAIGNStop a pending or processing Bulk Email campaign; already sent messages cannot be recalled.

Input Parameters

integer
required
Campaign ID to stop.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_BULK_EMAIL_CREATE_CAMPAIGNCreate, send, schedule, or save a draft SendPulse email campaign.

Input Parameters

string
Base64-encoded HTML body; required when template_id is omitted.
string
Campaign name.
string
Set to draft to create the campaign without sending.
object
Open, click, and UTM tracking options.
boolean
Whether to send a test email to sender_email.
string
Mailing list ID or up to 10 IDs; required when segment_id is omitted.
string
required
Email subject.
string
Base64-encoded AMP email body.
string
Future send date in Y-m-d H:i:s format.
integer
Segment ID; required when list_id is omitted.
object
Up to five filename-to-content attachments.
string
required
Sender display name.
string
Template ID; required when body is omitted.
string
required
Verified sender email address.
boolean
Whether contacts added before sending should be included.
object
Up to five filename-to-Base64-content attachments.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_BULK_EMAIL_CREATE_TAGCreate a tag using the official SendPulse bulk-email API.

Input Parameters

string
required
Name.
string
required
Color.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_BULK_EMAIL_CREATE_TEMPLATECreate a template using the official SendPulse bulk-email API.

Input Parameters

string
required
HTML encoded in base64
string ("en" | "ru" | "ua" | "tr" | "es" | "pt")
Lang.
string
Name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_BULK_EMAIL_DELETE_EMAIL_GLOBALLYPermanently remove an email address from every Bulk Email mailing list.

Input Parameters

string
required
Email address to remove from every mailing list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_BULK_EMAIL_DELETE_SENDERPermanently remove an authorized Bulk Email sender address.

Input Parameters

string
required
Authorized sender email address to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_BULK_EMAIL_DELETE_TAGPermanently delete a tag and remove it from assigned contacts.

Input Parameters

integer
required
Tag ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_BULK_EMAIL_GET_BALANCERetrieve the SendPulse account balance and its currency.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_BULK_EMAIL_GET_BALANCE_BY_CURRENCYRetrieve the SendPulse account balance for a specific currency.

Input Parameters

string
required
Three-letter currency code for the requested balance.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_BULK_EMAIL_GET_BLACKLISTRetrieve all email addresses on the account-wide Bulk Email blacklist.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_BULK_EMAIL_GET_CAMPAIGN_COST_BY_LISTEstimate the cost of sending a Bulk Email campaign to one mailing list.

Input Parameters

integer
required
Mailing list ID for which to estimate campaign cost.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_BULK_EMAIL_GET_CAMPAIGN_COUNTRY_STATSRetrieve the geographic breakdown of opens for a Bulk Email campaign.

Input Parameters

integer
required
Campaign ID whose country statistics to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_BULK_EMAIL_GET_CAMPAIGN_REFERRAL_STATSRetrieve per-link click counts for a Bulk Email campaign.

Input Parameters

integer
required
Campaign ID whose link statistics to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_BULK_EMAIL_GET_CAMPAIGNS_BY_LISTRetrieve one page of campaigns that target a specific Bulk Email mailing list.

Input Parameters

integer
required
Mailing list ID whose campaigns to retrieve.
integer
Number of campaigns requested per page.
string
Continuation cursor returned by a previous call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_BULK_EMAIL_GET_CONTACTS_BY_VARIABLEFind contacts in one Bulk Email mailing list whose custom variable equals a value.

Input Parameters

integer
required
Mailing list ID to search.
string
required
Variable value to match, formatted for the variable’s type.
string
required
Exact mailing list variable name to match.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_BULK_EMAIL_GET_EMAIL_CAMPAIGN_INFORetrieve delivery details for one recipient in one Bulk Email campaign.

Input Parameters

integer
required
Campaign ID to inspect.
string
required
Recipient email address to inspect.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_BULK_EMAIL_GET_EMAIL_CAMPAIGN_STATSGet campaign engagement statistics for a SendPulse Bulk Email subscriber.

Input Parameters

string
required
Subscriber email address to analyze.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_BULK_EMAIL_GET_EMAIL_DETAILSGet mailing-list membership and acquisition details for a SendPulse email subscriber.

Input Parameters

string
required
Subscriber email address to inspect.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_BULK_EMAIL_GET_EMAIL_FROM_LISTRetrieve one contact’s subscription status and variables from a specific mailing list.

Input Parameters

integer
required
Mailing list ID to search.
string
required
Email address to retrieve from the mailing list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_BULK_EMAIL_GET_EMAIL_INFOFind the Bulk Email mailing lists that contain a specific email address.

Input Parameters

string
required
Email address to find across mailing lists.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_BULK_EMAIL_GET_EMAILS_TOTAL_COUNTReturn the total number of contacts in a Bulk Email mailing list, optionally active contacts only.

Input Parameters

integer
required
Mailing list ID whose contact count to retrieve.
boolean
Whether to count only active contacts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_BULK_EMAIL_GET_MAILING_LIST_BY_IDRetrieve metadata and subscriber counts for one Bulk Email mailing list.

Input Parameters

integer
required
Mailing list ID to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_BULK_EMAIL_GET_MAILING_LIST_VARIABLESRetrieve the custom variable definitions available on one Bulk Email mailing list.

Input Parameters

integer
required
Mailing list ID whose variables to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_BULK_EMAIL_GET_MULTIPLE_EMAILS_CAMPAIGN_STATSRetrieve SendPulse campaign engagement statistics for multiple email addresses.

Input Parameters

array
required
Email addresses whose campaign engagement to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_BULK_EMAIL_GET_MULTIPLE_EMAILS_INFORetrieve mailing-list membership information for multiple email addresses.

Input Parameters

array
required
Email addresses whose account membership to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_BULK_EMAIL_GET_SENDERSList sender identities authorized for SendPulse Bulk Email campaigns.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_BULK_EMAIL_GET_TAGSRetrieve all tags created for the SendPulse account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_BULK_EMAIL_GET_TEMPLATE_BY_IDRetrieve metadata for a SendPulse email template by ID.

Input Parameters

string
Optional template language code.
string ("me" | "sendpulse")
Template owner to search.
string
required
Template ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_BULK_EMAIL_GET_TEMPLATE_BY_SLUGRetrieve a SendPulse email template by its unique name slug.

Input Parameters

string
Optional template language code.
string ("me" | "sendpulse")
Template owner to search.
string
required
Unique template name slug.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_BULK_EMAIL_GET_TEMPLATESRetrieve one page of SendPulse system or account email templates.

Input Parameters

integer
Number of templates requested per page.
string ("me" | "sendpulse")
Template owner to list.
integer
Zero-based template offset.
string
Continuation cursor returned by a previous call.
boolean
Whether to return only active templates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_BULK_EMAIL_PIN_TAG_TO_EMAILAssign tag to email using the official SendPulse bulk-email API.

Input Parameters

array
required
Tags.
string
required
Email.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_BULK_EMAIL_PIN_TAG_TO_PHONEAssign tag to phone using the official SendPulse bulk-email API.

Input Parameters

array
required
Tags.
string
required
Phone.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_BULK_EMAIL_REMOVE_FROM_BLACKLISTRemove consented email addresses from the account-wide Bulk Email blacklist.

Input Parameters

string
required
Base64-encoded comma-separated email addresses to remove from the blacklist.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_BULK_EMAIL_REQUEST_SENDER_ACTIVATION_CODERequest a new activation email for an unverified SendPulse Bulk Email sender.

Input Parameters

string
required
Unverified sender email address that should receive an activation code.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_BULK_EMAIL_UNPIN_TAG_FROM_EMAILUnassign tag from email using the official SendPulse bulk-email API.

Input Parameters

array
required
Tags.
string
required
Email.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_BULK_EMAIL_UNPIN_TAG_FROM_PHONEUnassign tag from phone using the official SendPulse bulk-email API.

Input Parameters

array
required
Tags.
string
required
Phone.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_BULK_EMAIL_UNSUBSCRIBE_EMAILS_FROM_MAILING_LISTMark up to 100 email contacts as unsubscribed within one SendPulse mailing list.

Input Parameters

integer
required
Mailing list ID.
array
required
Email addresses to unsubscribe, with at most 100 per request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_BULK_EMAIL_UPDATE_CAMPAIGNUpdate the name or subject of a pending SendPulse email campaign.

Input Parameters

integer
required
Scheduled campaign ID.
string
Updated campaign name.
string
Updated email subject.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_BULK_EMAIL_UPDATE_CONTACT_PHONEChange a phone number for a contact using the official SendPulse bulk-email API.

Input Parameters

integer
required
Id.
string
required
Email.
string
required
Phone.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_BULK_EMAIL_UPDATE_CONTACT_VARIABLESUpdate custom variables for an email contact in a SendPulse mailing list.

Input Parameters

integer
required
Mailing list ID.
string
required
Email address of the contact to update.
array
required
Variables and values to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_BULK_EMAIL_UPDATE_TAGUpdate a tag using the official SendPulse bulk-email API.

Input Parameters

integer
required
Id.
string
required
Name.
string
required
Color.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_BULK_EMAIL_UPDATE_TEMPLATEEdit a template using the official SendPulse bulk-email API.

Input Parameters

integer
required
Id.
string
required
HTML version of the email, encoded in base64
string ("en" | "ru" | "ua" | "tr" | "es" | "pt")
Lang.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CREATE_MAILING_LISTCreate an empty Bulk Email mailing list and return its new ID.

Input Parameters

string
required
Name for the new mailing list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_ADD_CONTACT_ATTRIBUTE_VALUEStore a value for an existing SendPulse CRM contact attribute.

Input Parameters

string
required
Attribute value, up to 5,500 characters.
integer
required
Contact ID.
integer
required
Attribute ID to add.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_ADD_CONTACT_COMMENTAdd a comment to a SendPulse CRM contact.

Input Parameters

string
required
Comment message, up to 65,535 characters.
integer
required
Contact ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_ADD_CONTACT_COMPANY_RELATIONAssociate a SendPulse CRM contact with a company.

Input Parameters

integer
required
Company ID.
integer
required
Contact ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_ADD_CONTACT_EMAILSAdd email addresses to a SendPulse CRM contact.

Input Parameters

array
Email records to add.
integer
required
Contact ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_ADD_CONTACT_MESSENGERAdd a messenger account to a SendPulse CRM contact.

Input Parameters

string
required
Contact login in the messenger.
integer
required
Messenger type ID.
integer
required
Contact ID.
boolean
Whether this is the main chatbot messenger.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_ADD_CONTACT_PHONEAdd a phone number to a SendPulse CRM contact.

Input Parameters

string
required
Phone number to add.
integer
required
Contact ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_ADD_CONTACT_TO_DEALAdds a previously created contact to the specified deal

Input Parameters

integer
required
Deal ID in which you want to add the contact. It can be obtained with the “Get a list of deals” method
integer
required
Contact ID you want to add to the deal. It can be obtained with the “Get a list of contacts” method

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_ADD_CUSTOM_TAB_RELATIONRelate a SendPulse CRM custom tab to entities or attributes.

Input Parameters

integer
Related board or pipeline ID.
array
Related attribute IDs.
integer
Entity type code from 0 through 3.
integer
required
Custom tab ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_ADD_DEAL_ATTRIBUTEStore a value for an existing SendPulse CRM deal attribute.

Input Parameters

string
required
Attribute value, up to 5,500 characters.
integer
required
Deal ID.
integer
required
Attribute ID to add.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_ADD_DEAL_COMMENTAdds a note to the specified deal

Input Parameters

integer
required
ID of the deal for which you want to add a note. It can be obtained with the “Get a list of deals” method
string
required
Note message. The maximum number of characters is 65,535

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_ADD_PRODUCT_TO_DEALAttach a SendPulse CRM product, quantity, and price to a deal.

Input Parameters

number
DealId value documented by SendPulse.
number
Quantity value documented by SendPulse.
number
ProductId value documented by SendPulse.
string
ProductPriceIso value documented by SendPulse.
number
ProductPriceValue value documented by SendPulse.
boolean
When true the product is attached even if stock is zero and inventory is not decremented

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_ADD_TAG_TO_CONTACTAdd an existing SendPulse CRM tag to a contact.

Input Parameters

integer
required
Tag ID to add.
integer
required
Contact ID that receives the tag.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_ADD_TASK_COMMENTAdd an internal comment to a SendPulse CRM task.

Input Parameters

integer
required
SendPulse taskId parameter.
string
Comment message

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_APPROVE_PAYMENTSet approval status for manually created payment

Input Parameters

integer
required
The unique identifier of the manually created payment to approve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_ATTACH_CALL_TO_DEALAttach a telephony call to a SendPulse CRM deal.

Input Parameters

integer
Telephony call ID.
integer
required
Deal ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_ATTACH_ENTITIES_TO_TASKAttach specified CRM contacts, deals, or tasks to a SendPulse CRM task.

Input Parameters

integer
required
SendPulse taskId parameter.
object
Connections value documented by SendPulse.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_BATCH_CREATE_COMPANY_EMAILSAdd multiple email addresses to a CRM company in one request.

Input Parameters

array
Company emails to create in one request.
integer
required
Company ID that will receive the emails.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_BATCH_CREATE_COMPANY_MESSENGERSCreate multiple messenger records for a SendPulse CRM company.

Input Parameters

integer
required
Company ID.
array
Messenger records to create.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_BATCH_CREATE_COMPANY_PHONESCreate multiple phone records for a SendPulse CRM company.

Input Parameters

array
Phone records to create.
integer
required
Company ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_BATCH_STORE_CONTACT_ATTRIBUTE_VALUESStore multiple attribute values for a SendPulse CRM contact.

Input Parameters

integer
required
Contact ID.
array
Attribute values to store.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_CANCEL_PAYMENTSet payment status to canceled for manually created payment.

Input Parameters

integer
required
The unique identifier of the payment to cancel

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_CHANGE_DEAL_PIPELINEMove a SendPulse CRM deal to a pipeline and step.

Input Parameters

integer
required
Deal ID.
integer
Destination pipeline step ID.
integer
Destination pipeline ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_CHANGE_TASK_STEP_ORDERChanges order of a task in the current step or in another. newStepId field is optional

Input Parameters

number
required
Task order in step
integer
required
SendPulse stepId parameter.
integer
required
SendPulse taskId parameter.
number
New step ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_CREATE_ATTACHMENTAttach one previously uploaded File Manager file to a CRM task, deal, or contact.

Input Parameters

File Manager path of the previously uploaded file.
number
ID of the CRM entity receiving the attachment.
string ("task" | "deal" | "contact")
Type of CRM entity receiving the attachment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_CREATE_ATTACHMENTS_BATCHAttach a batch of previously uploaded files to CRM deals, tasks, contacts, or their comments.

Input Parameters

array
Attachments to create in one request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_CREATE_BOARDCreate a CRM task board with optional responsible-user and color settings.

Input Parameters

string
Board name.
array
Board settings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_CREATE_BOARD_ATTRIBUTECreate a typed custom attribute on a CRM task board.

Input Parameters

string
Attribute name.
number
Attribute type: 0 string, 1 number, 2 date, 3 link, 4 list, or 5 multi-list.
integer
required
Board ID that will own the attribute.
array
Options for list and multi-list attributes.
boolean
Whether the attribute is required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_CREATE_BOARD_STEPSCreate a workflow step in a CRM task board.

Input Parameters

string
Step name.
string
Step color.
integer
required
Board ID that will own the step.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_CREATE_CHECKLIST_ITEMSCreate an item in an existing CRM task checklist.

Input Parameters

string
Checklist item name.
number
Completion state: 0 not done or 1 done.
integer
required
Checklist ID that will receive the item.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_CREATE_COMPANYCreate a company record in SendPulse CRM.

Input Parameters

string
Company address.
string
Currency required when annualBusinessVolume is provided.
string
Company name.
integer
Responsible CRM user ID; SendPulse assigns one when omitted.
integer
Annual business volume.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_CREATE_COMPANY_ATTRIBUTECreate a typed custom attribute for CRM company records.

Input Parameters

string
required
Company attribute name.
integer
Attribute type: 0 text, 1 number, 2 date, 3 link, 4 select, or 5 multi-select.
array
Options for select and multi-select attributes.
boolean
Whether the attribute is mandatory.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_CREATE_COMPANY_EMAILAdd one email address to a CRM company record.

Input Parameters

object
Email values to create.
integer
required
Company ID that will receive the email.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_CREATE_COMPANY_MESSENGERConnect one messenger contact record to a CRM company.

Input Parameters

object
Messenger values to create.
integer
required
Company ID that will receive the messenger record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_CREATE_COMPANY_PHONECreate a phone record for a SendPulse CRM company.

Input Parameters

object
Phone record to create.
integer
required
Company ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_CREATE_CONTACTCreate a SendPulse CRM contact with a responsible team member and basic identity fields.

Input Parameters

string
Contact last name.
string
Contact first name.
integer
required
Team member ID assigned to the contact.
string
External contact ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_CREATE_CONTACT_ATTRIBUTECreate a custom attribute for SendPulse CRM contacts.

Input Parameters

string
required
Attribute name.
integer
Attribute type code from 0 through 5.
array
Select options.
boolean
Whether the attribute is required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_CREATE_CONTACT_DEPRECATEDCreate a SendPulse CRM contact through the deprecated full-contact endpoint.

Input Parameters

array
Tag IDs to add.
array
Email addresses.
array
International phone numbers.
string
Contact last name.
string
Contact first name.
array
Contact attributes to add.
array
Messenger accounts to add.
array
Previously uploaded file-manager paths to attach.
integer
required
Team member ID assigned to the contact.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_CREATE_CONTACT_TAGCreate a tag for SendPulse CRM contacts.

Input Parameters

string
required
Tag name, up to 64 characters.
string
Text color.
string
Background color.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_CREATE_CUSTOM_TABCreate a custom tab for a SendPulse CRM entity type.

Input Parameters

string
Custom tab name.
integer
Related board or pipeline ID.
integer
Entity type code from 0 through 3.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_CREATE_DEALCreate a deal in a SendPulse CRM pipeline.

Input Parameters

string
Deal name.
number
Deal amount.
integer
required
Pipeline step ID.
array
Contact IDs associated with the deal.
string
Deal currency such as UAH, USD, or EUR.
integer
External source ID.
array
Deal attribute values.
integer
required
Pipeline ID.
array
Previously uploaded file-manager paths to attach.
integer
Responsible team member ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_CREATE_MANAGER_SETTINGSAssign CRM managers to a SendPulse manager-settings section.

Input Parameters

integer
SectionId value documented by SendPulse.
array
ResponsibleIds value documented by SendPulse.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_CREATE_PAYMENTRecord a manual payment for a SendPulse CRM contact or deal.

Input Parameters

integer
Payment amount
integer
Deal ID for which you need to create payment.
string
Payment currency
integer
Contact ID for which you need to create payment.
string
Description value documented by SendPulse.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_CREATE_PIPELINECreate a SendPulse CRM deal pipeline with optional settings.

Input Parameters

string
Pipeline name
array
Settings value documented by SendPulse.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_CREATE_PIPELINE_ATTRIBUTECreate a custom deal attribute in a SendPulse CRM pipeline.

Input Parameters

string
required
Name value documented by SendPulse.
integer
required
0 = Text, 1 = Number, 2 = Date, 3 = Link, 4 = Select, 5 = MultiSelect
array
Options value documented by SendPulse.
boolean
Mandatory value documented by SendPulse.
integer
required
SendPulse pipelineId parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_CREATE_PIPELINE_STEPCreate a stage in a specified SendPulse CRM deal pipeline.

Input Parameters

string
Name value documented by SendPulse.
string ("#000000" | "black")
Step color
integer
Order value documented by SendPulse.
string ("0" | "15min" | "30min" | "1h" | "2h" | "3h" | "6h" | "12h" | "24h" | "2d" | "3d" | "4d" | "5d" | "6d" | "7d")
Time notification
integer
required
SendPulse pipelineId parameter.
integer ("1" | "2" | "3" | "4" | "5" | "6" | "8" | "9" | "10")
Add number of hours or null

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_CREATE_PRODUCTCreate a SendPulse CRM product with pricing, inventory, and category details.

Input Parameters

object
Product SEO info.
string
Product name. Max length 255
number
Product type . 1 - product, 2 - service, 3 - subscription (expected soon)
array
Product images. Path from File manager service
array
Prices value documented by SendPulse.
object
Product balance.
integer ("0" | "1")
Product visibility. 0 - not visible, 1 - visible
array
Product sections.
number
Category ID. It can be obtained with the “Get users categories” method
string
Product vendor code. Max length 255
string
Product description. Max length 10000
object
Product digital info.
integer ("1" | "2" | "3")
Product type. 1 - physical, 2 - digital
integer ("1" | "2" | "3")
Product availability. 1 - available, 2 - unavailable, 3 - expecting
string
Product short description. Max length 10000

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_CREATE_PRODUCT_CATEGORYCreate a category for organizing SendPulse CRM products.

Input Parameters

string
Name of the category
number
ID of parent category. Null for root.
array
Sections belonging to the category

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_CREATE_PRODUCT_SECTIONSCreate sections and their attribute values for a SendPulse CRM product.

Input Parameters

array
List of sections to update
integer
required
ID of the product to update sections for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_CREATE_TASKCreate a SendPulse CRM task with ownership, scheduling, and optional recurrence.

Input Parameters

string
Task name
array
IDs of tags
string ("0" | "15min" | "30min" | "1h" | "2h" | "3h" | "6h" | "12h" | "24h" | "2d" | "3d" | "4d" | "5d" | "6d" | "7d")
Notification lead time before task expiry, or 0 for no notification.
integer
Do you need to repeat the task
integer
StepId value documented by SendPulse.
integer
BoardId value documented by SendPulse.
string
StartAt value documented by SendPulse.
string
FinishAt value documented by SendPulse.
integer
Parent task ID
integer
Priority value documented by SendPulse.
array
Array of users IDs acting as observers
array
Attributes value documented by SendPulse.
array
Checklists value documented by SendPulse.
integer
SourceType value documented by SendPulse.
array
First, the file must be uploaded to the file manager, and then the file can be attached.
object
Connections value documented by SendPulse.
string
Task description
object
RepeatSetting value documented by SendPulse.
integer
Responsible user ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_CREATE_TASK_ATTRIBUTE_VALUESet a custom attribute value on a SendPulse CRM task.

Input Parameters

string
Attribute value as a scalar string or array of values
integer
required
SendPulse taskId parameter.
number
ID of attribute

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_CREATE_TASK_CHECKLISTCreate one empty checklist on a SendPulse CRM task.

Input Parameters

string
Checklist name
integer
required
SendPulse taskId parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_CREATE_TASK_CHECKLISTSCreate multiple checklists and their items on a SendPulse CRM task.

Input Parameters

integer
required
SendPulse taskId parameter.
array
Checklists value documented by SendPulse.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_CREATE_TASK_TAGCreate a task tag

Input Parameters

string
Tag name
string
Tag color

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_DELETE_ATTACHMENTPermanently detach a file attachment from SendPulse CRM.

Input Parameters

integer
required
ID of the file attachment to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_DELETE_ATTRIBUTE_VALUEDelete a value from a SendPulse CRM task attribute.

Input Parameters

integer
required
ID of the task board containing the attribute.
integer
required
ID of the task attribute value to delete.
integer
required
ID of the task attribute containing the value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_DELETE_CHECKLIST_ITEMPermanently delete an item from a SendPulse CRM checklist.

Input Parameters

integer
required
ID of the checklist item to delete.
integer
required
ID of the checklist containing the item.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_DELETE_COMPANYPermanently delete a company from SendPulse CRM.

Input Parameters

integer
required
ID of the company to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_DELETE_COMPANY_ATTRIBUTEPermanently delete a company attribute from SendPulse CRM.

Input Parameters

integer
required
ID of the company attribute to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_DELETE_COMPANY_EMAILRemove an email address from a SendPulse CRM company.

Input Parameters

integer
required
ID of the email address to delete.
integer
required
ID of the company containing the email address.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_DELETE_COMPANY_MESSENGERRemove a messenger from a SendPulse CRM company.

Input Parameters

integer
required
ID of the company containing the messenger.
string
CRM entity type; the API accepts only company.
integer
required
ID of the messenger to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_DELETE_COMPANY_PHONERemove a phone number from a SendPulse CRM company.

Input Parameters

integer
required
ID of the phone number to delete.
integer
required
ID of the company containing the phone number.
string
CRM entity type; the API accepts only company.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_DELETE_CONTACT_ATTRIBUTEPermanently delete a contact attribute from SendPulse CRM.

Input Parameters

integer
required
ID of the contact attribute to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_DELETE_CONTACT_ATTRIBUTE_VALUERemove an attribute value from a SendPulse CRM contact.

Input Parameters

integer
required
ID of the contact containing the attribute value.
integer
required
ID of the attribute value to remove from the contact.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_DELETE_CONTACT_BY_IDPermanently remove a SendPulse CRM contact by ID.

Input Parameters

integer
required
ID of the contact to remove.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_DELETE_CONTACT_COMMENTRemove a note from a SendPulse CRM contact.

Input Parameters

integer
required
ID of the note to remove from the contact.
integer
required
ID of the contact containing the note.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_DELETE_CONTACT_COMPANY_RELATIONRemove the relation between a SendPulse CRM contact and company.

Input Parameters

integer
required
ID of the company to unlink from the contact.
integer
required
ID of the contact to remove from the company.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_DELETE_CONTACT_EMAILRemove an email address from a SendPulse CRM contact.

Input Parameters

integer
required
ID of the email address to remove from the contact.
integer
required
ID of the contact containing the email address.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_DELETE_CONTACT_PHONERemove a phone number from a SendPulse CRM contact.

Input Parameters

integer
required
ID of the phone number to remove from the contact.
integer
required
ID of the contact containing the phone number.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_DELETE_CONTACT_TAGPermanently delete a contact tag from SendPulse CRM.

Input Parameters

integer
required
Tag ID returned by the CRM contact-tag list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_DELETE_CONTACT_TAG_FROM_CONTACTRemove a tag association from a SendPulse CRM contact.

Input Parameters

integer
required
ID of the tag to remove from the contact.
integer
required
ID of the contact from which to remove the tag.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_DELETE_CUSTOM_TABPermanently delete a custom tab from SendPulse CRM.

Input Parameters

integer
Related entity ID, used only for pipelines and boards.
integer ("0" | "1" | "2" | "3")
Entity type: 0 is contact, 1 is pipeline, 2 is board, and 3 is company.
integer
required
Custom tab ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_DELETE_CUSTOM_TAB_RELATIONRemove attribute relations from a SendPulse CRM custom tab.

Input Parameters

integer
Related entity ID, used only for pipelines and boards.
array
IDs of related attributes to unlink.
integer ("0" | "1" | "2" | "3")
Entity type: 0 is contact, 1 is pipeline, 2 is board, and 3 is company.
integer
required
Custom tab ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_DELETE_DEALPermanently delete a deal from SendPulse CRM.

Input Parameters

integer
required
ID of the deal to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_DELETE_DEAL_ATTRIBUTERemove an attribute from a SendPulse CRM deal.

Input Parameters

integer
required
ID of the deal containing the attribute.
integer
required
ID of the attribute to remove from the deal.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_DELETE_DEAL_COMMENTRemove a note from a SendPulse CRM deal.

Input Parameters

integer
required
ID of the deal containing the note.
integer
required
ID of the note to remove from the deal.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_DELETE_MANAGERS_FROM_MANAGER_SETTINGRemove responsible managers from a SendPulse CRM settings category.

Input Parameters

integer
required
ID of the manager-settings category.
array
IDs of responsible managers to remove.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_DELETE_PIPELINE_ATTRIBUTEDelete a deal attribute from a SendPulse CRM pipeline.

Input Parameters

integer
required
ID of the pipeline containing the deal attribute.
integer
required
ID of the deal attribute to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_DELETE_PIPELINE_STEPDelete a step from a SendPulse CRM pipeline.

Input Parameters

integer
required
ID of the pipeline step to delete.
integer
required
ID of the pipeline containing the step.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_DELETE_PRODUCTDelete a SendPulse CRM product by ID.

Input Parameters

integer
required
ID of the product to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_DELETE_PRODUCT_CATEGORYDelete a SendPulse CRM product category by ID.

Input Parameters

integer
required
ID of the product category to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_DELETE_PRODUCT_SECTIONDelete a section from a SendPulse CRM product.

Input Parameters

integer
required
ID of the product containing the section.
integer
required
ID of the product section to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_DELETE_TASKDelete a SendPulse CRM task by ID.

Input Parameters

integer
required
ID of the task to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_DELETE_TASK_CHECKLISTDelete a checklist from a SendPulse CRM task.

Input Parameters

integer
required
ID of the task containing the checklist.
integer
required
ID of the checklist to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_DELETE_TASK_TAGDelete a SendPulse CRM task tag by ID.

Input Parameters

integer
required
ID of the task tag to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_DETACH_CONTACT_FROM_TASKDetach a contact from a SendPulse CRM task.

Input Parameters

integer
required
ID of the task from which to detach the contact.
integer
required
ID of the contact to detach.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_DETACH_DEAL_FROM_TASKDetach a deal from a SendPulse CRM task.

Input Parameters

integer
required
ID of the deal to detach.
integer
required
ID of the task from which to detach the deal.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_DETACH_PRODUCT_FROM_DEALDetach a SendPulse CRM product from a deal.

Input Parameters

integer
required
ID of the deal from which to detach the product.
integer
required
ID of the product to detach.
integer
required
ID of the category containing the product.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_DETACH_TAG_FROM_TASKDetach a tag from a SendPulse CRM task.

Input Parameters

integer
required
ID of the tag to detach.
integer
required
ID of the task from which to detach the tag.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_DETACH_TASK_FROM_TASKDetach a child task from another SendPulse CRM task.

Input Parameters

integer
required
ID of the child task to detach.
integer
required
ID of the parent task.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_GET_ALL_PAYMENTSRetrieve payments belonging to the connected SendPulse account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_GET_BOARD_ATTRIBUTESGet attributes configured for a SendPulse CRM task board.

Input Parameters

integer
required
ID of the CRM task board whose attributes to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_GET_BOARD_BY_IDGet one SendPulse CRM task board by ID.

Input Parameters

integer
required
ID of the CRM task board to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_GET_BOARDSRetrieve SendPulse CRM task boards. The response schema represents data as a single board object, not a list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_GET_CATEGORY_PRODUCTRetrieve full CRM product details in a specific category context.

Input Parameters

integer
required
Product ID to retrieve.
integer
required
Category ID containing the product.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_GET_COMPANIES_LISTRetrieve CRM companies using structured filters, sorting, limit, and offset.

Input Parameters

string
Company email filter.
integer
Maximum companies to return.
string
Company phone filter.
string
End of the company date range.
integer
Number of matching companies to skip.
object
Company sorting configuration.
string
Beginning of the company date range.
array
Custom attribute filters.
array
Company IDs to include.
string
Company name filter.
string
Global search string; when supplied, SendPulse ignores all other filters.
array
Responsible user IDs to include.
string
Messenger login filter.
boolean
Provider company contact-state filter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_GET_COMPANIES_SHORT_DATARetrieve lightweight CRM company records using structured filters and sorting.

Input Parameters

string
Company email filter.
integer
Maximum companies to return.
string
Company phone filter.
string
End of the company date range.
integer
Number of matching companies to skip.
object
Company sorting configuration.
string
Beginning of the company date range.
array
Custom attribute filters.
array
Company IDs to include.
string
Company name filter.
string
Global search string; when supplied, SendPulse ignores all other filters.
array
Responsible user IDs to include.
string
Messenger login filter.
boolean
Provider company contact-state filter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_GET_COMPANY_ATTRIBUTESGet the SendPulse CRM company attribute list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_GET_COMPANY_BY_IDGet one SendPulse CRM company by ID.

Input Parameters

integer
required
ID of the CRM company to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_GET_COMPANY_EMAILSGet email addresses associated with a SendPulse CRM company.

Input Parameters

integer
required
ID of the CRM company whose emails to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_GET_COMPANY_HISTORYGet one page of SendPulse CRM company history with a continuation cursor.

Input Parameters

integer
Number of history records requested per page.
string
Continuation cursor returned by a previous call.
integer
Zero-based history record offset for the first page.
string
End date-time for the history range, for example 2024-11-01 12:12:12+00:00.
string
Start date-time for the history range, for example 2024-11-01 12:12:12+00:00.
integer
required
ID of the CRM company whose history to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_GET_COMPANY_MESSENGERSGet messenger accounts associated with a SendPulse CRM company.

Input Parameters

integer
required
ID of the CRM company whose messengers to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_GET_COMPANY_PHONESGet phone numbers associated with a SendPulse CRM company.

Input Parameters

integer
required
ID of the CRM company whose phones to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_GET_CONTACT_ATTRIBUTESGet the SendPulse CRM contact attribute list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_GET_CONTACT_ATTRIBUTE_VALUESRetrieve the configured attribute values for a CRM contact.

Input Parameters

integer
required
Contact ID returned by SendPulse CRM.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_GET_CONTACT_BY_EXTERNAL_IDLook up a CRM contact by an external system contact ID.

Input Parameters

integer
required
External contact ID from another source system.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_GET_CONTACT_BY_IDRetrieve identity, ownership, channels, and related data for a CRM contact.

Input Parameters

integer
required
Contact ID returned by SendPulse CRM.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_GET_CONTACT_BY_MESSENGER_EXTERNAL_IDLook up a CRM contact by its external messenger contact ID.

Input Parameters

string
required
External contact ID from a connected messenger.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_GET_CONTACT_CALLSList telephony calls associated with a SendPulse CRM contact.

Input Parameters

string
End date and time.
string
Start date and time.
integer ("1" | "2" | "3")
Call state: 1 pending, 2 successful, or 3 failed.
integer ("0" | "1")
Call type: 0 incoming or 1 outgoing.
integer
required
Contact ID.
string
Contact email filter.
string
Contact phone filter.
array
Responsible user IDs.
string
Contact last-name filter.
string
Contact first-name filter.
integer
Integration group ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_GET_CONTACT_DEALSRetrieve all CRM deals associated with a contact.

Input Parameters

integer
required
Contact ID returned by SendPulse CRM.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_GET_CONTACT_EDU_PAYMENTSRetrieve EDU course payment history for a CRM contact.

Input Parameters

integer
required
Contact ID returned by SendPulse CRM.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_GET_CONTACT_EDU_STATISTICRetrieve course, lesson, and test progress for a CRM contact.

Input Parameters

integer
required
Contact ID returned by SendPulse CRM.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_GET_CONTACT_HISTORYRetrieve a CRM contact’s activity history within a required date range.

Input Parameters

string
required
Inclusive range end as a date-time, for example 2024-12-13 12:12:12+00:00.
string
required
Inclusive range start as a date-time, for example 2024-12-12 12:12:12+00:00.
integer
required
Contact ID returned by SendPulse CRM.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_GET_CONTACT_LIST_BY_EMAILFind SendPulse CRM contacts by full or partial email address.

Input Parameters

string
Contact email to search for.
Whether the email must match completely.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_GET_CONTACTS_LISTSearch and list SendPulse CRM contacts.

Input Parameters

string
Creation end date in YYYY-MM-DD.
array
Contact IDs.
string
Email filter.
string
Creation start date in YYYY-MM-DD.
integer
Records to return.
string
Phone filter.
integer
Records to skip.
object
Sort configuration.
array
Contact tag IDs.
string
Last-name filter.
string
Location filter.
string
Update end date in YYYY-MM-DD.
string
First-name filter.
array
Attribute filters.
array
Source type codes.
string
Update start date in YYYY-MM-DD.
string
Messenger login filter.
array
Responsible user IDs.
array
Messenger type IDs.
array
Field-value conditions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_GET_CUSTOM_TABSRetrieve custom CRM tab definitions grouped by entity type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_GET_DEALRetrieve details for a CRM deal by ID.

Input Parameters

integer
required
Deal ID returned by SendPulse CRM.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_GET_DEAL_ATTRIBUTE_VALUESRetrieve configured attribute values for a CRM deal.

Input Parameters

integer
required
Deal ID returned by SendPulse CRM.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_GET_DEAL_CALLSList telephony calls associated with a SendPulse CRM deal.

Input Parameters

integer
required
SendPulse dealId parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_GET_DEAL_COMMENTSRetrieve notes and their attachments for a CRM deal.

Input Parameters

integer
required
Deal ID returned by SendPulse CRM.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_GET_DEAL_CONTACTSRetrieve contacts associated with a CRM deal.

Input Parameters

integer
required
Deal ID returned by SendPulse CRM.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_GET_DEAL_HISTORYRetrieve a CRM deal’s history within a required date range.

Input Parameters

integer
required
Deal ID returned by SendPulse CRM.
string
required
Inclusive history range end as a date-time.
string
required
Inclusive history range start as a date-time.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_GET_DEAL_PAYMENTSRetrieve payments associated with a CRM deal.

Input Parameters

integer
required
Deal ID returned by SendPulse CRM.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_GET_DEALS_LISTSearch and list SendPulse CRM deals.

Input Parameters

string
Deal name filter.
string
Associated contact email.
integer
Records to return.
string
Associated contact phone.
array
Deal-field filters.
integer
Records to skip.
object
Sort configuration.
string
Associated contact last name.
string
Associated contact first name.
boolean
Return all active deals without a limit.
array
Attribute filters.
integer
Expiration filter code from 1 through 5.
array
Pipeline IDs.
string
Completion end date.
string
Completion start date.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_GET_MANAGERS_BY_SECTIONRetrieve managers assigned to a CRM manager settings section.

Input Parameters

integer
required
CRM manager settings section ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_GET_MANAGER_SETTINGS_MANAGERSRetrieve all managers available in CRM manager settings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_GET_MESSENGER_TYPESRetrieve messenger types supported by SendPulse CRM.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_GET_PAYMENTS_BY_CONTACT_IDRetrieve payments associated with a CRM contact.

Input Parameters

integer
required
Contact ID returned by SendPulse CRM.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_GET_PIPELINE_BY_IDRetrieve a CRM pipeline, including its steps and settings, by ID.

Input Parameters

integer
required
Pipeline ID returned by SendPulse CRM.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_GET_PIPELINE_STEPSRetrieve steps configured for a CRM pipeline.

Input Parameters

integer
required
Pipeline ID returned by SendPulse CRM.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_GET_PRODUCT_BY_IDRetrieve the complete CRM product record by ID.

Input Parameters

integer
required
Product ID to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_GET_PRODUCT_CATEGORIESRetrieve the complete hierarchical CRM product category tree.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_GET_PRODUCTS_BY_CONTACT_DEALSRetrieve products associated with CRM deals linked to a contact.

Input Parameters

integer
required
CRM contact ID whose deal products to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_GET_PRODUCTS_BY_DEAL_IDRetrieve products, quantities, and pricing attached to a CRM deal.

Input Parameters

integer
required
CRM deal ID whose products to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_GET_PRODUCTS_BY_FILTERSearch SendPulse CRM products by category, price, stock, visibility, or text filters.

Input Parameters

number
Maximum number of results to return.
object
Filter by product price or old price.
string
End date for filtering (format: YYYY-MM-DD).
number
Offset for pagination.
Text search by product name or code.
object
Filter by product stock balance and unit type.
object
Sorting options.
integer ("0" | "1")
Product visibility status (0 = hidden, 1 = visible).
string
Start date for filtering (format: YYYY-MM-DD).
array
Filter by section-specific key-value attributes.
object
Filter by number of purchases.
number
Category ID to filter products.
array
List of category IDs to include in filter.
string
Description for products
integer ("1" | "2")
Product type (1 = physical, 2 = digital/service).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_GET_TASK_BY_IDRetrieve the complete state of a CRM task by ID.

Input Parameters

integer
required
CRM task ID to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_GET_TASK_CHECKLISTSRetrieve checklist data for a CRM task. The response is modeled as a single checklist with a single item.

Input Parameters

integer
required
CRM task ID whose checklists to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_GET_TASK_HISTORYRetrieve a CRM task audit trail within a required date-time range.

Input Parameters

integer
required
CRM task ID whose history to retrieve.
string
required
End of the history window as an ISO 8601 date-time.
string
required
Start of the history window as an ISO 8601 date-time.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_GET_TASK_REPEAT_TEMPLATESRetrieve predefined templates for recurring CRM tasks.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_GET_TASK_TAGSRetrieve all tags available for CRM tasks.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_GET_TELEPHONY_CALLSSearch SendPulse CRM telephony calls by date, direction, state, or assignee.

Input Parameters

string
End of the call date range in ISO 8601 date-time format.
string
Start of the call date range in ISO 8601 date-time format.
integer
Call state: 1 pending, 2 successful, or 3 failed.
integer
Call type: 0 incoming or 1 outgoing.
string
Filter by contact email address.
string
Filter by contact phone number.
array
CRM user IDs responsible for the calls.
string
Filter by contact last name.
string
Filter by contact first name.
integer
Telephony integration group ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_GET_USERSRetrieve active confirmed team members available for CRM assignments.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_LIST_CONTACT_TAGSGet SendPulse CRM contact tags with optional exact or partial name filters.

Input Parameters

string
Exact tag name to match.
string
Text to find within tag names using a partial match.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_LIST_DEAL_ATTRIBUTES_BY_PIPELINEList deal attribute definitions for a CRM pipeline.

Input Parameters

integer
required
Pipeline ID returned by SendPulse CRM.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_LIST_MANAGER_SETTINGS_SECTIONSRetrieve all sections configured in CRM manager settings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_LIST_PIPELINE_ATTRIBUTESRetrieve deal attribute definitions configured for a CRM pipeline.

Input Parameters

integer
required
Pipeline ID returned by SendPulse CRM.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_LIST_TASKSRetrieves a list of tasks based on selected filters

Input Parameters

string
Name value documented by SendPulse.
object
Sort value documented by SendPulse.
array
IDs of tags
integer ("1" | "2" | "3")
Type value documented by SendPulse.
integer ("1" | "2")
Status value documented by SendPulse.
array
Array of step IDs
integer
BoardId value documented by SendPulse.
string
Contacts value documented by SendPulse.
string
DealName value documented by SendPulse.
array
Array of parent task IDs
integer
Priority value documented by SendPulse.
string ("any" | "all")
Filter by tags (all - all tags, any - any tag). Default: any
string
EndedAtTo value documented by SendPulse.
array
Array of users IDs acting as observers
string
StartAtTo value documented by SendPulse.
array
Attributes value documented by SendPulse.
string
FinishAtTo value documented by SendPulse.
string
CreatedAtTo value documented by SendPulse.
string
EndedAtFrom value documented by SendPulse.
string
StartAtFrom value documented by SendPulse.
string
UpdatedAtTo value documented by SendPulse.
string
FinishAtFrom value documented by SendPulse.
string
CreatedAtFrom value documented by SendPulse.
array
Array of responsible users IDs
string
UpdatedAtFrom value documented by SendPulse.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_REMOVE_CONTACT_MESSENGERRemove a messenger from a SendPulse CRM contact.

Input Parameters

integer
required
ID of the contact containing the messenger.
integer
required
ID of the messenger to remove from the contact.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_REMOVE_DEAL_CONTACTRemove a contact association from a SendPulse CRM deal.

Input Parameters

integer
required
ID of the deal from which to remove the contact.
integer
required
ID of the contact to remove from the deal.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_REMOVE_DEAL_EXPIRATIONRemove the expiration setting from a SendPulse CRM deal.

Input Parameters

integer
required
Deal ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_REORDER_CHECKLIST_ITEMChange the position of an item within a CRM task checklist.

Input Parameters

number
New item position in the checklist.
integer
required
Checklist item ID to reorder.
integer
required
Checklist ID containing the item.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_SET_TASK_PARENTSet or clear the parent relationship for a SendPulse CRM task.

Input Parameters

integer
required
SendPulse taskId parameter.
number
Parent task ID or null

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_UPDATE_ATTACHMENTUpdate a SendPulse CRM attachment’s file link using a file previously uploaded to the SendPulse file manager.

Input Parameters

Path of a file previously uploaded to the SendPulse file manager.
integer
required
SendPulse attachmentId parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_UPDATE_BOARDUpdate the name and settings of a SendPulse CRM task board by ID.

Input Parameters

string
Name value documented by SendPulse.
integer
required
SendPulse boardId parameter.
array
Settings value documented by SendPulse.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_UPDATE_BOARD_ATTRIBUTEUpdate a custom attribute configured on a SendPulse CRM task board.

Input Parameters

string
Attribute name
number
Attribute type: 0 -string 1 - number 2 - date 3 - link 4 - list 5 - multiList
integer
Attribute order
integer
Status value documented by SendPulse.
integer
required
SendPulse boardId parameter.
array
Attribute options (only for “list” and “multiList” types
boolean
Is attribute required
integer
required
SendPulse attributeId parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_UPDATE_BOARD_STEPUpdate a SendPulse CRM task-board step name, color, or display order.

Input Parameters

string
Step name
string
Step color
integer
Step order
integer
required
SendPulse stepId parameter.
integer
required
SendPulse boardId parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_UPDATE_CHECKLIST_ITEMUpdate the text or completion state of a SendPulse CRM checklist item.

Input Parameters

string
Checklist item name
number
Is checklist item done (checked). 0 - no, 1 - yes
integer
required
SendPulse itemId parameter.
integer
required
SendPulse checklistId parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_UPDATE_COMPANYUpdate a SendPulse CRM company’s name, responsible user, annual business volume, or currency.

Input Parameters

string
Currency value documented by SendPulse.
integer
required
SendPulse companyId parameter.
string
Company name.
integer
ResponsibleId value documented by SendPulse.
integer
AnnualBusinessVolume value documented by SendPulse.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_UPDATE_COMPANY_ATTRIBUTEUpdate a company attribute

Input Parameters

string
required
Name value documented by SendPulse.
integer
0 = Text, 1 = Number, 2 = Date, 3 = Link, 4 = Select, 5 = MultiSelect
integer
required
Order value documented by SendPulse.
integer
0 = Inactive, 1 = Active, 2 = Hidden
array
Options value documented by SendPulse.
boolean
Mandatory value documented by SendPulse.
integer
required
Company attribute ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_UPDATE_COMPANY_EMAILReplace an email address associated with a SendPulse CRM company.

Input Parameters

object
Data value documented by SendPulse.
integer
required
SendPulse emailId parameter.
integer
required
SendPulse companyId parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_UPDATE_COMPANY_MESSENGERUpdate a messenger account associated with a SendPulse CRM company.

Input Parameters

object
Data value documented by SendPulse.
integer
required
Company ID.
string
required
SendPulse entityType parameter.
integer
required
SendPulse messengerId parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_UPDATE_COMPANY_PHONEReplace a phone number associated with a SendPulse CRM company.

Input Parameters

object
Data value documented by SendPulse.
integer
required
SendPulse phoneId parameter.
integer
required
Company ID.
string
required
SendPulse entityType parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_UPDATE_CONTACTUpdate the name or responsible team member of a SendPulse CRM contact.

Input Parameters

string
Contact last name
integer
required
Contact ID of the contact whose information you want to update. It can be obtained with the “Get a list of contacts” method
string
Contact first name
integer
required
Team member ID to assign to a contact. It can be obtained with the “Get a list of team members” method

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_UPDATE_CONTACT_ATTRIBUTEUpdate a contact attribute

Input Parameters

string
required
Name value documented by SendPulse.
integer
0 = Text, 1 = Number, 2 = Date, 3 = Link, 4 = Select, 5 = MultiSelect
integer
required
Order value documented by SendPulse.
integer
0 = Inactive, 1 = Active, 2 = Hidden
array
Options value documented by SendPulse.
boolean
Mandatory value documented by SendPulse.
integer
required
SendPulse attributeId parameter.
boolean
ContactCardShow value documented by SendPulse.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_UPDATE_CONTACT_ATTRIBUTE_VALUEUpdates the attribute for the specified contact. Provided property values will be overwritten.

Input Parameters

string
required
New attribute value. The maximum number of characters is 5500
integer
required
Contact ID for which you want to update the field. It can be obtained with the “Get a list of contacts” method
integer
required
Attribute ID you want to update. It can be obtained with the “Get a list of contacts” and “Get information about a contact by ID” methods

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_UPDATE_CONTACT_COMMENTUpdates the note of the specified contact. Provided property values will be overwritten.

Input Parameters

string
required
New note message. The maximum number of characters is 65,535
integer
required
Note ID you want to update. It can be obtained with the “Get a list of contacts” method
integer
required
Contact ID contact for which you want to update the note. It can be obtained with the “Get a list of contacts” method

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_UPDATE_CONTACT_EMAILUpdates the email address of the specified contact

Input Parameters

string
required
New email address
integer
required
Email address ID you want to update. It can be obtained with the “Get a list of contacts” method
integer
required
Contact ID for which you want to update the email address. It can be obtained with the “Get a list of contacts” method

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_UPDATE_CONTACT_MESSENGERUpdates information about a given messenger for the specified contact. Provided property values will be overwritten.

Input Parameters

string
required
Contacts login in the specified messenger
integer
required
TypeId value documented by SendPulse.
integer
required
Contact ID for which you want to update messenger information. It can be obtained with the “Get a list of contacts” method
integer
required
Messenger ID you want to update. It can be obtained with the “Get a list of contacts” method
boolean
Determine if chatbot messenger is the main one

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_UPDATE_CONTACT_PHONEUpdates the phone number of the specified contact. Provided property values will be overwritten.

Input Parameters

string
required
New phone number in the international format
integer
required
The phone number ID you want to update. It can be obtained with the “Get a list of contacts” method
integer
required
Contact ID for which you want to update the phone number. It can be obtained with the “Get a list of contacts” method

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_UPDATE_CONTACT_TAGUpdates the specified tag with a new name. Provided property values will be overwritten.

Input Parameters

string
required
New tag name. The maximum number of characters is 255
integer
required
Tag ID you want to update. It can be obtained with the “Get a list of contact tags” method
string
Text color
string
Background color

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_UPDATE_CUSTOM_TABUpdate the name and entity placement of a SendPulse CRM custom tab.

Input Parameters

string
Custom tab name
integer
Custom tab order
integer
Related entity ID. Only for pipelines and boards
boolean
Indicates whether the entity is visible to users
integer ("0" | "1" | "2" | "3")
0 - contact, 1 - pipeline, 2 - board, 3 - company
integer
required
Custom tab ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_UPDATE_DEAL_ATTRIBUTE_VALUEUpdates the deal attribute with the new value. Existing values will be overwritten.

Input Parameters

string
required
New attribute value. The maximum number of characters is 5500
integer
required
The deal ID for which you want to update the attribute. It can be obtained with the “Get a list of deals” method
integer
required
The attribute ID you want update. It can be obtained with the “Get a list of deals” and “Get information about the deal by ID” methods

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_UPDATE_DEAL_BY_IDUpdates information in the specified deal. Provided property values will be overwritten

Input Parameters

string
required
Deal name
integer
Field display order. If empty, the deal will be placed at the top of the list.
number
required
Deal amount
integer
required
Deal ID to be updated. You can get it in the “Get a list of deals” method
integer
required
Status value documented by SendPulse.
integer
required
ID of a pipeline step where you need to place a deal. It can be obtained from the methods “Get a list of pipelines” and “Get information about a pipeline by its ID”
string
Deal currency. Accepts values in the form of UAH, USD, EUR
integer
Custom source ID of the deal from an external source
integer
required
Pipeline ID in which the deal is located. It can be obtained with the method “Get a list of pipelines”
integer
Team member ID to assign to a deal. It can be obtained with the “Get a list of team members” method

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_UPDATE_DEAL_COMMENTUpdates the selected note in the specified deal. Existing values will be overwritten

Input Parameters

integer
required
ID of the deal for which you want to update a note. It can be obtained with the “Get a list of deals” method
string
required
New note message. The maximum number of characters is 65,535
integer
required
ID of the note to be updated. It can be obtained with the “Get a list of deal notes” method

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_UPDATE_MANAGER_SETTINGReplace manager assignments in a SendPulse CRM manager-settings section.

Input Parameters

integer
SectionId value documented by SendPulse.
integer
required
SendPulse settingId parameter.
array
ResponsibleIds value documented by SendPulse.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_UPDATE_PIPELINEUpdate the name, currency, or settings of a SendPulse CRM deal pipeline.

Input Parameters

string
Pipeline name
integer
Field display order
array
Settings value documented by SendPulse.
integer
required
Pipeline ID to be updated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_UPDATE_PIPELINE_ATTRIBUTEUpdate a deal attribute

Input Parameters

string
required
Name value documented by SendPulse.
integer
0 = Text, 1 = Number, 2 = Date, 3 = Link, 4 = Select, 5 = MultiSelect
integer
required
Order value documented by SendPulse.
integer
0 = Inactive, 1 = Active, 2 = Hidden
array
Options value documented by SendPulse.
boolean
Mandatory value documented by SendPulse.
integer
required
SendPulse pipelineId parameter.
integer
required
SendPulse attributeId parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_UPDATE_PIPELINE_STEPUpdate a pipeline step

Input Parameters

string
Name value documented by SendPulse.
string ("#000000" | "black")
Step color
integer
Order value documented by SendPulse.
integer
required
SendPulse stepId parameter.
string ("0" | "15min" | "30min" | "1h" | "2h" | "3h" | "6h" | "12h" | "24h" | "2d" | "3d" | "4d" | "5d" | "6d" | "7d")
Time notification
integer
required
SendPulse pipelineId parameter.
integer ("1" | "2" | "3" | "4" | "5" | "6" | "8" | "9" | "10")
Add number of hours or null

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_UPDATE_PRODUCTUpdate details, stock, or visibility for a SendPulse CRM product.

Input Parameters

object
SEO-related metadata
string
Product name
array
Array of product image URLs
object
Stock balance information
number
Visibility flag (0 - hidden, 1 - visible)
integer
required
ID of the product to update
number
Category ID the product belongs to
string
Vendor or manufacturer code
string
Full product description
object
Digital product details
number
Product availability status
string
Short product summary

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_UPDATE_PRODUCT_CATEGORYRename or move a SendPulse CRM product category by ID.

Input Parameters

string
Name value documented by SendPulse.
number
ParentId value documented by SendPulse.
integer
required
SendPulse categoryId parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_UPDATE_PRODUCT_PRICESReplace the configured prices for a SendPulse CRM product.

Input Parameters

array
List of prices for the product
integer
required
ID of the product to update prices for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_UPDATE_PRODUCT_SECTIONSReplace or update sections and their attribute values for a SendPulse CRM product.

Input Parameters

array
List of sections to update
integer
required
ID of the product to update sections for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_UPDATE_PRODUCTS_IN_DEALUpdate quantities and prices for products attached to a SendPulse CRM deal.

Input Parameters

integer
Product amount in the deal
integer
required
SendPulse headId parameter.
integer
Product quantity in the deal

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_UPDATE_TASK_ATTRIBUTE_VALUEUpdate a custom attribute value on a SendPulse CRM task.

Input Parameters

string
Attribute value as a scalar string or array of values
integer
required
SendPulse boardId path parameter.
integer
required
SendPulse valueId parameter.
integer
required
SendPulse attributeId parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_UPDATE_TASK_BY_IDUpdate a task by ID

Input Parameters

string
Task name
array
IDs of tags
integer
Do you need to repeat the task
integer
StepId value documented by SendPulse.
integer
required
SendPulse taskId parameter.
integer
BoardId value documented by SendPulse.
string
StartAt value documented by SendPulse.
string
FinishAt value documented by SendPulse.
integer
Parent task ID
integer
Priority value documented by SendPulse.
array
Array of users IDs acting as observers
integer
SourceType value documented by SendPulse.
string
Task description
integer
Responsible user ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_UPDATE_TASK_CHECKLISTSReplace multiple checklists and their items on a SendPulse CRM task.

Input Parameters

integer
required
SendPulse taskId parameter.
array
Checklists value documented by SendPulse.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_UPDATE_TASK_CHECKLIST_SINGLERename one checklist on a SendPulse CRM task without changing its items.

Input Parameters

string
Checklist name
integer
required
SendPulse taskId parameter.
integer
required
SendPulse checklistId parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_UPDATE_TASK_COMMENTEdit an existing internal comment on a SendPulse CRM task.

Input Parameters

integer
required
SendPulse taskId parameter.
string
Comment message
integer
required
SendPulse commentId parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_UPDATE_TASK_TAGUpdate a task tag

Input Parameters

string
Tag name
string
Tag color
integer
required
SendPulse tagId parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_UPLOAD_FILESUpload one or more files for later attachment to SendPulse CRM records.

Input Parameters

array
Array of file binaries

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_CRM_UPSERT_DEAL_EXPIRATIONCreate or update expiration and notification settings for a SendPulse CRM deal.

Input Parameters

string
Expiration date
string
Expiration time
integer
required
Deal ID
string ("0" | "15min" | "30min" | "1h" | "2h" | "3h" | "6h" | "12h" | "24h" | "2d" | "3d" | "4d" | "5d" | "6d" | "7d")
Notification lead time before deal expiry, or 0 for no notification.
integer ("1" | "2")
Deal event: 1 created or 2 updated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_DELETE_FILESPermanently delete 1–25 File Manager files sequentially. Return ordered per-path outcomes when processing completes, including provider path rejection and not-found results; global or upstream failures are raised, and processing stops when a deletion outcome is uncertain.

Input Parameters

array
required
Full File Manager paths of 1-25 files to permanently delete with separate sequential requests.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_DELETE_MAILING_LISTPermanently delete one Bulk Email mailing list and its membership.

Input Parameters

integer
required
ID of the mailing list to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_EDU_CREATE_STUDENTCreate a SendPulse Education student and optionally enroll them in a course tariff.

Input Parameters

string
Student email address.
array
Tag IDs to assign to the student.
string
Preferred language or locale code.
integer
Course ID for enrollment.
string
Student last name.
string
Student first name.
integer
Course tariff ID for enrollment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_EDU_DELETE_STUDENTPermanently delete a student and associated education data from the school.

Input Parameters

integer
required
Student ID to permanently delete from the school.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_EDU_GET_COURSESGet all Education courses associated with the connected account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_EDU_GET_COURSE_TARIFFSGet all pricing tariffs available for an Education course.

Input Parameters

integer
required
Course ID whose tariffs to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_EDU_GET_SCHOOLSGet the schools registered in the connected SendPulse Education account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_EDU_GET_STUDENT_COURSE_STATISTICSGet a student’s enrollment, progress, assessment, and tariff statistics across Education courses.

Input Parameters

integer
required
Student ID whose cross-course progress to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_EDU_GET_STUDENTS_AUDITORYSearch and filter the SendPulse Education student audience.

Input Parameters

string ("asc" | "desc")
Sort direction.
array
Tag IDs assigned to students.
string
Student email substring.
integer
required
Maximum matching students to return.
integer
required
Number of matching students to skip.
boolean
Whether the student paid for at least one course.
string ("firstName" | "studentStatusOnCourse" | "studentTest" | "studentDateRegistrationOnCourse")
Field used to sort results.
integer
Course ID filter.
string
Student last-name substring.
string
Student first-name substring.
array
Student course statuses.
string
Free-text student search.
array
Promo code IDs used by students.
object
Last login date range.
boolean
Whether any promo code was used.
integer
Paid course count used by the comparison.
string ("none" | "open" | "closed")
Course access restriction filter.
string ("=" | ">=" | "<=")
Comparison operator for paid course count.
object
Course registration date range.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_EDU_GET_STUDENTS_BY_COURSEGet a filtered page of students enrolled in a SendPulse Education course.

Input Parameters

string ("asc" | "desc")
Sort direction.
array
Tag IDs assigned to students.
string
Student email substring.
integer
required
Maximum matching students to return.
integer
required
Number of matching students to skip.
boolean
Whether the student paid for at least one course.
string ("firstName" | "studentStatusOnCourse" | "studentTest" | "studentDateRegistrationOnCourse")
Field used to sort results.
object
Lesson, test, and certificate progress filters.
integer
required
Course ID.
string
Student last-name substring.
integer
Lesson ID filter.
string
Student first-name substring.
array
Assigned tariff IDs.
array
Student course statuses.
string
Free-text student search.
array
Promo code IDs used by students.
string ("all" | "any")
Require all or any supplied tags.
boolean
Whether students must lack or have a tariff; omit when tariff_ids is set.
object
Last login date range.
boolean
Whether any promo code was used.
object
Course registration date range.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_EDU_GET_TAGSGet the complete list of tags available in SendPulse Education.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_EDU_LIST_GROUPS_BY_COURSEList all student groups associated with an Education course.

Input Parameters

integer
required
Course ID whose student groups to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_EDU_MARK_STUDENTS_AS_PAIDMark one or more SendPulse Education students as paid for a course.

Input Parameters

array
Student IDs to mark as paid.
integer
required
Course ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_EDU_REMOVE_STUDENT_FROM_COURSEPermanently remove a student’s enrollment from an Education course.

Input Parameters

integer
required
Course ID from which to remove the student.
integer
required
Student ID to remove from the course.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_FACEBOOK_ASSIGN_CONTACT_OPERATORAssign a responsible operator to a SendPulse Facebook contact chat.

Input Parameters

string
required
Contact ID whose chat to assign.
integer
required
Operator ID to make responsible for the chat.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_FACEBOOK_CLOSE_CONTACT_CHATClose a SendPulse Facebook contact chat and lower its queue priority.

Input Parameters

string
required
Contact ID whose chat to close.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_FACEBOOK_CREATE_CONTACT_NOTECreate an internal operator note for a SendPulse Facebook contact.

Input Parameters

string
required
Operator note text.
string
required
Bot ID associated with the contact.
string
required
Contact ID to annotate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_FACEBOOK_DELETE_CONTACTPermanently remove a contact from a SendPulse Facebook bot audience.

Input Parameters

string
required
Contact ID to permanently remove.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_FACEBOOK_DELETE_CONTACT_NOTEPermanently remove an operator note from a SendPulse Facebook contact.

Input Parameters

string
required
Bot ID associated with the contact.
string
required
Note ID to permanently remove.
string
required
Contact ID associated with the note.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_FACEBOOK_DELETE_CONTACT_TAGRemove a tag from a SendPulse Facebook contact.

Input Parameters

string
required
Tag to remove.
string
required
Contact ID from which to remove the tag.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_FACEBOOK_DELETE_CONTACT_VARIABLEDelete one variable value from a SendPulse Facebook contact.

Input Parameters

string
required
Contact ID whose variable value to delete.
string
Variable ID; provide this or variable_name.
string
Variable name; provide this or variable_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_FACEBOOK_DELETE_PAUSE_AUTOMATIONRemove an automation pause and resume autoflows for a SendPulse Facebook contact.

Input Parameters

string
required
Contact ID whose autoflows to resume.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_FACEBOOK_DISABLE_CONTACTDisable a SendPulse Facebook contact so campaigns and autoflows are not sent to them.

Input Parameters

string
required
Contact ID to disable.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_FACEBOOK_ENABLE_CONTACTEnable a SendPulse Facebook contact so campaigns and autoflows can resume.

Input Parameters

string
required
Contact ID to enable.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_FACEBOOK_GET_ACCOUNTReturns information about your current account pricing plan, the number of messages in your plan, bots, contacts, list of tags, and variables

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_FACEBOOK_GET_BOT_STATISTICSReturns general statistics info by bot

Input Parameters

string
required
The bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_FACEBOOK_GET_CHAT_MESSAGESReturns a page of messages in correspondence with the specified Facebook subscriber, with a continuation cursor for further pages.

Input Parameters

integer
The limit of pagination items, that will be returned
integer
The offset of pagination items, where starts a current items batch
string ("asc" | "desc")
Sort order ASC or DESC
string
Continuation cursor returned by a previous call.
string
required
Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_FACEBOOK_GET_CHATSReturns a list of chats with subscribers with information about the contact and the last message received from the contact

Input Parameters

integer
Provider size query parameter.
integer
Provider skip query parameter.
string
required
Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.
string
Continuation cursor returned by a previous call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_FACEBOOK_GET_CONTACTReturns information on the selected contact: bot and contact ID, information from Facebook, list of tags and variables, activity data and date added

Input Parameters

string
required
Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_FACEBOOK_GET_CONTACT_NOTESReturns a list of existing operator notes by contact

Input Parameters

string
required
Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.
string
required
Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_FACEBOOK_GET_CONTACT_PAUSE_AUTOMATIONReturns the time remaining until autoflows are stopped for this contact

Input Parameters

string
required
Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_FACEBOOK_GET_CONTACTS_BY_TAGReturns a list of contacts by tag for the specified bot

Input Parameters

string
required
created contacts tag to search by
integer
The limit of pagination items, that will be returned
integer
The offset of pagination items, where starts a current items batch
string
required
Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.
string
Continuation cursor returned by a previous call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_FACEBOOK_GET_CONTACTS_BY_VARIABLEReturns a page of Facebook contacts matching a variable value, using a variable identifier or name and optionally a bot. Supports continuation for further results.

Input Parameters

integer
The limit of pagination items, that will be returned
integer
The offset of pagination items, where starts a current items batch
string
Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.
string
Continuation cursor returned by a previous call.
string
Contact’s variable ID
string
ontact variable name to search by
string
required
Contact’s variable value

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_FACEBOOK_GET_FLOWSReturns a list of created flows for the selected bot and information for each: flow id, bot id, status, name, id and name of the trigger that launches it, and creation date

Input Parameters

integer
The limit of pagination items, that will be returned
integer
The offset of pagination items, where starts a current items batch
string
required
Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.
string
Continuation cursor returned by a previous call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_FACEBOOK_GET_TRIGGERSReturns the list of created triggers for the selected bot with information about each of them: trigger ID, bot id, id of the flow that starts on it, name, type, set launch time and creation date

Input Parameters

integer
The limit of pagination items, that will be returned
integer
The offset of pagination items, where starts a current items batch
string
required
Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.
string
Continuation cursor returned by a previous call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_FACEBOOK_LIST_BOT_VARIABLESReturns a list of variables for the selected bot with information about each: variable ID, bot ID, name, affiliation, type, status, and creation date

Input Parameters

integer
The limit of pagination items, that will be returned
integer
The offset of pagination items, where starts a current items batch
string
required
Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.
string
Continuation cursor returned by a previous call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_FACEBOOK_LIST_TAGSReturns the list of created tags for the selected bot with information about each of them: tag ID, name, contact_count and creation date

Input Parameters

integer
The limit of pagination items, that will be returned
integer
The offset of pagination items, where starts a current items batch
string
required
Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.
string
Continuation cursor returned by a previous call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_FACEBOOK_MARK_CONTACT_MESSAGES_AS_READMark all messages from a SendPulse Facebook contact as read.

Input Parameters

string
required
Contact ID whose unread count will be reset.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_FACEBOOK_MARK_CONTACT_UNREADMark the last message from a SendPulse Facebook contact as unread.

Input Parameters

string
required
ID of the Facebook contact whose last message will be marked unread.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_FACEBOOK_OPEN_CONTACT_CHATMark a SendPulse Facebook contact chat as open and increase its queue priority.

Input Parameters

string
required
Contact ID whose chat to open.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_FACEBOOK_RUN_FLOWLaunch a selected SendPulse Facebook flow for a contact with optional one-time data.

Input Parameters

string
required
Flow ID to launch.
string
required
Contact ID for which to launch the flow.
object
One-time custom values available to the selected flow.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_FACEBOOK_RUN_FLOW_BY_TRIGGERLaunch a SendPulse Facebook flow for a contact using a trigger keyword.

Input Parameters

string
required
Contact ID for which to launch the flow.
object
One-time custom values available to the selected flow.
string
required
Keyword of the flow trigger to invoke.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_FACEBOOK_SEND_CAMPAIGNSend immediately or schedule a campaign to subscribers of a SendPulse Facebook bot.

Input Parameters

string
required
Campaign title.
string
required
Bot ID whose subscribers will receive the campaign.
object
Optional subscriber targeting filter.
string
Scheduled date and time in Y-m-d H:i format; omit to send immediately.
array
required
Campaign messages and channel-specific content.
string ("HUMAN_AGENT" | "CUSTOMER_FEEDBACK")
Facebook Messenger policy tag.
string ("REGULAR" | "SILENT_PUSH" | "NO_PUSH")
Facebook notification delivery mode.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_FACEBOOK_SEND_CONTACT_MESSAGESend text, media, or template content to a SendPulse Facebook contact.

Input Parameters

object
required
Message type and content.
string
required
Contact ID that will receive the message.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_FACEBOOK_SEND_TEXT_TO_CONTACTSend a text message to a SendPulse Facebook contact.

Input Parameters

string
required
Text message to send; may include emoji.
string
required
Contact ID that will receive the message.
string ("HUMAN_AGENT" | "CUSTOMER_FEEDBACK")
required
Facebook Messenger policy tag.
string ("MESSAGE_TAG" | "RESPONSE")
required
Facebook message type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_FACEBOOK_SEND_TYPING_INDICATORSend a transient typing indicator to a SendPulse Facebook contact.

Input Parameters

string
required
Contact ID that will receive the typing indicator.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_FACEBOOK_SET_CONTACT_PAUSE_AUTOMATIONPause autoflows for a SendPulse Facebook contact for a specified number of minutes.

Input Parameters

integer
required
Number of minutes to pause autoflows.
string
required
Contact ID whose autoflows should be paused.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_FACEBOOK_SET_CONTACT_TAGAssign one or more tags to a SendPulse Facebook contact.

Input Parameters

array
required
Tags to assign to the contact.
string
required
Contact ID to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_FACEBOOK_SET_CONTACT_VARIABLEAdd or update one or more variables on a SendPulse Facebook contact.

Input Parameters

array
required
Variables identified by name or ID and their new values.
string
required
Contact ID to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_FACEBOOK_UN_ASSIGN_CONTACT_OPERATORSRemove the responsible operator assignment from a SendPulse Facebook contact chat.

Input Parameters

string
required
Contact ID whose operator assignment to remove.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_FACEBOOK_UPDATE_CONTACT_NOTEReplace an existing operator note for a SendPulse Facebook contact.

Input Parameters

string
required
Replacement operator note text.
string
required
Bot ID associated with the contact.
string
required
Note ID to update.
string
required
Contact ID associated with the note.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_FILE_MANAGER_CHECK_FILE_EXISTCheck whether a file exists at a SendPulse File Manager path.

Input Parameters

string
required
Absolute path of the file to check.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_FILE_MANAGER_CREATE_DIRECTORYCreate a directory in SendPulse File Manager.

Input Parameters

string
required
Name of the directory to create.
string
required
Absolute parent path where the directory will be created.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_FILE_MANAGER_FILTER_FILESFilter files in a SendPulse File Manager directory by date range and sort order.

Input Parameters

string
required
Directory path whose files will be filtered.
string ("asc" | "desc")
Sort order for matching files.
string
Inclusive UTC upper bound in Y-m-d H:i format.
string
Inclusive UTC lower bound in Y-m-d H:i format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_FILE_MANAGER_GET_DIRECTORY_CONTENTSGet files and nested folders in a SendPulse File Manager directory.

Input Parameters

string
required
Absolute directory path, such as /images or /uploads/2024.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_GET_ACCOUNT_OVERVIEWReturn the connected SendPulse account identity, balances, enabled product plans, and usage limits.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_GET_AUTOMATION_FLOW_STATSReturn aggregate flow performance and per-element statistics for one Automation 360 flow.

Input Parameters

integer
required
ID of the Automation 360 flow to inspect.
string ("maintrigger" | "email" | "push" | "sms" | "filter" | "action" | "goal" | "trigger" | "viber" | "pause")
Optional Automation 360 element type to include in element statistics.
boolean
Whether element statistics should include deleted flow elements.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_GET_CHATBOT_ACCOUNTReturn the connected SendPulse account’s Chatbots plan, quotas, usage statistics, and connected channel services.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_GET_EMAIL_CAMPAIGNReturn configuration, recipient counts, status, and delivery statistics for one Bulk Email campaign.

Input Parameters

integer
required
ID of the Bulk Email campaign to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_GET_FILE_STORAGE_OVERVIEWReturn the File Manager directory tree, file and directory counts, and raw storage usage and quota values. OpenAPI labels the values as MB, but live values appear byte-based; no conversion is applied.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_GET_MAILING_LIST_VERIFICATIONReturn summary counts and one page of email-level results for a mailing-list verification job. Use next_cursor to continue through additional results.

Input Parameters

integer
Maximum email-level verification results to return in this page.
string
Opaque continuation cursor from a previous response; omit for the first page.
integer
required
ID of the verified mailing list returned by the verification list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_INSTAGRAM_ASSIGN_CONTACT_OPERATORAssign a responsible operator to a SendPulse Instagram chatbot contact’s chat.

Input Parameters

string
required
Contact ID whose chat will be assigned.
integer
required
Operator ID to assign as responsible for the chat.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_INSTAGRAM_CLOSE_CONTACT_CHATClose a SendPulse Instagram contact chat and lower its queue priority.

Input Parameters

string
required
Contact ID whose chat to close.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_INSTAGRAM_CREATE_CONTACT_NOTECreate an internal operator note for a SendPulse Instagram contact.

Input Parameters

string
required
Operator note text, visible only to operators.
string
required
Bot ID associated with the contact.
string
required
Contact ID to annotate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_INSTAGRAM_DELETE_CONTACTPermanently remove a contact and its history from a SendPulse Instagram bot audience.

Input Parameters

string
required
Contact ID to permanently remove.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_INSTAGRAM_DELETE_CONTACT_AUTOMATION_PAUSERemove an automation pause so a SendPulse Instagram contact resumes autoflows.

Input Parameters

string
required
Contact ID whose automation pause to remove.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_INSTAGRAM_DELETE_CONTACT_NOTEPermanently remove an operator note from a SendPulse Instagram contact.

Input Parameters

string
required
Bot ID associated with the contact.
string
required
Note ID to permanently remove.
string
required
Contact ID associated with the note.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_INSTAGRAM_DELETE_CONTACT_TAGRemove a tag from a SendPulse Instagram chatbot contact.

Input Parameters

string
required
Tag to remove from the contact.
string
required
Contact ID whose tag will be removed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_INSTAGRAM_DELETE_CONTACT_VARIABLEDelete a variable value from a SendPulse Instagram chatbot contact.

Input Parameters

string
required
Contact ID whose variable value will be deleted.
string
Variable ID; provide this or variable_name.
string
Variable name; provide this or variable_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_INSTAGRAM_DISABLE_CONTACTDisable an Instagram chatbot contact so campaigns and autoflows are no longer sent.

Input Parameters

string
required
Contact ID to disable.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_INSTAGRAM_ENABLE_CONTACTEnable an Instagram chatbot contact to receive campaigns and autoflows.

Input Parameters

string
required
Contact ID to enable.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_INSTAGRAM_GET_ACCOUNTGet pricing-plan limits and usage for the Instagram chatbot service.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_INSTAGRAM_GET_BOTS_STATISTICSGet aggregate subscriber and outgoing-message statistics for an Instagram bot.

Input Parameters

string
required
Bot ID whose aggregate statistics to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_INSTAGRAM_GET_CHAT_MESSAGESGet one page of messages exchanged with an Instagram chatbot contact.

Input Parameters

integer
Number of messages requested per page.
integer
Zero-based message offset.
string ("asc" | "desc")
Message sort order.
string
Continuation cursor returned by a previous call.
string
required
Contact ID whose message history to retrieve.
string
Message ID after which to search.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_INSTAGRAM_GET_CHATSGet one page of chats for an Instagram bot.

Input Parameters

integer
Number of chats requested per page.
integer
Zero-based chat offset.
string
required
Bot ID whose chats to retrieve.
string
Continuation cursor returned by a previous call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_INSTAGRAM_GET_CONTACTGet an Instagram chatbot contact by contact ID.

Input Parameters

string
required
Contact ID to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_INSTAGRAM_GET_CONTACT_NOTESGet internal operator notes for an Instagram chatbot contact.

Input Parameters

string
required
Bot ID associated with the contact.
string
required
Contact ID whose operator notes to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_INSTAGRAM_GET_CONTACT_PAUSE_AUTOMATIONGet the remaining automation pause for an Instagram chatbot contact.

Input Parameters

string
required
Contact ID whose automation pause to inspect.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_INSTAGRAM_GET_CONTACTS_BY_TAGGet one page of Instagram chatbot contacts matching a tag.

Input Parameters

string
required
Exact contact tag to match.
integer
Number of contacts requested per page.
integer
Zero-based contact offset.
string
required
Bot ID whose contacts to search.
string
Continuation cursor returned by a previous call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_INSTAGRAM_GET_CONTACTS_BY_VARIABLEGet one page of Instagram chatbot contacts matching a variable value.

Input Parameters

integer
Number of contacts requested per page.
integer
Zero-based contact offset.
string
Bot ID required with variable_name.
string
Continuation cursor returned by a previous call.
string
Variable ID to match instead of a variable name and bot ID.
string
Variable name to match when bot_id is also provided.
string
required
Variable value to match.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_INSTAGRAM_GET_FLOWSGet one page of automation flows for an Instagram bot.

Input Parameters

integer
Number of flows requested per page.
integer
Zero-based flow offset.
string
required
Bot ID whose flows to retrieve.
string
Continuation cursor returned by a previous call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_INSTAGRAM_GET_TAGSGet one page of tags for an Instagram bot.

Input Parameters

integer
Number of tags requested per page.
integer
Zero-based tag offset.
string
required
Bot ID whose tags to retrieve.
string
Continuation cursor returned by a previous call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_INSTAGRAM_LIST_BOT_VARIABLESGet one page of variables defined for an Instagram bot.

Input Parameters

integer
Number of variables requested per page.
integer
Zero-based variable offset.
string
required
Bot ID whose variables to retrieve.
string
Continuation cursor returned by a previous call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_INSTAGRAM_LIST_TRIGGERSGet one page of automation triggers for an Instagram bot.

Input Parameters

integer
Number of triggers requested per page.
integer
Zero-based trigger offset.
string
required
Bot ID whose triggers to retrieve.
string
Continuation cursor returned by a previous call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_INSTAGRAM_MARK_CONTACT_MESSAGES_AS_READMark all messages from a SendPulse Instagram contact as read.

Input Parameters

string
required
Contact ID whose unread count will be reset.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_INSTAGRAM_MARK_CONTACT_UNREADMark the last message from a SendPulse Instagram contact as unread.

Input Parameters

string
required
Contact ID whose last message will be marked unread.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_INSTAGRAM_OPEN_CONTACT_CHATIncrease an Instagram chatbot contact’s chat priority by marking it open.

Input Parameters

string
required
Contact ID whose chat will be opened.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_INSTAGRAM_RUN_FLOWLaunch a selected SendPulse Instagram chatbot flow for a contact, optionally with one-time external data.

Input Parameters

string
required
Flow ID to launch.
string
required
Contact ID for which to launch the flow.
object
Optional one-time custom data available to the selected flow.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_INSTAGRAM_RUN_FLOW_BY_TRIGGERLaunch a SendPulse Instagram chatbot flow by trigger keyword for a contact.

Input Parameters

string
required
Contact ID for which to launch the flow.
object
Optional one-time custom data available to the triggered flow.
string
required
Trigger keyword that launches the flow.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_INSTAGRAM_SEND_CAMPAIGNSend immediately or schedule a campaign to active subscribers of a SendPulse Instagram bot.

Input Parameters

string
required
Campaign title.
string
required
Bot ID whose active subscribers will receive the campaign.
object
Optional subscriber targeting filter.
string
Scheduled date and time in Y-m-d H:i format; omit to send immediately.
array
required
Campaign messages and their channel-specific content.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_INSTAGRAM_SEND_MESSAGE_TO_CONTACTSend one or more text, image, file, or structured messages to an Instagram chatbot contact.

Input Parameters

array
required
Messages to send, including each message type and channel-specific content.
string
required
Contact ID that will receive the message.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_INSTAGRAM_SET_CONTACT_TAGAssign one or more tags to a SendPulse Instagram chatbot contact.

Input Parameters

array
required
Tags to assign to the contact.
string
required
Contact ID that will receive the tags.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_INSTAGRAM_SET_CONTACT_VARIABLEAdd or update variable values for a SendPulse Instagram chatbot contact.

Input Parameters

array
required
Variables and values to add or update.
string
required
Contact ID whose variables will be set.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_INSTAGRAM_SET_PAUSE_AUTOMATIONPause autoflows for a SendPulse Instagram chatbot contact for a specified number of minutes.

Input Parameters

integer
required
Number of minutes to pause autoflows.
string
required
Contact ID whose autoflows will be paused.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_INSTAGRAM_UN_ASSIGN_CONTACT_OPERATORSRemove all responsible operators assigned to an Instagram chatbot contact’s chat.

Input Parameters

string
required
Contact ID whose responsible operators will be unassigned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_INSTAGRAM_UPDATE_CONTACT_NOTEUpdate an existing operator note for a SendPulse Instagram chatbot contact.

Input Parameters

string
required
Updated note text.
string
required
Bot ID associated with the contact.
string
required
Note ID to update.
string
required
Contact ID associated with the note.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_LIST_AUTOMATION_FLOWSReturn one page of Automation 360 flows available to the connected account. Use next_cursor to continue through additional pages.

Input Parameters

integer
Maximum automation flows to return in this page.
string
Opaque continuation cursor from a previous response; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_LIST_CAMPAIGNSList email, SMS, or transactional Viber campaigns using channel-specific filters and pagination.

Input Parameters

string ("asc" | "desc")
Email campaign sort direction; omit the default meaning for SMS and Viber.
string ("email" | "sms" | "viber")
SendPulse channel whose campaign history to return; may be omitted when continuing with next_cursor.
string
Optional end date for SMS history in YYYY-MM-DD HH:MM:SS format; omit for email and Viber.
string
Optional start date for SMS history in YYYY-MM-DD HH:MM:SS format; omit for email and Viber.
integer
Maximum email or Viber campaigns to return; ignored for SMS.
string
Opaque continuation cursor from an email or Viber response; omit for SMS or the first page.
array
Email campaign statuses to include; omit for SMS and Viber.
boolean
Set true to return only scheduled email campaigns; omit for SMS and Viber.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_LIST_CHATBOT_BOTSList connected bots across all SendPulse chatbot services or return one page for a selected channel. Channel access tokens are never returned.

Input Parameters

string ("all" | "facebook" | "instagram" | "live_chat" | "telegram" | "tiktok" | "viber" | "whatsapp")
Chatbot channel to inspect. Use all for the complete unified bot list, or select one channel for a paginated channel-specific list.
integer
Maximum bots to return in a channel-specific page; ignored when channel is all.
string
Opaque continuation cursor for a channel-specific listing; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_LIST_CHATBOT_DIALOGSReturn one page of recent dialogs across connected SendPulse chatbot services.

Input Parameters

string ("asc" | "desc")
Order dialogs ascending (asc) or descending (desc).
integer
Maximum dialogs to return in this page.
string
Opaque continuation cursor from a previous response; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_LIST_CRM_PIPELINESReturn CRM pipelines, their stages, and settings for account-state discovery and ID lookup.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_LIST_MAILING_LIST_CONTACTSReturn one page of contacts and custom variables from a Bulk Email mailing list.

Input Parameters

string ("asc" | "desc")
Contact sort direction.
integer
Number of contacts to return; SendPulse returns up to 100 records per page.
boolean
Set true to request active contacts only; omit to include all statuses.
string
Continuation cursor from a previous response; omit for the first page.
boolean
Set true to request inactive contacts only; omit to include all statuses.
integer
ID of the mailing list whose contacts to return; may be omitted when continuing with next_cursor.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_LIST_MAILING_LISTSReturn one page of Bulk Email mailing lists with subscriber counts and status. Use next_cursor to continue through additional pages.

Input Parameters

integer
Number of mailing lists to return; SendPulse allows 1 to 100 records per page.
string
Opaque continuation cursor from a previous response; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_LIST_MAILING_LIST_VERIFICATIONSReturn one page of mailing-list verification jobs with status and result counts. Use next_cursor to continue through additional pages.

Input Parameters

integer
Maximum verification jobs to return in this page.
string
Opaque continuation cursor from a previous response; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_LIST_MESSAGING_SENDERSList configured sender identities for either the SMS or transactional Viber service.

Input Parameters

string ("sms" | "viber")
required
Messaging service whose approved or pending sender identities to return. Choose sms or viber.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_LIVE_CHAT_ASSIGN_CONTACT_OPERATORAssign a responsible operator to a SendPulse Live Chat contact’s chat.

Input Parameters

string
required
Contact ID whose chat will be assigned.
integer
required
Operator ID to assign as responsible for the chat.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_LIVE_CHAT_CLOSE_CONTACT_CHATClose a SendPulse Live Chat contact’s chat and lower its priority.

Input Parameters

string
required
Contact ID whose chat will be closed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_LIVE_CHAT_CREATE_CONTACT_NOTECreate an operator note for a SendPulse Live Chat contact.

Input Parameters

string
required
Operator note text.
string
required
Bot ID associated with the contact.
string
required
Contact ID that will receive the note.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_LIVE_CHAT_DELETE_CONTACTRemove a contact from the SendPulse Live Chat audience and subscribers list.

Input Parameters

string
required
Contact ID to remove from the audience and subscribers list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_LIVE_CHAT_DELETE_CONTACT_NOTEDelete an operator note from a SendPulse Live Chat contact.

Input Parameters

string
required
Bot ID associated with the contact.
string
required
Note ID to delete.
string
required
Contact ID associated with the note.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_LIVE_CHAT_DELETE_CONTACT_TAGRemove a tag from a SendPulse Live Chat contact.

Input Parameters

string
required
Tag to remove from the contact.
string
required
Contact ID whose tag will be removed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_LIVE_CHAT_DELETE_CONTACT_VARIABLEDelete a variable value from a SendPulse Live Chat contact.

Input Parameters

string
required
Contact ID whose variable value will be deleted.
string
Variable ID; provide this or variable_name.
string
Variable name; provide this or variable_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_LIVE_CHAT_DELETE_PAUSE_AUTOMATIONRemove an automation pause and resume autoflows for a SendPulse Live Chat contact.

Input Parameters

string
required
Contact ID whose autoflows will be resumed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_LIVE_CHAT_DISABLE_CONTACTDisable a Live Chat contact so campaigns and autoflows are no longer sent.

Input Parameters

string
required
Contact ID to disable.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_LIVE_CHAT_ENABLE_CONTACTEnable a Live Chat contact to receive campaigns and autoflows.

Input Parameters

string
required
Contact ID to enable.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_LIVE_CHAT_GET_ACCOUNTGet pricing-plan limits and usage for the Live Chat chatbot service.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_LIVE_CHAT_GET_BOT_STATISTICSGet aggregate subscriber and outgoing-message statistics for a Live Chat bot.

Input Parameters

string
required
Bot ID whose aggregate statistics to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_LIVE_CHAT_GET_CHAT_MESSAGESGet one page of messages exchanged with a Live Chat chatbot contact.

Input Parameters

integer
Number of messages requested per page.
integer
Zero-based message offset.
string ("asc" | "desc")
Message sort order.
string
Continuation cursor returned by a previous call.
string
required
Contact ID whose message history to retrieve.
string
Message ID after which to search.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_LIVE_CHAT_GET_CHATSGet one page of chats for a Live Chat bot.

Input Parameters

integer
Number of chats requested per page.
integer
Zero-based chat offset.
string
required
Bot ID whose chats to retrieve.
string
Continuation cursor returned by a previous call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_LIVE_CHAT_GET_CONTACTGet a Live Chat chatbot contact by contact ID.

Input Parameters

string
required
Contact ID to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_LIVE_CHAT_GET_CONTACT_NOTESGet internal operator notes for a Live Chat chatbot contact.

Input Parameters

string
required
Bot ID associated with the contact.
string
required
Contact ID whose operator notes to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_LIVE_CHAT_GET_CONTACT_PAUSE_AUTOMATIONGet the remaining automation pause for a Live Chat chatbot contact.

Input Parameters

string
required
Contact ID whose automation pause to inspect.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_LIVE_CHAT_GET_CONTACTS_BY_TAGGet one page of Live Chat chatbot contacts matching a tag.

Input Parameters

string
required
Exact contact tag to match.
integer
Number of contacts requested per page.
integer
Zero-based contact offset.
string
required
Bot ID whose contacts to search.
string
Continuation cursor returned by a previous call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_LIVE_CHAT_GET_CONTACTS_BY_VARIABLEGet one page of Live Chat chatbot contacts matching a variable value.

Input Parameters

integer
Number of contacts requested per page.
integer
Zero-based contact offset.
string
Bot ID required with variable_name.
string
Continuation cursor returned by a previous call.
string
Variable ID to match instead of a variable name and bot ID.
string
Variable name to match when bot_id is also provided.
string
required
Variable value to match.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_LIVE_CHAT_GET_FLOWSGet one page of automation flows for a Live Chat bot.

Input Parameters

integer
Number of flows requested per page.
integer
Zero-based flow offset.
string
required
Bot ID whose flows to retrieve.
string
Continuation cursor returned by a previous call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_LIVE_CHAT_GET_TRIGGERSGet one page of automation triggers for a Live Chat bot.

Input Parameters

integer
Number of triggers requested per page.
integer
Zero-based trigger offset.
string
required
Bot ID whose triggers to retrieve.
string
Continuation cursor returned by a previous call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_LIVE_CHAT_LIST_BOT_VARIABLESReturns a list of variables for the selected bot with information about each: variable ID, bot ID, name, affiliation, type, status, and creation date

Input Parameters

integer
The limit of pagination items, that will be returned
integer
The offset of pagination items, where starts a current items batch
string
required
Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.
string
Continuation cursor returned by a previous call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_LIVE_CHAT_LIST_TAGSGet one page of tags for a Live Chat bot.

Input Parameters

integer
Number of tags requested per page.
integer
Zero-based tag offset.
string
required
Bot ID whose tags to retrieve.
string
Continuation cursor returned by a previous call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_LIVE_CHAT_MARK_CONTACT_MESSAGES_READMark all messages from a SendPulse Live Chat contact as read.

Input Parameters

string
required
Contact ID whose unread count will be reset.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_LIVE_CHAT_MARK_CONTACT_UNREADMark the last message from a SendPulse Live Chat contact as unread.

Input Parameters

string
required
Contact ID whose last message will be marked unread.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_LIVE_CHAT_OPEN_CONTACT_CHATIncrease a SendPulse Live Chat contact’s chat priority by marking it open.

Input Parameters

string
required
Contact ID whose chat will be opened.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_LIVE_CHAT_RUN_FLOWLaunch a SendPulse Live Chat flow by ID for a contact.

Input Parameters

string
required
Flow ID to launch.
string
required
Contact ID for which to launch the flow.
object
Custom variable values available during this flow run.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_LIVE_CHAT_RUN_FLOW_BY_TRIGGERLaunch a SendPulse Live Chat flow by trigger keyword for a contact.

Input Parameters

string
required
Contact ID for which to launch the flow.
object
Custom variable values available during this flow run.
string
required
Trigger keyword that launches the flow.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_LIVE_CHAT_SEND_CONTACT_MESSAGESend one or more messages to a SendPulse Live Chat contact.

Input Parameters

array
required
Messages and channel-specific content to send.
string
required
Contact ID that will receive the messages.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_LIVE_CHAT_SET_CONTACT_NAMEUpdate the display name of a SendPulse Live Chat contact.

Input Parameters

string
required
New contact display name.
string
required
Contact ID whose display name to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_LIVE_CHAT_SET_CONTACT_TAGAssign one or more tags to a SendPulse Live Chat contact.

Input Parameters

array
required
Tags to assign to the contact.
string
required
Contact ID to tag.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_LIVE_CHAT_SET_CONTACT_VARIABLEAdd or update variable values for a SendPulse Live Chat contact.

Input Parameters

array
required
Variables and values to assign.
string
required
Contact ID whose variables to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_LIVE_CHAT_SET_PAUSE_AUTOMATIONPause autoflows for a SendPulse Live Chat contact for a specified duration.

Input Parameters

integer
required
Number of minutes to pause autoflows.
string
required
Contact ID whose autoflows to pause.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_LIVE_CHAT_UN_ASSIGN_CONTACT_OPERATORSRemove the responsible operator assignment from a SendPulse Live Chat contact.

Input Parameters

string
required
Contact ID whose operator assignment to remove.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_LIVE_CHAT_UPDATE_CONTACT_NOTEReplace the text of an operator note for a SendPulse Live Chat contact.

Input Parameters

string
required
Replacement note text.
string
required
Bot ID associated with the contact.
string
required
Note ID to update.
string
required
Contact ID associated with the note.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_POPUPS_CREATE_WIDGETCreate a SendPulse project that can contain popup widgets.

Input Parameters

string
Absolute project website URL.
string
Project name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_POPUPS_DELETE_POPUPPermanently delete a SendPulse popup and its display rules and statistics.

Input Parameters

string
required
Popup UUID to permanently delete.
boolean
Optional deletion state flag documented by SendPulse.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_POPUPS_GET_NPS_STATISTICS_BY_POPUP_IDGet NPS variant vote totals and button details for a SendPulse popup.

Input Parameters

integer
Optional end date as a Unix timestamp.
integer
Optional start date as a Unix timestamp.
string
required
NPS popup UUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_POPUPS_GET_POPUP_AGGREGATED_NPS_STATISTICSGet aggregated NPS results for a SendPulse popup and optional time range.

Input Parameters

integer
Optional end Unix timestamp.
integer
Optional start Unix timestamp.
string
required
NPS popup UUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_POPUPS_GET_POPUP_CONDITIONSGet all available targeting and display conditions for SendPulse popups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_POPUPS_GET_POPUP_STATISTICSGet engagement statistics for a SendPulse popup and optional time range.

Input Parameters

integer
Optional end Unix timestamp.
integer
Optional start Unix timestamp.
string
required
Popup UUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_POPUPS_GET_PROJECT_WIDGET_STATISTICSGet aggregate engagement statistics for all popups in a SendPulse project.

Input Parameters

integer
Optional end Unix timestamp.
integer
Optional start Unix timestamp.
string
required
Popup project UUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_POPUPS_GET_SUBSCRIBER_BY_IDGet detailed information about a SendPulse popup subscriber.

Input Parameters

integer
required
Subscriber ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_POPUPS_GET_SUBSCRIBERS_BY_POPUPGet subscribers acquired through a specific SendPulse popup.

Input Parameters

string
required
Popup UUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_POPUPS_GET_TARIFF_LIMITSGet the authenticated account’s SendPulse popup plan limits.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_POPUPS_LIST_POPUPS_BY_PROJECT_IDGet one page of popups associated with a SendPulse popup project.

Input Parameters

integer
Maximum popups to return on this page.
string
required
Popup project UUID.
string
Opaque cursor from the previous page; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_POPUPS_LIST_QUIZ_POPUPS_BY_PROJECTGet one page of quiz popups associated with a SendPulse popup project.

Input Parameters

integer
Maximum quiz popups to return on this page.
string
required
Popup project UUID.
string
Opaque cursor from the previous page; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_POPUPS_LIST_SUBSCRIBERS_BY_PROJECTList subscribers associated with a SendPulse popup project.

Input Parameters

string
required
Popup project UUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_POPUPS_LIST_WIDGETSGet one page of SendPulse popup projects.

Input Parameters

integer
Maximum projects to return on this page.
string
Opaque cursor from the previous page; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_POPUPS_SET_POPUP_STATEEnable or disable a SendPulse popup on its website.

Input Parameters

string
required
Popup UUID.
boolean
True to enable the popup or false to disable it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_REMOVE_MAILING_LIST_CONTACTSRemove a batch of email addresses from one Bulk Email mailing list without globally blacklisting them.

Input Parameters

array
required
Email addresses to remove from this mailing list; SendPulse allows at most 100 per request.
integer
required
ID of the mailing list from which to remove contacts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_SEARCH_FILESSearch recursively for File Manager files by keyword within a directory path.

Input Parameters

string
required
Keyword to match against File Manager files.
string
Directory path from which to search recursively.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_SMS_ADD_SMS_BLACKLISTGlobally suppress phone numbers from future SendPulse SMS messages.

Input Parameters

array
required
Phone numbers to suppress globally from SMS sending.
string
required
Reason for blacklisting the phone numbers.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_SMS_ADD_SMS_NUMBERSAdd phone numbers to a mailing list using the official SendPulse sms API.

Input Parameters

array
required
Phones.
integer
required
Mailing list ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_SMS_ADD_SMS_NUMBERS_WITH_VARIABLESAdd phone numbers with complex variables using the official SendPulse sms API.

Input Parameters

object
required
Phones.
integer
required
Mailing list ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_SMS_CALCULATE_SMS_COSTEstimate the SendPulse price and currency for an SMS campaign without sending it.

Input Parameters

string
required
SMS message text to price.
string
Optional route configuration serialized as a JSON object.
array
Phone numbers to price instead of a mailing list.
string
required
SMS sender name used for the estimate.
integer
Mailing-list ID whose phone numbers should be priced.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_SMS_CANCEL_SMS_CAMPAIGNCancel a campaign before sending has started using the official SendPulse sms API.

Input Parameters

integer
required
Id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_SMS_CREATE_SMS_CAMPAIGNCreate a campaign for a mailing list using the official SendPulse sms API.

Input Parameters

string
required
Body.
string
Date.
object
e.g. {‘UA’:‘national’}
string
required
Sender.
boolean
Emulate.
integer
required
Mailing list ID.
boolean
Use dynamic list.
Stat link tracking.
Stat link need protocol.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_SMS_DELETE_SMS_CAMPAIGNPermanently delete an SMS campaign that has not started.

Input Parameters

integer
required
SMS campaign ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_SMS_GET_SMS_BLACKLISTGet the SendPulse SMS phone-number suppression list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_SMS_GET_SMS_CAMPAIGN_INFOGet SendPulse delivery and spend information for an SMS campaign.

Input Parameters

integer
required
SMS campaign ID to inspect.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_SMS_GET_SMS_NUMBER_INFOGet profile and variable information for a phone number in a SendPulse mailing list.

Input Parameters

string
required
Phone number whose mailing-list profile to retrieve.
integer
required
Mailing-list ID containing the phone number.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_SMS_REMOVE_SMS_BLACKLISTRemove phone numbers from the account-wide SMS blacklist.

Input Parameters

array
required
Phone numbers to remove from the SMS blacklist.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_SMS_REMOVE_SMS_NUMBERSRemove phone numbers from one mailing list without globally blacklisting them.

Input Parameters

array
required
Phone numbers to remove from the mailing list.
integer
required
Mailing list ID from which to remove the numbers.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_SMS_SEND_SMS_TO_NUMBERSCreate a campaign for a list of phone numbers using the official SendPulse sms API.

Input Parameters

string
required
Body.
string
Date.
object
Route.
array
required
Phones.
string
required
Sender.
boolean
Emulate.
Stat link tracking.
Stat link need protocol.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_SMS_UPDATE_SMS_VARIABLES_BATCHUpdate variables for multiple phone numbers using the official SendPulse sms API.

Input Parameters

array
required
Phones.
array
required
Variables.
integer
required
Mailing list ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_SMS_UPDATE_SMS_VARIABLES_SINGLEChange custom variables for one SMS contact in a SendPulse address book.

Input Parameters

integer
required
Address book ID.
string
required
Phone number of the contact to update. Common formatting is removed before sending.
array
required
Variables and values to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_SMTP_ADD_SMTP_DOMAINAdd a domain using the official SendPulse smtp API.

Input Parameters

string
required
Domain.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_SMTP_GET_SMTP_ALLOWED_DOMAINSList SMTP sender domains and their SPF, DKIM, and DMARC validation status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_SMTP_GET_SMTP_BOUNCES_DAYGet one page of SendPulse SMTP bounce records for a 24-hour period.

Input Parameters

string
UTC report date in YYYY-MM-DD format.
integer
Number of bounce records requested per page.
string
Continuation cursor returned by a previous call.
integer
Zero-based bounce record offset.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_SMTP_GET_SMTP_BOUNCES_TOTALGet the total SendPulse SMTP bounce count for the last 24-hour period.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_SMTP_GET_SMTP_EMAIL_INFOGet delivery, SMTP response, and tracking details for a SendPulse SMTP email.

Input Parameters

string
required
SMTP email ID to inspect.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_SMTP_GET_SMTP_EMAILSGet one page of historical SendPulse SMTP delivery records.

Input Parameters

string
End date in YYYY-MM-DD format.
integer
Number of SMTP email records requested per page.
string
Offset cursor returned by a previous call.
integer
Zero-based SMTP email record offset.
string
Sender email address filter.
string
Recipient country filter.
string
Start date in YYYY-MM-DD format.
string
Recipient email address filter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_SMTP_GET_SMTP_EMAILS_BATCH_INFOGet information for a list of emails using the official SendPulse smtp API.

Input Parameters

array
required
Emails.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_SMTP_GET_SMTP_EMAILS_TOTALGet the cumulative count of emails sent through SendPulse SMTP.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_SMTP_GET_SMTP_IPSList outbound IP addresses used by the SendPulse SMTP relay.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_SMTP_GET_SMTP_SENDERSList verified email addresses authorized to send through SendPulse SMTP.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_SMTP_GET_SMTP_UNSUBSCRIBEDGet one page of email addresses suppressed from SendPulse SMTP delivery.

Input Parameters

string
Unsubscribe date filter in YYYY-MM-DD format.
integer
Number of unsubscribe records requested per page.
string
Offset cursor returned by a previous call.
integer
Zero-based unsubscribe record offset.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_SMTP_REMOVE_SMTP_UNSUBSCRIBERemove explicitly re-consented email addresses from the SMTP unsubscribe list.

Input Parameters

array
required
Email addresses to remove from the SMTP unsubscribe list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_SMTP_RESUBSCRIBE_SMTP_RECIPIENTResubscribe a recipient using the official SendPulse smtp API.

Input Parameters

string ("ru" | "en" | "ua" | "tr" | "es" | "pt")
Lang.
string
required
Email.
string
required
Sender.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_SMTP_SEARCH_SMTP_UNSUBSCRIBECheck whether an email address is suppressed from SendPulse SMTP sending.

Input Parameters

string
required
Email address whose SMTP suppression status to check.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_SMTP_SEND_SMTP_EMAILSend an email using the SendPulse SMTP API. The request requires a template or both HTML and text content; when both HTML and text are supplied, a template cannot also be supplied.

Input Parameters

object
required
Email.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_SMTP_UNSUBSCRIBE_SMTP_RECIPIENTSUnsubscribe a recipient using the official SendPulse smtp API.

Input Parameters

array
required
Recipients to unsubscribe.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_TELEGRAM_ASSIGN_CONTACT_OPERATORAssign an operator as responsible for a SendPulse Telegram contact chat.

Input Parameters

string
required
Contact ID whose chat should be assigned.
integer
required
Operator ID to assign as responsible for the chat.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_TELEGRAM_CLOSE_CONTACT_CHATClose a SendPulse Telegram contact chat and lower its priority.

Input Parameters

string
required
Contact ID whose chat should be closed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_TELEGRAM_CREATE_CONTACT_NOTECreate an internal operator note for a SendPulse Telegram contact.

Input Parameters

string
required
Operator note text.
string
required
Bot ID associated with the contact.
string
required
Contact ID to annotate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_TELEGRAM_DELETE_CONTACTRemove a SendPulse Telegram contact from the audience and subscriber list.

Input Parameters

string
required
Contact ID to remove from the audience and subscriber list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_TELEGRAM_DELETE_CONTACT_NOTEDelete an operator note from a SendPulse Telegram contact.

Input Parameters

string
required
Bot ID associated with the contact.
string
required
Note ID to delete.
string
required
Contact ID associated with the note.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_TELEGRAM_DELETE_CONTACT_PAUSE_AUTOMATIONResume paused autoflows for a SendPulse Telegram contact.

Input Parameters

string
required
Contact ID whose autoflows should resume.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_TELEGRAM_DELETE_CONTACT_TAGRemove a tag from a SendPulse Telegram contact.

Input Parameters

string
required
Tag to remove from the contact.
string
required
Contact ID to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_TELEGRAM_DELETE_CONTACT_VARIABLEDelete a variable value from a SendPulse Telegram contact by variable ID or name.

Input Parameters

string
required
Contact ID to update.
string
ID of the variable to delete.
string
Name of the variable to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_TELEGRAM_DISABLE_CONTACTDisable a SendPulse Telegram contact so campaigns and autoflows are no longer sent.

Input Parameters

string
required
Contact ID to disable.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_TELEGRAM_ENABLE_CONTACTEnable a SendPulse Telegram contact to receive campaigns and autoflows.

Input Parameters

string
required
Contact ID to enable.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_TELEGRAM_GET_ACCOUNTReturns information about the current Telegram account pricing plan and usage, including message, bot, contact, tag, and variable limits or statistics.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_TELEGRAM_GET_BOT_STATISTICSReturns general statistics info by bot

Input Parameters

string
required
The bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_TELEGRAM_GET_BOT_VARIABLESReturns a list of variables for the selected bot with information about each: variable ID, bot ID, name, affiliation, type, status, and creation date

Input Parameters

integer
Maximum items to return on this page.
string
required
Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.
string
Opaque cursor returned by the previous page; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_TELEGRAM_GET_CHAT_MESSAGESReturns a page of messages in correspondence with the specified subscriber, with a continuation cursor for further pages.

Input Parameters

integer
The limit of pagination items, that will be returned
integer
The offset of pagination items, where starts a current items batch
string ("asc" | "desc")
Sort order ASC or DESC
string
Continuation cursor returned by a previous call.
string
required
Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.
string
The id of element after which elements will be searched

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_TELEGRAM_GET_CONTACTReturns information on the selected contact: bot and contact ID, information from messenger, list of tags and variables, activity data and date added

Input Parameters

string
required
Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_TELEGRAM_GET_CONTACT_BY_TELEGRAM_IDReturns a bot contact by Telegram ID.

Input Parameters

string
required
Bot identifier
integer
required
Telegram ID of the user or chat
string
Telegram business connection identifier (optional)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_TELEGRAM_GET_CONTACT_NOTESReturns a list of existing operator notes by contact

Input Parameters

string
required
Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.
string
required
Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_TELEGRAM_GET_CONTACT_PAUSE_AUTOMATIONReturns the time remaining until autoflows are stopped for this contact

Input Parameters

string
required
Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_TELEGRAM_GET_CONTACTS_BY_TAGReturns a list of contacts by tag for the specified bot

Input Parameters

string
required
Created contacts tag to search by
integer
The limit of pagination items, that will be returned
integer
The offset of pagination items, where starts a current items batch
string
required
Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.
string
Continuation cursor returned by a previous call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_TELEGRAM_GET_CONTACTS_BY_VARIABLEReturns contacts matching a variable value, identified by variable ID or by variable name and bot ID.

Input Parameters

integer
The limit of pagination items, that will be returned
integer
The offset of pagination items, where starts a current items batch
string
Bot ID; required parameter and passed with the variable_name parameter, if you do not pass variable_id. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.
string
Continuation cursor returned by a previous call.
string
Contacts variable ID to search by; required parameter if you do not pass variable_name and bot_id.
string
Contacts variable name to search by; required parameter and passed with the bot_id parameter, if you do not pass variable_id.
string
required
Contact’s variable value

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_TELEGRAM_GET_FLOWSReturns a list of created flows for the selected bot and information for each: flow id, bot id, status, name, id and name of the trigger that launches it, and creation date

Input Parameters

integer
The limit of pagination items, that will be returned
integer
The offset of pagination items, where starts a current items batch
string
required
Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.
string
Continuation cursor returned by a previous call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_TELEGRAM_GET_TAGSReturns the list of created tags for the selected bot with information about each of them: tag ID, name, contact_count and creation date

Input Parameters

integer
Maximum items to return on this page.
string
required
Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.
string
Opaque cursor returned by the previous page; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_TELEGRAM_GET_TRIGGERSReturns the list of created triggers for the selected bot with information about each of them: trigger ID, bot id, id of the flow that starts on it, name, type, set launch time and creation date

Input Parameters

integer
Maximum items to return on this page.
string
required
Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.
string
Opaque cursor returned by the previous page; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_TELEGRAM_LIST_CHATSReturns a list of chats with subscribers with information about the contact and the last message received from the contact

Input Parameters

integer
Provider size query parameter.
integer
Provider skip query parameter.
string
required
Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.
string
Continuation cursor returned by a previous call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_TELEGRAM_MARK_CONTACT_MESSAGES_AS_READMark all messages from a SendPulse Telegram contact as read.

Input Parameters

string
required
ID of the Telegram contact whose unread message count will be reset.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_TELEGRAM_MARK_CONTACT_UNREADMark the last message from a SendPulse Telegram contact as unread.

Input Parameters

string
required
ID of the Telegram contact whose last message will be marked unread.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_TELEGRAM_OPEN_CONTACT_CHATOpen a SendPulse Telegram contact chat and increase its priority.

Input Parameters

string
required
Contact ID whose chat should be opened.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_TELEGRAM_PAUSE_CONTACT_AUTOFLOWSPause autoflows for a SendPulse Telegram contact for a specified number of minutes.

Input Parameters

integer
required
Number of minutes to pause autoflows.
string
required
Contact ID whose autoflows should be paused.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_TELEGRAM_REACT_TO_MESSAGESend an emoji reaction to a specific message from a SendPulse Telegram contact.

Input Parameters

object
required
Reaction details.
string
required
Contact ID that owns the message.
string
required
Message ID to react to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_TELEGRAM_RUN_FLOWLaunch a Telegram chatbot flow by ID for a contact.

Input Parameters

string
required
ID of the flow to launch.
string
required
Contact ID for which to launch the flow.
object
One-time custom values available to the launched flow.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_TELEGRAM_RUN_FLOW_BY_TRIGGERLaunch a Telegram chatbot flow by trigger keyword for a contact.

Input Parameters

string
required
Contact ID for which to launch the flow.
object
One-time custom values available to the launched flow.
string
required
Keyword configured to launch the flow.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_TELEGRAM_SEND_CAMPAIGNSend immediately or schedule a campaign to subscribers of a SendPulse Telegram bot.

Input Parameters

string
required
Campaign title.
string
required
Bot ID whose subscribers will receive the campaign.
string
Scheduled date and time in Y-m-d H:i format; omit to send now.
array
required
Campaign messages to send.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_TELEGRAM_SEND_CONTACT_MESSAGESend text, media, a carousel, or an action message to a SendPulse Telegram contact.

Input Parameters

object
required
Message type and content to send.
string
required
Contact ID to message.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_TELEGRAM_SEND_TEXT_TO_CONTACTSend a text message to a specified SendPulse Telegram contact.

Input Parameters

string
required
Text message content, up to 1024 Unicode characters.
string
required
Contact ID to message.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_TELEGRAM_SET_CONTACT_TAGAssign one or more tags to a SendPulse Telegram contact.

Input Parameters

array
required
Tags to assign to the contact.
string
required
Contact ID to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_TELEGRAM_SET_CONTACT_VARIABLEAdd or update one or more variables on a SendPulse Telegram contact.

Input Parameters

array
required
Variables identified by name or ID and their new values.
string
required
Contact ID to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_TELEGRAM_UN_ASSIGN_CONTACT_OPERATORRemove the assigned responsible operator from a SendPulse Telegram contact chat.

Input Parameters

string
required
Contact ID whose responsible operator should be removed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_TELEGRAM_UPDATE_CONTACT_NOTEUpdate an existing internal operator note for a Telegram contact.

Input Parameters

string
required
Operator note text.
string
required
Bot ID associated with the contact.
string
required
ID of the operator note to update.
string
required
Contact ID associated with the note.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_TIKTOK_ASSIGN_CONTACT_OPERATORAssign an operator to a TikTok contact chat.

Input Parameters

string
required
Contact ID whose chat to assign.
integer
required
ID of the operator to assign.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_TIKTOK_CLOSE_CONTACT_CHATClose a TikTok contact chat and lower its queue priority.

Input Parameters

string
required
Contact ID to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_TIKTOK_CREATE_CONTACT_NOTECreate an internal operator note for a TikTok contact.

Input Parameters

string
required
Operator note text.
string
required
Bot ID associated with the contact.
string
required
Contact ID to annotate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_TIKTOK_DELETE_CONTACTPermanently remove a contact from a TikTok bot audience.

Input Parameters

string
required
Contact ID to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_TIKTOK_DELETE_CONTACT_NOTEPermanently delete an internal operator note for a TikTok contact.

Input Parameters

string
required
Bot ID associated with the contact.
string
required
ID of the operator note to delete.
string
required
Contact ID associated with the note.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_TIKTOK_DELETE_CONTACT_PAUSE_AUTOMATIONRemove an automation pause from a TikTok contact.

Input Parameters

string
required
Contact ID to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_TIKTOK_DELETE_CONTACT_TAGRemove a tag from a TikTok contact.

Input Parameters

string
required
Tag to remove from the contact.
string
required
Contact ID from which to remove the tag.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_TIKTOK_DELETE_CONTACT_VARIABLEPermanently delete one variable value from a TikTok contact.

Input Parameters

string
required
Contact ID whose variable value to delete.
string
ID of the variable whose value to delete.
string
Name of the variable whose value to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_TIKTOK_DISABLE_CONTACTDisable a TikTok contact without deleting its data.

Input Parameters

string
required
Contact ID to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_TIKTOK_ENABLE_CONTACTRe-enable a TikTok contact for campaigns and autoflows.

Input Parameters

string
required
Contact ID to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_TIKTOK_GET_ACCOUNTReturns information about your current account pricing plan, the number of messages in your plan, bots, contacts, list of tags, and variables

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_TIKTOK_GET_BOT_STATISTICSReturns general statistics info by bot

Input Parameters

string
required
The bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_TIKTOK_GET_CHAT_LISTReturns a list of chats with subscribers with information about the contact and the last message received from the contact

Input Parameters

integer
Maximum items to return on this page.
string
required
Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.
string
Opaque cursor returned by the previous page; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_TIKTOK_GET_CHAT_MESSAGESReturns a page of messages in correspondence with the specified TikTok subscriber. Use the returned cursor to retrieve further pages.

Input Parameters

integer
Maximum items to return on this page.
string ("asc" | "desc")
Sort order ASC or DESC
string
required
Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.
string
Opaque cursor returned by the previous page; omit for the first page.
string
The id of element after which elements will be searched

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_TIKTOK_GET_CONTACTReturns information on the selected contact: bot and contact ID, information from messenger, list of tags and variables, activity data and date added

Input Parameters

string
required
Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_TIKTOK_GET_CONTACT_NOTESReturns a list of existing operator notes by contact

Input Parameters

string
required
Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.
string
required
Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_TIKTOK_GET_CONTACT_PAUSE_AUTOMATIONReturns the time remaining until autoflows are stopped for this contact

Input Parameters

string
required
Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_TIKTOK_GET_CONTACTS_BY_TAGReturns a list of contacts by tag for the specified bot

Input Parameters

string
required
Created contact’s tag to search by
integer
Maximum items to return on this page.
string
required
Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.
string
Opaque cursor returned by the previous page; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_TIKTOK_GET_CONTACTS_BY_VARIABLEReturns TikTok contacts matching a variable value, using a variable ID or a variable name and bot ID.

Input Parameters

integer
Maximum items to return on this page.
string
Bot ID; required parameter and passed with the variable_name parameter, if you do not pass variable_id. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.
string
Opaque cursor returned by the previous page; omit for the first page.
string
Contact’s variable ID to search by; required parameter if you do not pass variable_name and bot_id.
string
Contact’s variable name to search by; required parameter and passed with the bot_id parameter, if you do not pass variable_id.
string
required
Contact’s variable value

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_TIKTOK_GET_FLOWSReturns a list of created flows for the selected bot and information for each: flow id, bot id, status, name, id and name of the trigger that launches it, and creation date

Input Parameters

integer
Maximum items to return on this page.
string
required
Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.
string
Opaque cursor returned by the previous page; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_TIKTOK_GET_TAG_LISTReturn a page of created tags for a selected TikTok bot, including tag ID, name, contact count and creation date. Use the returned cursor to retrieve subsequent pages.

Input Parameters

integer
Maximum items to return on this page.
string
required
Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.
string
Opaque cursor returned by the previous page; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_TIKTOK_GET_TRIGGERSReturn a page of triggers for a selected TikTok bot, including their IDs, associated flow, name, type, launch timing and creation date. Use the returned cursor to retrieve subsequent pages.

Input Parameters

integer
Maximum items to return on this page.
string
required
Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.
string
Opaque cursor returned by the previous page; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_TIKTOK_LIST_VARIABLESReturn a page of variables for a selected TikTok bot, including variable ID, bot ID, name, affiliation, type, status and creation date. Use the returned cursor to retrieve subsequent pages.

Input Parameters

integer
Maximum items to return on this page.
string
required
Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.
string
Opaque cursor returned by the previous page; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_TIKTOK_MARK_CONTACT_CHAT_UNREADMark the last message from a SendPulse TikTok contact as unread.

Input Parameters

string
required
ID of the TikTok contact whose last message will be marked unread.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_TIKTOK_MARK_CONTACT_MESSAGES_AS_READMark all messages from a SendPulse TikTok contact as read.

Input Parameters

string
required
ID of the TikTok contact whose unread message count will be reset.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_TIKTOK_OPEN_CONTACT_CHATOpen a TikTok contact chat and increase its queue priority.

Input Parameters

string
required
Contact ID to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_TIKTOK_RUN_FLOWLaunch a TikTok chatbot flow by ID for a contact.

Input Parameters

string
required
ID of the flow to launch.
string
required
Contact ID for which to launch the flow.
object
One-time custom values available to the launched flow.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_TIKTOK_RUN_FLOW_BY_TRIGGERLaunch a TikTok chatbot flow by trigger keyword for a contact.

Input Parameters

string
required
Contact ID for which to launch the flow.
object
One-time custom values available to the launched flow.
string
required
Keyword configured to launch the flow.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_TIKTOK_SEND_CAMPAIGNSend immediately or schedule a campaign to a TikTok bot audience.

Input Parameters

string
required
Campaign title.
string
required
Bot ID whose subscribers will receive the campaign.
object
Optional subscriber targeting filter.
string
Scheduled date and time in Y-m-d H:i format; omit to send immediately.
array
required
Campaign messages with channel-specific type and content objects.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_TIKTOK_SEND_CONTACT_MESSAGESend one or more messages directly to a TikTok contact.

Input Parameters

array
required
Messages to send, with channel-specific type and content objects.
string
required
Contact ID that will receive the message.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_TIKTOK_SET_CONTACT_TAGAssign one or more tags to a TikTok contact.

Input Parameters

array
required
Tags to assign to the contact.
string
required
Contact ID to tag.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_TIKTOK_SET_CONTACT_VARIABLEAssign or update variable values for a TikTok contact.

Input Parameters

array
required
Variables to assign by name or ID.
string
required
Contact ID whose variables to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_TIKTOK_SET_PAUSE_AUTOMATIONPause all autoflows for a TikTok contact for a specified duration.

Input Parameters

integer
required
Number of minutes to pause autoflows.
string
required
Contact ID whose autoflows to pause.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_TIKTOK_UNASSIGN_CONTACT_OPERATORRemove the assigned operator from a TikTok contact chat.

Input Parameters

string
required
Contact ID to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_TIKTOK_UPDATE_CONTACT_NOTEUpdate an existing internal operator note for a TikTok contact.

Input Parameters

string
required
Operator note text.
string
required
Bot ID associated with the contact.
string
required
ID of the operator note to update.
string
required
Contact ID associated with the note.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_UPDATE_MAILING_LISTRename an existing Bulk Email mailing list.

Input Parameters

string
required
New mailing list name.
integer
required
ID of the mailing list to rename.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_UPLOAD_FILEUpload one file to an existing File Manager directory and return the provider-reported absolute path when available.

Input Parameters

object
required
File to upload.
integer
Optional output width used only for supported video uploads.
integer
Optional output height used only for supported video uploads.
string
required
Absolute path of the existing File Manager destination directory.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_VERIFIER_CREATE_VERIFICATION_REPORTStart generating a downloadable SendPulse mailing-list verification report.

Input Parameters

integer
required
Verified mailing list ID.
string
Language code for report headers.
integer ("2" | "3" | "4")
Report format: 2 for CSV, 3 for XLS, or 4 for XLSX.
array
Status codes to include: 0 unverified, 1 valid, 2 unconfirmed, 3 invalid.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_VERIFIER_DOWNLOAD_VERIFICATION_REPORTDownload a generated SendPulse verification report; SendPulse deletes its server copy after download.

Input Parameters

integer
required
Verified mailing list ID.
integer
Report format code used during creation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_VERIFIER_GET_SINGLE_VERIFICATION_RESULTGet SendPulse verification results for one email address.

Input Parameters

string
required
Email address whose verification result to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_VERIFIER_GET_VERIFICATION_PROGRESSGet the current progress of a SendPulse mailing-list verification.

Input Parameters

integer
required
Mailing list ID being verified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_VERIFIER_VERIFY_MAILING_LISTStart verification of a SendPulse mailing list.

Input Parameters

integer
required
Mailing list ID to verify.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_VERIFIER_VERIFY_SINGLE_EMAILStart a SendPulse verification for one email address.

Input Parameters

string
required
Email address to verify.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_VERIFIER_VIEW_VERIFICATION_REPORTView metadata and a sample from a generated SendPulse verification report.

Input Parameters

integer
required
Verified mailing list ID.
integer
Report format code used during creation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_VIBER_ADD_VIBER_BLACKLISTAdd phone number to the blacklist using the official SendPulse viber API.

Input Parameters

array
required
Phones.
string
Description.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_VIBER_CHATBOT_ASSIGN_CONTACT_OPERATORAssign an operator as responsible for a SendPulse Viber chatbot contact’s chat.

Input Parameters

string
required
Contact ID whose chat should be assigned.
integer
required
Operator ID to assign to the chat.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_VIBER_CHATBOT_CLOSE_CONTACT_CHATClose a Viber contact chat and lower its queue priority.

Input Parameters

string
required
Contact ID to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_VIBER_CHATBOT_CREATE_CONTACT_NOTECreate an internal operator note for a SendPulse Viber chatbot contact.

Input Parameters

string
required
Operator note text.
string
required
Bot ID associated with the contact.
string
required
Contact ID to annotate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_VIBER_CHATBOT_DELETE_CONTACTPermanently remove a contact from a SendPulse Viber chatbot audience.

Input Parameters

string
required
Contact ID to permanently remove.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_VIBER_CHATBOT_DELETE_CONTACT_AUTOMATION_PAUSERemove an automation pause and resume automated flows for a SendPulse Viber chatbot contact.

Input Parameters

string
required
Contact ID whose automated flows should resume.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_VIBER_CHATBOT_DELETE_CONTACT_NOTEPermanently remove an operator note from a SendPulse Viber chatbot contact.

Input Parameters

string
required
Bot ID associated with the contact.
string
required
Note ID to permanently remove.
string
required
Contact ID associated with the note.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_VIBER_CHATBOT_DELETE_CONTACT_TAGRemove a tag from a SendPulse Viber chatbot contact.

Input Parameters

string
required
Tag to remove from the contact.
string
required
Contact ID whose tag should be removed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_VIBER_CHATBOT_DELETE_CONTACT_VARIABLEDelete one variable from a SendPulse Viber chatbot contact.

Input Parameters

string
required
Contact ID whose variable should be deleted.
string
Variable ID; provide this or variable_name.
string
Variable name; provide this or variable_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_VIBER_CHATBOT_DISABLE_CONTACTDisable a SendPulse Viber chatbot contact so the contact can no longer interact with the bot.

Input Parameters

string
required
Contact ID to disable.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_VIBER_CHATBOT_ENABLE_CONTACTEnable a previously disabled SendPulse Viber chatbot contact.

Input Parameters

string
required
Contact ID to enable.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_VIBER_CHATBOT_GET_ACCOUNTReturns Viber chatbot account pricing plan limits and usage statistics for messages, bots, contacts, and variables, including the plan’s tag limit.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_VIBER_CHATBOT_GET_BOT_STATISTICSReturns general statistics info by bot

Input Parameters

string
required
The bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_VIBER_CHATBOT_GET_CHAT_MESSAGESReturns a page of messages in correspondence with the specified Viber chatbot subscriber, with pagination and optional ordering.

Input Parameters

integer
Maximum items to return on this page.
string ("asc" | "desc")
Sort order ASC or DESC
string
required
Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.
string
Opaque cursor returned by the previous page; omit for the first page.
string
The id of element after which elements will be searched

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_VIBER_CHATBOT_GET_CHATSReturns a list of chats with subscribers with information about the contact and the last message received from the contact

Input Parameters

integer
Maximum items to return on this page.
string
required
Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.
string
Opaque cursor returned by the previous page; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_VIBER_CHATBOT_GET_CONTACTReturns information on the selected contact: bot and contact ID, information from messenger, list of tags and variables, activity data and date added

Input Parameters

string
required
Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_VIBER_CHATBOT_GET_CONTACT_NOTESReturns a list of existing operator notes by contact

Input Parameters

string
required
Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.
string
required
Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_VIBER_CHATBOT_GET_CONTACT_PAUSE_AUTOMATIONReturns the time remaining until autoflows are stopped for this contact

Input Parameters

string
required
Contact ID. Can be obtained with a contact search by tag or variable. You can also find it in your account in the address bar of a chat window with the desired contact.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_VIBER_CHATBOT_GET_CONTACTS_BY_TAGReturns a list of contacts by tag for the specified bot

Input Parameters

string
required
Created contact’s tag to search by
integer
Maximum items to return on this page.
string
required
Bot ID. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.
string
Opaque cursor returned by the previous page; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_VIBER_CHATBOT_GET_CONTACTS_BY_VARIABLEReturns a page of contacts matching a variable value, using either a variable identifier or a variable name and bot ID.

Input Parameters

integer
Maximum items to return on this page.
string
Bot ID; required parameter and passed with the variable_name parameter, if you do not pass variable_id. Can be obtained with a method of getting a list of bots. You can also find it in your account in the address bar of a chat window with the desired contact.
string
Opaque cursor returned by the previous page; omit for the first page.
string
Contact’s variable ID to search by; required parameter if you do not pass variable_name and bot_id.
string
Contact’s variable name to search by; required parameter and passed with the bot_id parameter, if you do not pass variable_id.
string
required
Contact’s variable value

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_VIBER_CHATBOT_GET_FLOWSRequests flows configured for a SendPulse Viber chatbot bot; the declared response contains a single flow object.

Input Parameters

integer
Maximum flows to return.
integer
Number of flows to skip.
string
required
Bot ID whose flows to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_VIBER_CHATBOT_GET_TAGSReturn one page of tags configured for a SendPulse Viber chatbot bot.

Input Parameters

integer
Maximum tags to return.
integer
Number of tags to skip.
string
required
Bot ID whose tags to return.
string
Continuation cursor from a previous response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_VIBER_CHATBOT_LIST_BOT_VARIABLESReturn one page of variables configured for a SendPulse Viber chatbot bot.

Input Parameters

integer
Maximum variables to return.
integer
Number of variables to skip.
string
required
Bot ID whose variables to return.
string
Continuation cursor from a previous response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_VIBER_CHATBOT_LIST_TRIGGERSReturn one page of triggers configured for a SendPulse Viber chatbot bot.

Input Parameters

integer
Maximum triggers to return.
integer
Number of triggers to skip.
string
required
Bot ID whose triggers to return.
string
Continuation cursor from a previous response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_VIBER_CHATBOT_MARK_CONTACT_MESSAGES_READMark all messages from a SendPulse Viber chatbot contact as read.

Input Parameters

string
required
ID of the Viber chatbot contact whose unread message count will be reset.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_VIBER_CHATBOT_MARK_CONTACT_UNREADMark the last message from a SendPulse Viber chatbot contact as unread.

Input Parameters

string
required
ID of the Viber chatbot contact whose last message will be marked unread.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_VIBER_CHATBOT_OPEN_CONTACT_CHATOpen a SendPulse Viber chatbot contact chat and raise its queue priority.

Input Parameters

string
required
Contact ID whose chat should be opened.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_VIBER_CHATBOT_RUN_FLOWRun a specific SendPulse Viber chatbot flow for a contact.

Input Parameters

string
required
Flow ID to run.
string
required
Contact ID for which to run the flow.
object
One-time custom variables available to the selected flow.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_VIBER_CHATBOT_RUN_FLOW_BY_TRIGGERRun the SendPulse Viber chatbot flow associated with a trigger keyword for a contact.

Input Parameters

string
required
Contact ID for which to run the flow.
object
One-time custom variables available to the triggered flow.
string
required
Keyword or command that launches the flow.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_VIBER_CHATBOT_SEND_CAMPAIGNSend immediately or schedule a campaign to a Viber bot audience.

Input Parameters

string
required
Campaign title.
string
required
Bot ID whose subscribers will receive the campaign.
object
Optional subscriber targeting filter.
string
Scheduled date and time in Y-m-d H:i format; omit to send immediately.
array
required
Campaign messages with channel-specific type and content objects.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_VIBER_CHATBOT_SEND_CONTACT_MESSAGESend one or more messages to a SendPulse Viber chatbot contact.

Input Parameters

array
required
Messages to send, including each message type and content.
string
required
Contact ID that should receive the message.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_VIBER_CHATBOT_SET_CONTACT_TAGAssign one or more tags to a SendPulse Viber chatbot contact.

Input Parameters

array
required
Tags to assign to the contact.
string
required
Contact ID whose tags should be updated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_VIBER_CHATBOT_SET_CONTACT_VARIABLEAssign values to one or more variables on a SendPulse Viber chatbot contact.

Input Parameters

array
required
Variables to assign to the contact.
string
required
Contact ID whose variables should be updated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_VIBER_CHATBOT_SET_PAUSE_AUTOMATIONPause automated flows for a SendPulse Viber chatbot contact for a specified duration.

Input Parameters

integer
required
Number of minutes to pause automated flows.
string
required
Contact ID whose automated flows should be paused.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_VIBER_CHATBOT_UNASSIGN_CONTACT_OPERATORSUnassign responsible operators from a SendPulse Viber chatbot contact’s chat.

Input Parameters

string
required
Contact ID whose operators should be unassigned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_VIBER_CHATBOT_UPDATE_CONTACT_NOTEReplace the text of an operator note on a SendPulse Viber chatbot contact.

Input Parameters

string
required
Replacement operator note text.
string
required
Bot ID associated with the contact.
string
required
Note ID to update.
string
required
Contact ID associated with the note.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_VIBER_CREATE_VIBER_CAMPAIGNCreate a Viber campaign using the official SendPulse viber API.

Input Parameters

string
Message.
string
required
‘now’ or ‘YYYY-MM-DD HH:MM:SS’
integer
required
Sender id.
string
Task name.
object
Additional.
array
Recipients.
integer
Address book.
integer ("2" | "3")
required
2 - promo, 3 - system
integer
Stretch time.
integer
required
Message live time.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_VIBER_GET_VIBER_BLACKLISTRetrieve one page of globally blacklisted Viber contacts.

Input Parameters

integer
Number of blacklist records requested per page.
integer
Zero-based blacklist record offset.
string
Continuation cursor returned by a previous call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_VIBER_GET_VIBER_CAMPAIGN_STATSRetrieve delivery and engagement statistics for a Viber campaign.

Input Parameters

integer
required
Viber campaign ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_VIBER_GET_VIBER_RECIPIENTSRetrieve recipient-level delivery records for a Viber campaign.

Input Parameters

integer
required
Viber campaign ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_VIBER_GET_VIBER_SENDER_PROFILERetrieve configuration and verification status for a Viber sender ID.

Input Parameters

integer
required
Viber sender ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_VIBER_REMOVE_VIBER_BLACKLISTRemove specified phone numbers from the Viber blacklist.

Input Parameters

array
required
Phone numbers to remove from the Viber blacklist. Common formatting is removed before sending.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_WEB_PUSH_CREATE_WEB_PUSH_CAMPAIGNCreate and queue a SendPulse browser notification campaign.

Input Parameters

integer
required
Notification lifetime in seconds, up to 86400.
string
required
Notification body text.
string
JSON string containing an icon name and Base64 data.
Destination URL opened from the notification.
string
JSON string containing an image name and Base64 data.
string
required
Web push campaign title.
object
Custom-variable segmentation filter.
string
JSON string defining up to two notification buttons.
string
Scheduled campaign date and time.
string
JSON string containing URL filters.
integer
required
Target SendPulse website ID.
string
Subscriber language filter.
integer
Optional delivery time-stretch setting.
string
JSON string containing country-code filters.
string
Subscriber browser filter.
string
Latest subscription date to target.
string
Earliest subscription date to target.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_WEB_PUSH_GET_WEB_PUSH_CAMPAIGNSGet one page of historical SendPulse web push campaigns.

Input Parameters

integer
Number of web push campaigns requested per page.
string
Offset cursor returned by a previous call.
integer
Zero-based web push campaign offset.
string
Campaign end date-time filter in YYYY-MM-DD HH:MM:SS format.
string
Campaign start date-time filter in YYYY-MM-DD HH:MM:SS format.
integer
Website ID used to filter campaigns.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_WEB_PUSH_GET_WEB_PUSH_CAMPAIGN_STATSGet delivery and redirect statistics for a SendPulse web push campaign.

Input Parameters

integer
required
Web push campaign ID to inspect.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_WEB_PUSH_GET_WEB_PUSH_CODEGet the JavaScript integration code for a SendPulse Web Push website.

Input Parameters

integer
required
Web push website ID whose code to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_WEB_PUSH_GET_WEB_PUSH_SUBSCRIBERS_TOTALGet the total subscriber count for a SendPulse Web Push website.

Input Parameters

integer
required
Web push website ID whose subscribers to count.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_WEB_PUSH_GET_WEB_PUSH_SUBSCRIPTIONSGet one page of subscribers for a SendPulse Web Push website.

Input Parameters

integer
required
Web push website ID whose subscribers to list.
integer
Number of subscribers requested per page.
string
Offset cursor returned by a previous call.
integer
Zero-based subscriber offset.
string
Latest subscription date in YYYY-MM-DD format.
string
Earliest subscription date in YYYY-MM-DD format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_WEB_PUSH_GET_WEB_PUSH_VARIABLESList custom segmentation variables for a SendPulse Web Push website.

Input Parameters

integer
required
Web push website ID whose variables to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_WEB_PUSH_GET_WEB_PUSH_WEBSITE_INFOGet status and subscriber counts for a SendPulse Web Push website.

Input Parameters

integer
required
Web push website ID to inspect.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_WEB_PUSH_GET_WEB_PUSH_WEBSITESGet one page of websites connected to SendPulse Web Push.

Input Parameters

integer
Number of websites requested per page.
string
Offset cursor returned by a previous call.
integer
Zero-based website offset.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_WEB_PUSH_GET_WEB_PUSH_WEBSITES_TOTALGet the number of websites configured for SendPulse Web Push.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_WEB_PUSH_SET_WEB_PUSH_SUBSCRIBER_STATEActivate or deactivate a SendPulse web push subscriber.

Input Parameters

integer
required
Web push subscriber ID.
integer ("0" | "1")
required
Subscriber state: 1 to activate or 0 to deactivate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_WHATSAPP_ASSIGN_CONTACT_OPERATORAssign a SendPulse operator as responsible for a WhatsApp contact chat.

Input Parameters

string
required
Contact ID whose chat will be assigned.
integer
required
SendPulse operator ID to assign.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_WHATSAPP_CLOSE_CONTACT_CHATClose a SendPulse WhatsApp contact chat and lower its queue priority.

Input Parameters

string
required
Contact ID whose chat should be closed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_WHATSAPP_CREATE_CONTACTCreate a contact in a SendPulse WhatsApp bot audience.

Input Parameters

string
Contact name.
array
Tags to assign to the contact.
string
required
Phone number in international format.
string
required
Bot ID to which the contact should be added.
array
Variables to assign to the contact.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_WHATSAPP_CREATE_CONTACT_NOTECreate an internal operator note for a SendPulse WhatsApp contact.

Input Parameters

string
required
Operator note text.
string
required
Bot ID associated with the contact.
string
required
Contact ID to annotate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_WHATSAPP_DELETE_CONTACTPermanently remove a contact from a SendPulse WhatsApp bot audience.

Input Parameters

string
required
Contact ID to permanently remove.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_WHATSAPP_DELETE_CONTACT_NOTEPermanently remove an operator note from a SendPulse WhatsApp contact.

Input Parameters

string
required
Bot ID associated with the contact.
string
required
Note ID to permanently remove.
string
required
Contact ID associated with the note.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_WHATSAPP_DELETE_CONTACT_TAGRemove one tag from a SendPulse WhatsApp contact.

Input Parameters

string
required
Exact case-sensitive tag to remove.
string
required
Contact ID from which to remove the tag.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_WHATSAPP_DELETE_CONTACT_VARIABLEDelete one stored variable value from a SendPulse WhatsApp contact.

Input Parameters

string
required
Contact ID whose variable value will be deleted.
string
Variable ID; provide this or variable_name.
string
Variable name; provide this or variable_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_WHATSAPP_DELETE_PAUSE_AUTOMATIONRemove an automation pause and resume autoflows for a WhatsApp contact.

Input Parameters

string
required
Contact ID whose automation pause will be removed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_WHATSAPP_DISABLE_CONTACTDisable a WhatsApp contact from receiving campaigns and autoflows.

Input Parameters

string
required
Contact ID to disable.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_WHATSAPP_ENABLE_CONTACTEnable a WhatsApp contact to receive campaigns and autoflows.

Input Parameters

string
required
Contact ID to enable.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_WHATSAPP_GET_ACCOUNTReturn the SendPulse WhatsApp chatbot plan, limits, and usage statistics.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_WHATSAPP_GET_BOT_STATISTICSReturn aggregate subscriber and outgoing-message statistics for a SendPulse WhatsApp bot.

Input Parameters

string
required
Bot ID whose statistics to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_WHATSAPP_GET_BOT_VARIABLESReturn one page of variables configured for a SendPulse WhatsApp bot.

Input Parameters

integer
Maximum variables to return.
integer
Number of variables to skip.
string
required
Bot ID whose variables to return.
string
Continuation cursor from a previous response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_WHATSAPP_GET_CHAT_MESSAGESReturn one page of messages exchanged with a SendPulse WhatsApp contact.

Input Parameters

integer
Maximum messages to return.
integer
Number of messages to skip.
string ("asc" | "desc")
Message sort order.
string
required
Contact ID whose messages to return.
string
Continuation cursor from a previous response.
string
Message ID after which to search.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_WHATSAPP_GET_CHATSReturn one page of chats for a SendPulse WhatsApp bot.

Input Parameters

integer
Maximum chats to return.
integer
Number of chats to skip.
string
required
Bot ID whose chats to return.
string
Continuation cursor from a previous response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_WHATSAPP_GET_CONTACT_BY_IDReturn SendPulse WhatsApp contact information by contact ID.

Input Parameters

string
required
Contact ID to look up.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_WHATSAPP_GET_CONTACT_BY_PHONEReturn SendPulse WhatsApp contact information by phone number and bot ID.

Input Parameters

string
required
Contact phone number in international format.
string
required
Bot ID to search within.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_WHATSAPP_GET_CONTACT_NOTESReturn operator notes for a SendPulse WhatsApp contact and bot.

Input Parameters

string
required
Bot ID associated with the contact.
string
required
Contact ID whose operator notes to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_WHATSAPP_GET_CONTACT_PAUSE_AUTOMATIONReturn the remaining automation pause information for a SendPulse WhatsApp contact.

Input Parameters

string
required
Contact ID whose automation pause to inspect.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_WHATSAPP_GET_CONTACTS_BY_TAGReturn one page of SendPulse WhatsApp contacts matching a tag.

Input Parameters

string
required
Contact tag to search for.
integer
Maximum contacts to return.
integer
Number of contacts to skip.
string
required
Bot ID to search within.
string
Continuation cursor from a previous response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_WHATSAPP_GET_CONTACTS_BY_VARIABLEReturn one page of SendPulse WhatsApp contacts matching a variable value.

Input Parameters

integer
Maximum contacts to return.
integer
Number of contacts to skip.
string
Bot ID required when searching by variable_name.
string
Continuation cursor from a previous response.
string
Variable ID to search by; omit when using variable_name and bot_id.
string
Variable name to search by together with bot_id.
string
required
Variable value to match.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_WHATSAPP_GET_TEMPLATE_LISTReturn message templates configured for a SendPulse WhatsApp bot.

Input Parameters

string
required
Bot ID whose templates to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_WHATSAPP_GET_TRIGGERSReturn one page of triggers configured for a SendPulse WhatsApp bot.

Input Parameters

integer
Maximum triggers to return.
integer
Number of triggers to skip.
string
required
Bot ID whose triggers to return.
string
Continuation cursor from a previous response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_WHATSAPP_LIST_FLOWSReturn flows configured for a SendPulse WhatsApp bot.

Input Parameters

integer
Maximum flows to return.
integer
Number of flows to skip.
string
required
Bot ID whose flows to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_WHATSAPP_LIST_TAGSReturn one page of tags configured for a SendPulse WhatsApp bot.

Input Parameters

integer
Maximum tags to return.
integer
Number of tags to skip.
string
required
Bot ID whose tags to return.
string
Continuation cursor from a previous response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_WHATSAPP_MARK_CONTACT_CHAT_UNREADMark the last message from a SendPulse WhatsApp contact as unread.

Input Parameters

string
required
ID of the WhatsApp contact whose last message will be marked unread.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_WHATSAPP_MARK_CONTACT_MESSAGES_AS_READMark all messages from a SendPulse WhatsApp contact as read.

Input Parameters

string
required
ID of the WhatsApp contact whose unread message count will be reset.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_WHATSAPP_OPEN_CONTACT_CHATMark a WhatsApp contact chat as open to increase its support priority.

Input Parameters

string
required
Contact ID whose chat will be marked open.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_WHATSAPP_REACT_TO_CHAT_MESSAGEApply an emoji reaction to a specific inbound SendPulse WhatsApp message.

Input Parameters

string
required
Emoji character or Unicode escape sequence to apply to the message.
string
required
ID of the inbound WhatsApp message to react to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_WHATSAPP_RUN_FLOWLaunch a SendPulse WhatsApp flow by ID for one contact.

Input Parameters

string
required
Flow ID to launch.
string
required
Contact ID for which to launch the flow.
object
One-time custom values available during this flow run.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_WHATSAPP_RUN_FLOW_BY_TRIGGERLaunch a SendPulse WhatsApp flow for one contact using a trigger keyword.

Input Parameters

string
required
Contact ID for which to launch the flow.
object
One-time custom values available during this flow run.
string
required
Configured keyword that triggers the flow.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_WHATSAPP_SEND_CAMPAIGNSend immediately or schedule a campaign to active subscribers of a SendPulse WhatsApp bot.

Input Parameters

string
required
Campaign title.
string
required
Bot ID whose active subscribers will receive the campaign.
object
Optional subscriber targeting filter.
string
Scheduled date and time in Y-m-d H:i format; omit to send immediately.
array
required
Messages to send in the campaign.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_WHATSAPP_SEND_CONTACT_MESSAGESend a typed free-form message to a SendPulse WhatsApp contact.

Input Parameters

string
required
Typed WhatsApp message to send.
string
required
Contact ID that will receive the message.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_WHATSAPP_SEND_CONTACT_TYPINGSend a typing indicator to a SendPulse WhatsApp contact.

Input Parameters

string
required
Contact ID that will receive the typing indicator.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_WHATSAPP_SEND_MESSAGE_TO_CONTACT_BY_PHONESend a typed free-form WhatsApp message to a contact by phone number.

Input Parameters

string
required
Contact phone number in international format.
string
required
Bot ID whose audience will receive the message.
string
required
Typed WhatsApp message to send.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_WHATSAPP_SEND_TEMPLATE_BY_PHONESend an approved WhatsApp template message to a contact by phone number.

Input Parameters

string
required
Contact phone number in international format.
string
required
Bot ID whose audience will receive the template.
object
required
Template content to send.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_WHATSAPP_SEND_TEMPLATE_CAMPAIGNSend immediately or schedule an approved template campaign to subscribers of a SendPulse WhatsApp bot.

Input Parameters

string
required
Campaign title.
string
required
Bot ID whose active subscribers will receive the campaign.
string
Scheduled date and time in Y-m-d H:i format; omit to send immediately.
object
required
Approved WhatsApp template content.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_WHATSAPP_SEND_TEMPLATE_TO_CONTACTSend an approved WhatsApp template message to a SendPulse contact.

Input Parameters

object
required
Template content to send.
string
required
Contact ID that will receive the template.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_WHATSAPP_SET_CONTACT_NAMEUpdate the display name of a SendPulse WhatsApp contact.

Input Parameters

string
required
New display name for the contact.
string
required
Contact ID to rename.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_WHATSAPP_SET_CONTACT_TAGAssign one or more tags to a SendPulse WhatsApp contact.

Input Parameters

array
required
Tags to assign to the contact.
string
required
Contact ID to tag.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_WHATSAPP_SET_CONTACT_VARIABLEAdd or update variable values for a SendPulse WhatsApp contact.

Input Parameters

array
required
Variable values to add or update.
string
required
Contact ID whose variables will be updated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_WHATSAPP_SET_PAUSE_AUTOMATIONPause autoflows for a SendPulse WhatsApp contact for a specified duration.

Input Parameters

integer
required
Number of minutes to pause autoflows.
string
required
Contact ID whose autoflows will be paused.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_WHATSAPP_UN_ASSIGN_CONTACT_OPERATORSRemove the responsible operator assignment from a WhatsApp contact chat.

Input Parameters

string
required
Contact ID whose chat operator will be unassigned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEND_PULSE_WHATSAPP_UPDATE_CONTACT_NOTEUpdate an existing internal operator note for a WhatsApp contact.

Input Parameters

string
required
Replacement note text.
string
required
Bot ID associated with the contact.
string
required
Existing note ID to update.
string
required
Contact ID whose note will be updated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not