> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# SendPulse

> SendPulse is a multichannel marketing platform for email, SMS, chatbots, CRM, automation, web push, and transactional messaging.

![SendPulse logo](https://mintcdn.com/composio-preview/YYC5iurbUCUzEs77/images/toolkits/send_pulse.svg?fit=max\&auto=format\&n=YYC5iurbUCUzEs77\&q=85\&s=a7d23319639632c687858c73ccba72c5)

* **Category:** marketing automation
* **Auth:** API\_KEY, S2S\_OAUTH2
* **Composio-managed OAuth available?** No
* **Tools:** 617
* **Triggers:** 0
* **Slug:** `SEND_PULSE`
* **Version:** 20261101\_00

## Tools

> [accordion] Delete Automation Event Logs
>
> **Slug:** `SEND_PULSE_A360_DELETE_LOGS`
>
> Permanently clear SendPulse Automation 360 event logs.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Action Element Stats
>
> **Slug:** `SEND_PULSE_A360_GET_ACTION_STATS`
>
> Get execution statistics for an Automation 360 action element.
>
> #### Input Parameters
>
> **element\_id** `integer` *required*
>
> Action element ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Condition Element Stats
>
> **Slug:** `SEND_PULSE_A360_GET_CONDITION_STATS`
>
> Get branch statistics for an Automation 360 condition element.
>
> #### Input Parameters
>
> **element\_id** `integer` *required*
>
> Condition element ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Flow Conversions
>
> **Slug:** `SEND_PULSE_A360_GET_CONVERSIONS`
>
> Get conversion metrics for an Automation 360 flow.
>
> #### Input Parameters
>
> **flow\_id** `integer` *required*
>
> Automation flow ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Email Element Stats
>
> **Slug:** `SEND_PULSE_A360_GET_EMAIL_STATS`
>
> Get engagement statistics for an Automation 360 email element.
>
> #### Input Parameters
>
> **element\_id** `integer` *required*
>
> Email element ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Filter Element Stats
>
> **Slug:** `SEND_PULSE_A360_GET_FILTER_STATS`
>
> Get branch statistics for an Automation 360 filter element.
>
> #### Input Parameters
>
> **element\_id** `integer` *required*
>
> Filter element ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Goal Element Stats
>
> **Slug:** `SEND_PULSE_A360_GET_GOAL_STATS`
>
> Get achievement statistics for an Automation 360 goal element.
>
> #### Input Parameters
>
> **element\_id** `integer` *required*
>
> Goal element ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Messenger Element Stats
>
> **Slug:** `SEND_PULSE_A360_GET_MESSENGER_STATS`
>
> Get execution statistics for an Automation 360 messenger element.
>
> #### Input Parameters
>
> **element\_id** `integer` *required*
>
> Messenger element ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Push Element Stats
>
> **Slug:** `SEND_PULSE_A360_GET_PUSH_STATS`
>
> Get delivery and engagement statistics for an Automation 360 push element.
>
> #### Input Parameters
>
> **element\_id** `integer` *required*
>
> Push element ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get SMS Element Stats
>
> **Slug:** `SEND_PULSE_A360_GET_SMS_STATS`
>
> Get delivery statistics for an Automation 360 SMS element.
>
> #### Input Parameters
>
> **element\_id** `integer` *required*
>
> SMS element ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Start Element Stats
>
> **Slug:** `SEND_PULSE_A360_GET_START_STATS`
>
> Get execution statistics for an Automation 360 start element.
>
> #### Input Parameters
>
> **element\_id** `integer` *required*
>
> Start element ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Invited Team Members
>
> **Slug:** `SEND_PULSE_ACCOUNT_LIST_INVITED_USERS`
>
> List all team members invited to the connected SendPulse account.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Add Mailing List Contacts
>
> **Slug:** `SEND_PULSE_ADD_MAILING_LIST_CONTACTS`
>
> Add a batch of contacts to a Bulk Email mailing list, optionally assign tags, and optionally send a double-opt-in confirmation email.
>
> #### Input Parameters
>
> **tags** `array`
>
> Optional unique IDs of existing tags to assign to every added contact.
>
> **contacts** `array` *required*
>
> Contacts to add; each contact requires an email address.
>
> **template\_id** `string`
>
> Optional SendPulse confirmation-email template ID for double opt-in.
>
> **confirmation** `string`
>
> Set to force to send a double-opt-in confirmation email.
>
> **message\_lang** `string ("en" | "ru" | "ua" | "tr" | "es" | "pt")`
>
> Language of the double-opt-in confirmation email.
>
> **sender\_email** `string`
>
> Activated sender address for the double-opt-in confirmation email.
>
> **mailing\_list\_id** `integer` *required*
>
> ID of the mailing list that will receive the contacts.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Activate Bulk Email Sender
>
> **Slug:** `SEND_PULSE_BULK_EMAIL_ACTIVATE_SENDER`
>
> Verify and activate a SendPulse sender email address using its code.
>
> #### Input Parameters
>
> **code** `string` *required*
>
> Verification code sent to the sender email address.
>
> **email** `string` *required*
>
> Sender email address to activate.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Add Bulk Email Sender
>
> **Slug:** `SEND_PULSE_BULK_EMAIL_ADD_SENDER`
>
> Register a new sender email address and begin its verification process.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Sender display name.
>
> **email** `string` *required*
>
> Email address to register as a sender.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Add Emails to Bulk Email Blacklist
>
> **Slug:** `SEND_PULSE_BULK_EMAIL_ADD_TO_BLACKLIST`
>
> Globally suppress one or more email addresses from SendPulse email communications.
>
> #### Input Parameters
>
> **emails** `string` *required*
>
> Base64-encoded comma-separated email addresses to blacklist.
>
> **comment** `string`
>
> Optional reason for the suppression.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Cancel Bulk Email Campaign
>
> **Slug:** `SEND_PULSE_BULK_EMAIL_CANCEL_CAMPAIGN`
>
> Stop a pending or processing Bulk Email campaign; already sent messages cannot be recalled.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> Campaign ID to stop.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Bulk Email Campaign
>
> **Slug:** `SEND_PULSE_BULK_EMAIL_CREATE_CAMPAIGN`
>
> Create, send, schedule, or save a draft SendPulse email campaign.
>
> #### Input Parameters
>
> **body** `string`
>
> Base64-encoded HTML body; required when template\_id is omitted.
>
> **name** `string`
>
> Campaign name.
>
> **type** `string`
>
> Set to draft to create the campaign without sending.
>
> **stats** `object`
>
> Open, click, and UTM tracking options.
>
> **is\_test** `boolean`
>
> Whether to send a test email to sender\_email.
>
> **list\_id** `string`
>
> Mailing list ID or up to 10 IDs; required when segment\_id is omitted.
>
> **subject** `string` *required*
>
> Email subject.
>
> **body\_amp** `string`
>
> Base64-encoded AMP email body.
>
> **send\_date** `string`
>
> Future send date in Y-m-d H:i:s format.
>
> **segment\_id** `integer`
>
> Segment ID; required when list\_id is omitted.
>
> **attachments** `object`
>
> Up to five filename-to-content attachments.
>
> **sender\_name** `string` *required*
>
> Sender display name.
>
> **template\_id** `string`
>
> Template ID; required when body is omitted.
>
> **sender\_email** `string` *required*
>
> Verified sender email address.
>
> **use\_dynamic\_list** `boolean`
>
> Whether contacts added before sending should be included.
>
> **attachments\_binary** `object`
>
> Up to five filename-to-Base64-content attachments.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create a tag
>
> **Slug:** `SEND_PULSE_BULK_EMAIL_CREATE_TAG`
>
> Create a tag using the official SendPulse bulk-email API.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Name.
>
> **color** `string` *required*
>
> Color.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create a template
>
> **Slug:** `SEND_PULSE_BULK_EMAIL_CREATE_TEMPLATE`
>
> Create a template using the official SendPulse bulk-email API.
>
> #### Input Parameters
>
> **body** `string` *required*
>
> HTML encoded in base64
>
> **lang** `string ("en" | "ru" | "ua" | "tr" | "es" | "pt")`
>
> Lang.
>
> **name** `string`
>
> Name.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Email Globally
>
> **Slug:** `SEND_PULSE_BULK_EMAIL_DELETE_EMAIL_GLOBALLY`
>
> Permanently remove an email address from every Bulk Email mailing list.
>
> #### Input Parameters
>
> **email** `string` *required*
>
> Email address to remove from every mailing list.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Bulk Email Sender
>
> **Slug:** `SEND_PULSE_BULK_EMAIL_DELETE_SENDER`
>
> Permanently remove an authorized Bulk Email sender address.
>
> #### Input Parameters
>
> **email** `string` *required*
>
> Authorized sender email address to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Bulk Email Tag
>
> **Slug:** `SEND_PULSE_BULK_EMAIL_DELETE_TAG`
>
> Permanently delete a tag and remove it from assigned contacts.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> Tag ID to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Bulk Email Balance
>
> **Slug:** `SEND_PULSE_BULK_EMAIL_GET_BALANCE`
>
> Retrieve the SendPulse account balance and its currency.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Bulk Email Balance By Currency
>
> **Slug:** `SEND_PULSE_BULK_EMAIL_GET_BALANCE_BY_CURRENCY`
>
> Retrieve the SendPulse account balance for a specific currency.
>
> #### Input Parameters
>
> **currency** `string` *required*
>
> Three-letter currency code for the requested balance.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Bulk Email Blacklist
>
> **Slug:** `SEND_PULSE_BULK_EMAIL_GET_BLACKLIST`
>
> Retrieve all email addresses on the account-wide Bulk Email blacklist.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Bulk Email Campaign Cost By List
>
> **Slug:** `SEND_PULSE_BULK_EMAIL_GET_CAMPAIGN_COST_BY_LIST`
>
> Estimate the cost of sending a Bulk Email campaign to one mailing list.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> Mailing list ID for which to estimate campaign cost.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Bulk Email Campaign Country Statistics
>
> **Slug:** `SEND_PULSE_BULK_EMAIL_GET_CAMPAIGN_COUNTRY_STATS`
>
> Retrieve the geographic breakdown of opens for a Bulk Email campaign.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> Campaign ID whose country statistics to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Bulk Email Campaign Referral Statistics
>
> **Slug:** `SEND_PULSE_BULK_EMAIL_GET_CAMPAIGN_REFERRAL_STATS`
>
> Retrieve per-link click counts for a Bulk Email campaign.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> Campaign ID whose link statistics to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Campaigns By Bulk Email Mailing List
>
> **Slug:** `SEND_PULSE_BULK_EMAIL_GET_CAMPAIGNS_BY_LIST`
>
> Retrieve one page of campaigns that target a specific Bulk Email mailing list.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> Mailing list ID whose campaigns to retrieve.
>
> **limit** `integer`
>
> Number of campaigns requested per page.
>
> **next\_cursor** `string`
>
> Continuation cursor returned by a previous call.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Bulk Email Contacts By Variable
>
> **Slug:** `SEND_PULSE_BULK_EMAIL_GET_CONTACTS_BY_VARIABLE`
>
> Find contacts in one Bulk Email mailing list whose custom variable equals a value.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> Mailing list ID to search.
>
> **searchValue** `string` *required*
>
> Variable value to match, formatted for the variable's type.
>
> **variableName** `string` *required*
>
> Exact mailing list variable name to match.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Recipient Bulk Email Campaign Info
>
> **Slug:** `SEND_PULSE_BULK_EMAIL_GET_EMAIL_CAMPAIGN_INFO`
>
> Retrieve delivery details for one recipient in one Bulk Email campaign.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> Campaign ID to inspect.
>
> **email** `string` *required*
>
> Recipient email address to inspect.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Bulk Email Subscriber Campaign Statistics
>
> **Slug:** `SEND_PULSE_BULK_EMAIL_GET_EMAIL_CAMPAIGN_STATS`
>
> Get campaign engagement statistics for a SendPulse Bulk Email subscriber.
>
> #### Input Parameters
>
> **email** `string` *required*
>
> Subscriber email address to analyze.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Bulk Email Subscriber Details
>
> **Slug:** `SEND_PULSE_BULK_EMAIL_GET_EMAIL_DETAILS`
>
> Get mailing-list membership and acquisition details for a SendPulse email subscriber.
>
> #### Input Parameters
>
> **email** `string` *required*
>
> Subscriber email address to inspect.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Email From Bulk Email Mailing List
>
> **Slug:** `SEND_PULSE_BULK_EMAIL_GET_EMAIL_FROM_LIST`
>
> Retrieve one contact's subscription status and variables from a specific mailing list.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> Mailing list ID to search.
>
> **email** `string` *required*
>
> Email address to retrieve from the mailing list.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Bulk Email Address Info
>
> **Slug:** `SEND_PULSE_BULK_EMAIL_GET_EMAIL_INFO`
>
> Find the Bulk Email mailing lists that contain a specific email address.
>
> #### Input Parameters
>
> **email** `string` *required*
>
> Email address to find across mailing lists.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Bulk Email Contact Count
>
> **Slug:** `SEND_PULSE_BULK_EMAIL_GET_EMAILS_TOTAL_COUNT`
>
> Return the total number of contacts in a Bulk Email mailing list, optionally active contacts only.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> Mailing list ID whose contact count to retrieve.
>
> **active** `boolean`
>
> Whether to count only active contacts.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Bulk Email Mailing List
>
> **Slug:** `SEND_PULSE_BULK_EMAIL_GET_MAILING_LIST_BY_ID`
>
> Retrieve metadata and subscriber counts for one Bulk Email mailing list.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> Mailing list ID to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Bulk Email Mailing List Variables
>
> **Slug:** `SEND_PULSE_BULK_EMAIL_GET_MAILING_LIST_VARIABLES`
>
> Retrieve the custom variable definitions available on one Bulk Email mailing list.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> Mailing list ID whose variables to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Multiple Email Campaign Statistics
>
> **Slug:** `SEND_PULSE_BULK_EMAIL_GET_MULTIPLE_EMAILS_CAMPAIGN_STATS`
>
> Retrieve SendPulse campaign engagement statistics for multiple email addresses.
>
> #### Input Parameters
>
> **emails** `array` *required*
>
> Email addresses whose campaign engagement to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Multiple Bulk Email Contacts
>
> **Slug:** `SEND_PULSE_BULK_EMAIL_GET_MULTIPLE_EMAILS_INFO`
>
> Retrieve mailing-list membership information for multiple email addresses.
>
> #### Input Parameters
>
> **emails** `array` *required*
>
> Email addresses whose account membership to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Bulk Email Senders
>
> **Slug:** `SEND_PULSE_BULK_EMAIL_GET_SENDERS`
>
> List sender identities authorized for SendPulse Bulk Email campaigns.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Bulk Email Tags
>
> **Slug:** `SEND_PULSE_BULK_EMAIL_GET_TAGS`
>
> Retrieve all tags created for the SendPulse account.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Bulk Email Template by ID
>
> **Slug:** `SEND_PULSE_BULK_EMAIL_GET_TEMPLATE_BY_ID`
>
> Retrieve metadata for a SendPulse email template by ID.
>
> #### Input Parameters
>
> **lang** `string`
>
> Optional template language code.
>
> **owner** `string ("me" | "sendpulse")`
>
> Template owner to search.
>
> **template\_id** `string` *required*
>
> Template ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Bulk Email Template by Slug
>
> **Slug:** `SEND_PULSE_BULK_EMAIL_GET_TEMPLATE_BY_SLUG`
>
> Retrieve a SendPulse email template by its unique name slug.
>
> #### Input Parameters
>
> **lang** `string`
>
> Optional template language code.
>
> **owner** `string ("me" | "sendpulse")`
>
> Template owner to search.
>
> **name\_slug** `string` *required*
>
> Unique template name slug.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Bulk Email Templates
>
> **Slug:** `SEND_PULSE_BULK_EMAIL_GET_TEMPLATES`
>
> Retrieve one page of SendPulse system or account email templates.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Number of templates requested per page.
>
> **owner** `string ("me" | "sendpulse")`
>
> Template owner to list.
>
> **offset** `integer`
>
> Zero-based template offset.
>
> **next\_cursor** `string`
>
> Continuation cursor returned by a previous call.
>
> **only\_active** `boolean`
>
> Whether to return only active templates.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Assign tag to email
>
> **Slug:** `SEND_PULSE_BULK_EMAIL_PIN_TAG_TO_EMAIL`
>
> Assign tag to email using the official SendPulse bulk-email API.
>
> #### Input Parameters
>
> **tags** `array` *required*
>
> Tags.
>
> **email** `string` *required*
>
> Email.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Assign tag to phone
>
> **Slug:** `SEND_PULSE_BULK_EMAIL_PIN_TAG_TO_PHONE`
>
> Assign tag to phone using the official SendPulse bulk-email API.
>
> #### Input Parameters
>
> **tags** `array` *required*
>
> Tags.
>
> **phone** `string` *required*
>
> Phone.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Remove Emails From Bulk Email Blacklist
>
> **Slug:** `SEND_PULSE_BULK_EMAIL_REMOVE_FROM_BLACKLIST`
>
> Remove consented email addresses from the account-wide Bulk Email blacklist.
>
> #### Input Parameters
>
> **emails** `string` *required*
>
> Base64-encoded comma-separated email addresses to remove from the blacklist.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Request Bulk Email Sender Activation Code
>
> **Slug:** `SEND_PULSE_BULK_EMAIL_REQUEST_SENDER_ACTIVATION_CODE`
>
> Request a new activation email for an unverified SendPulse Bulk Email sender.
>
> #### Input Parameters
>
> **email** `string` *required*
>
> Unverified sender email address that should receive an activation code.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Unassign tag from email
>
> **Slug:** `SEND_PULSE_BULK_EMAIL_UNPIN_TAG_FROM_EMAIL`
>
> Unassign tag from email using the official SendPulse bulk-email API.
>
> #### Input Parameters
>
> **tags** `array` *required*
>
> Tags.
>
> **email** `string` *required*
>
> Email.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Unassign tag from phone
>
> **Slug:** `SEND_PULSE_BULK_EMAIL_UNPIN_TAG_FROM_PHONE`
>
> Unassign tag from phone using the official SendPulse bulk-email API.
>
> #### Input Parameters
>
> **tags** `array` *required*
>
> Tags.
>
> **phone** `string` *required*
>
> Phone.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Unsubscribe Emails from Mailing List
>
> **Slug:** `SEND_PULSE_BULK_EMAIL_UNSUBSCRIBE_EMAILS_FROM_MAILING_LIST`
>
> Mark up to 100 email contacts as unsubscribed within one SendPulse mailing list.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> Mailing list ID.
>
> **emails** `array` *required*
>
> Email addresses to unsubscribe, with at most 100 per request.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Bulk Email Campaign
>
> **Slug:** `SEND_PULSE_BULK_EMAIL_UPDATE_CAMPAIGN`
>
> Update the name or subject of a pending SendPulse email campaign.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> Scheduled campaign ID.
>
> **name** `string`
>
> Updated campaign name.
>
> **subject** `string`
>
> Updated email subject.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Change a phone number for a contact
>
> **Slug:** `SEND_PULSE_BULK_EMAIL_UPDATE_CONTACT_PHONE`
>
> Change a phone number for a contact using the official SendPulse bulk-email API.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> Id.
>
> **email** `string` *required*
>
> Email.
>
> **phone** `string` *required*
>
> Phone.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Bulk Email Contact Variables
>
> **Slug:** `SEND_PULSE_BULK_EMAIL_UPDATE_CONTACT_VARIABLES`
>
> Update custom variables for an email contact in a SendPulse mailing list.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> Mailing list ID.
>
> **email** `string` *required*
>
> Email address of the contact to update.
>
> **variables** `array` *required*
>
> Variables and values to update.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update a tag
>
> **Slug:** `SEND_PULSE_BULK_EMAIL_UPDATE_TAG`
>
> Update a tag using the official SendPulse bulk-email API.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> Id.
>
> **name** `string` *required*
>
> Name.
>
> **color** `string` *required*
>
> Color.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Edit a template
>
> **Slug:** `SEND_PULSE_BULK_EMAIL_UPDATE_TEMPLATE`
>
> Edit a template using the official SendPulse bulk-email API.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> Id.
>
> **body** `string` *required*
>
> HTML version of the email, encoded in base64
>
> **lang** `string ("en" | "ru" | "ua" | "tr" | "es" | "pt")`
>
> Lang.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Mailing List
>
> **Slug:** `SEND_PULSE_CREATE_MAILING_LIST`
>
> Create an empty Bulk Email mailing list and return its new ID.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Name for the new mailing list.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Add Contact Attribute Value
>
> **Slug:** `SEND_PULSE_CRM_ADD_CONTACT_ATTRIBUTE_VALUE`
>
> Store a value for an existing SendPulse CRM contact attribute.
>
> #### Input Parameters
>
> **value** `string` *required*
>
> Attribute value, up to 5,500 characters.
>
> **contact\_id** `integer` *required*
>
> Contact ID.
>
> **attribute\_id** `integer` *required*
>
> Attribute ID to add.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Add Contact Comment
>
> **Slug:** `SEND_PULSE_CRM_ADD_CONTACT_COMMENT`
>
> Add a comment to a SendPulse CRM contact.
>
> #### Input Parameters
>
> **message** `string` *required*
>
> Comment message, up to 65,535 characters.
>
> **contact\_id** `integer` *required*
>
> Contact ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Add Contact Company Relation
>
> **Slug:** `SEND_PULSE_CRM_ADD_CONTACT_COMPANY_RELATION`
>
> Associate a SendPulse CRM contact with a company.
>
> #### Input Parameters
>
> **company\_id** `integer` *required*
>
> Company ID.
>
> **contact\_id** `integer` *required*
>
> Contact ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Add Contact Emails
>
> **Slug:** `SEND_PULSE_CRM_ADD_CONTACT_EMAILS`
>
> Add email addresses to a SendPulse CRM contact.
>
> #### Input Parameters
>
> **emails** `array`
>
> Email records to add.
>
> **contact\_id** `integer` *required*
>
> Contact ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Add Contact Messenger
>
> **Slug:** `SEND_PULSE_CRM_ADD_CONTACT_MESSENGER`
>
> Add a messenger account to a SendPulse CRM contact.
>
> #### Input Parameters
>
> **login** `string` *required*
>
> Contact login in the messenger.
>
> **type\_id** `integer` *required*
>
> Messenger type ID.
>
> **contact\_id** `integer` *required*
>
> Contact ID.
>
> **is\_main\_chatbot** `boolean`
>
> Whether this is the main chatbot messenger.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Add Contact Phone
>
> **Slug:** `SEND_PULSE_CRM_ADD_CONTACT_PHONE`
>
> Add a phone number to a SendPulse CRM contact.
>
> #### Input Parameters
>
> **phone** `string` *required*
>
> Phone number to add.
>
> **contact\_id** `integer` *required*
>
> Contact ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Add a contact to a deal
>
> **Slug:** `SEND_PULSE_CRM_ADD_CONTACT_TO_DEAL`
>
> Adds a previously created contact to the specified deal
>
> #### Input Parameters
>
> **dealId** `integer` *required*
>
> Deal ID in which you want to add the contact. It can be obtained with the "Get a list of deals" method
>
> **contactId** `integer` *required*
>
> Contact ID you want to add to the deal. It can be obtained with the "Get a list of contacts" method
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Add Custom Tab Relation
>
> **Slug:** `SEND_PULSE_CRM_ADD_CUSTOM_TAB_RELATION`
>
> Relate a SendPulse CRM custom tab to entities or attributes.
>
> #### Input Parameters
>
> **entity\_id** `integer`
>
> Related board or pipeline ID.
>
> **entity\_ids** `array`
>
> Related attribute IDs.
>
> **entity\_type** `integer`
>
> Entity type code from 0 through 3.
>
> **custom\_tab\_id** `integer` *required*
>
> Custom tab ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Add Deal Attribute
>
> **Slug:** `SEND_PULSE_CRM_ADD_DEAL_ATTRIBUTE`
>
> Store a value for an existing SendPulse CRM deal attribute.
>
> #### Input Parameters
>
> **value** `string` *required*
>
> Attribute value, up to 5,500 characters.
>
> **deal\_id** `integer` *required*
>
> Deal ID.
>
> **attribute\_id** `integer` *required*
>
> Attribute ID to add.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Add a note to a deal
>
> **Slug:** `SEND_PULSE_CRM_ADD_DEAL_COMMENT`
>
> Adds a note to the specified deal
>
> #### Input Parameters
>
> **dealId** `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
>
> **message** `string` *required*
>
> Note message. The maximum number of characters is 65,535
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Add product to deal
>
> **Slug:** `SEND_PULSE_CRM_ADD_PRODUCT_TO_DEAL`
>
> Attach a SendPulse CRM product, quantity, and price to a deal.
>
> #### Input Parameters
>
> **dealId** `number`
>
> DealId value documented by SendPulse.
>
> **quantity** `number`
>
> Quantity value documented by SendPulse.
>
> **productId** `number`
>
> ProductId value documented by SendPulse.
>
> **productPriceISO** `string`
>
> ProductPriceIso value documented by SendPulse.
>
> **productPriceValue** `number`
>
> ProductPriceValue value documented by SendPulse.
>
> **allow\_out\_of\_stock** `boolean`
>
> When true the product is attached even if stock is zero and inventory is not decremented
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Add Tag to Contact
>
> **Slug:** `SEND_PULSE_CRM_ADD_TAG_TO_CONTACT`
>
> Add an existing SendPulse CRM tag to a contact.
>
> #### Input Parameters
>
> **tag\_id** `integer` *required*
>
> Tag ID to add.
>
> **contact\_id** `integer` *required*
>
> Contact ID that receives the tag.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Add comment to task
>
> **Slug:** `SEND_PULSE_CRM_ADD_TASK_COMMENT`
>
> Add an internal comment to a SendPulse CRM task.
>
> #### Input Parameters
>
> **taskId** `integer` *required*
>
> SendPulse taskId parameter.
>
> **message** `string`
>
> Comment message
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Approve manual payment.
>
> **Slug:** `SEND_PULSE_CRM_APPROVE_PAYMENT`
>
> Set approval status for manually created payment
>
> #### Input Parameters
>
> **paymentId** `integer` *required*
>
> The unique identifier of the manually created payment to approve
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Attach Call to Deal
>
> **Slug:** `SEND_PULSE_CRM_ATTACH_CALL_TO_DEAL`
>
> Attach a telephony call to a SendPulse CRM deal.
>
> #### Input Parameters
>
> **call\_id** `integer`
>
> Telephony call ID.
>
> **deal\_id** `integer` *required*
>
> Deal ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Attach entity to task
>
> **Slug:** `SEND_PULSE_CRM_ATTACH_ENTITIES_TO_TASK`
>
> Attach specified CRM contacts, deals, or tasks to a SendPulse CRM task.
>
> #### Input Parameters
>
> **taskId** `integer` *required*
>
> SendPulse taskId parameter.
>
> **connections** `object`
>
> Connections value documented by SendPulse.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Batch Create CRM Company Emails
>
> **Slug:** `SEND_PULSE_CRM_BATCH_CREATE_COMPANY_EMAILS`
>
> Add multiple email addresses to a CRM company in one request.
>
> #### Input Parameters
>
> **emails** `array`
>
> Company emails to create in one request.
>
> **companyId** `integer` *required*
>
> Company ID that will receive the emails.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Batch Create Company Messengers
>
> **Slug:** `SEND_PULSE_CRM_BATCH_CREATE_COMPANY_MESSENGERS`
>
> Create multiple messenger records for a SendPulse CRM company.
>
> #### Input Parameters
>
> **company\_id** `integer` *required*
>
> Company ID.
>
> **messengers** `array`
>
> Messenger records to create.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Batch Create Company Phones
>
> **Slug:** `SEND_PULSE_CRM_BATCH_CREATE_COMPANY_PHONES`
>
> Create multiple phone records for a SendPulse CRM company.
>
> #### Input Parameters
>
> **phones** `array`
>
> Phone records to create.
>
> **company\_id** `integer` *required*
>
> Company ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Batch Store Contact Attribute Values
>
> **Slug:** `SEND_PULSE_CRM_BATCH_STORE_CONTACT_ATTRIBUTE_VALUES`
>
> Store multiple attribute values for a SendPulse CRM contact.
>
> #### Input Parameters
>
> **contact\_id** `integer` *required*
>
> Contact ID.
>
> **attributes\_values** `array`
>
> Attribute values to store.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Cancel manual payment
>
> **Slug:** `SEND_PULSE_CRM_CANCEL_PAYMENT`
>
> Set payment status to canceled for manually created payment.
>
> #### Input Parameters
>
> **paymentId** `integer` *required*
>
> The unique identifier of the payment to cancel
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Change Deal Pipeline
>
> **Slug:** `SEND_PULSE_CRM_CHANGE_DEAL_PIPELINE`
>
> Move a SendPulse CRM deal to a pipeline and step.
>
> #### Input Parameters
>
> **deal\_id** `integer` *required*
>
> Deal ID.
>
> **step\_id** `integer`
>
> Destination pipeline step ID.
>
> **pipeline\_id** `integer`
>
> Destination pipeline ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Change task order
>
> **Slug:** `SEND_PULSE_CRM_CHANGE_TASK_STEP_ORDER`
>
> Changes order of a task in the current step or in another. newStepId field is optional
>
> #### Input Parameters
>
> **order** `number` *required*
>
> Task order in step
>
> **stepId** `integer` *required*
>
> SendPulse stepId parameter.
>
> **taskId** `integer` *required*
>
> SendPulse taskId parameter.
>
> **newStepId** `number`
>
> New step ID
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create CRM Attachment
>
> **Slug:** `SEND_PULSE_CRM_CREATE_ATTACHMENT`
>
> Attach one previously uploaded File Manager file to a CRM task, deal, or contact.
>
> #### Input Parameters
>
> **link** `string`
>
> File Manager path of the previously uploaded file.
>
> **entityId** `number`
>
> ID of the CRM entity receiving the attachment.
>
> **entityType** `string ("task" | "deal" | "contact")`
>
> Type of CRM entity receiving the attachment.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create CRM Attachments Batch
>
> **Slug:** `SEND_PULSE_CRM_CREATE_ATTACHMENTS_BATCH`
>
> Attach a batch of previously uploaded files to CRM deals, tasks, contacts, or their comments.
>
> #### Input Parameters
>
> **attachments** `array`
>
> Attachments to create in one request.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create CRM Board
>
> **Slug:** `SEND_PULSE_CRM_CREATE_BOARD`
>
> Create a CRM task board with optional responsible-user and color settings.
>
> #### Input Parameters
>
> **name** `string`
>
> Board name.
>
> **settings** `array`
>
> Board settings.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create CRM Board Attribute
>
> **Slug:** `SEND_PULSE_CRM_CREATE_BOARD_ATTRIBUTE`
>
> Create a typed custom attribute on a CRM task board.
>
> #### Input Parameters
>
> **name** `string`
>
> Attribute name.
>
> **type** `number`
>
> Attribute type: 0 string, 1 number, 2 date, 3 link, 4 list, or 5 multi-list.
>
> **boardId** `integer` *required*
>
> Board ID that will own the attribute.
>
> **options** `array`
>
> Options for list and multi-list attributes.
>
> **mandatory** `boolean`
>
> Whether the attribute is required.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create CRM Board Step
>
> **Slug:** `SEND_PULSE_CRM_CREATE_BOARD_STEPS`
>
> Create a workflow step in a CRM task board.
>
> #### Input Parameters
>
> **name** `string`
>
> Step name.
>
> **color** `string`
>
> Step color.
>
> **boardId** `integer` *required*
>
> Board ID that will own the step.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create CRM Checklist Item
>
> **Slug:** `SEND_PULSE_CRM_CREATE_CHECKLIST_ITEMS`
>
> Create an item in an existing CRM task checklist.
>
> #### Input Parameters
>
> **name** `string`
>
> Checklist item name.
>
> **isDone** `number`
>
> Completion state: 0 not done or 1 done.
>
> **checklistId** `integer` *required*
>
> Checklist ID that will receive the item.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create CRM Company
>
> **Slug:** `SEND_PULSE_CRM_CREATE_COMPANY`
>
> Create a company record in SendPulse CRM.
>
> #### Input Parameters
>
> **address** `string`
>
> Company address.
>
> **currency** `string`
>
> Currency required when annualBusinessVolume is provided.
>
> **companyName** `string`
>
> Company name.
>
> **responsibleId** `integer`
>
> Responsible CRM user ID; SendPulse assigns one when omitted.
>
> **annualBusinessVolume** `integer`
>
> Annual business volume.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create CRM Company Attribute
>
> **Slug:** `SEND_PULSE_CRM_CREATE_COMPANY_ATTRIBUTE`
>
> Create a typed custom attribute for CRM company records.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Company attribute name.
>
> **type** `integer`
>
> Attribute type: 0 text, 1 number, 2 date, 3 link, 4 select, or 5 multi-select.
>
> **options** `array`
>
> Options for select and multi-select attributes.
>
> **mandatory** `boolean`
>
> Whether the attribute is mandatory.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create CRM Company Email
>
> **Slug:** `SEND_PULSE_CRM_CREATE_COMPANY_EMAIL`
>
> Add one email address to a CRM company record.
>
> #### Input Parameters
>
> **data** `object`
>
> Email values to create.
>
> **companyId** `integer` *required*
>
> Company ID that will receive the email.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create CRM Company Messenger
>
> **Slug:** `SEND_PULSE_CRM_CREATE_COMPANY_MESSENGER`
>
> Connect one messenger contact record to a CRM company.
>
> #### Input Parameters
>
> **data** `object`
>
> Messenger values to create.
>
> **companyId** `integer` *required*
>
> Company ID that will receive the messenger record.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Company Phone
>
> **Slug:** `SEND_PULSE_CRM_CREATE_COMPANY_PHONE`
>
> Create a phone record for a SendPulse CRM company.
>
> #### Input Parameters
>
> **data** `object`
>
> Phone record to create.
>
> **company\_id** `integer` *required*
>
> Company ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Contact
>
> **Slug:** `SEND_PULSE_CRM_CREATE_CONTACT`
>
> Create a SendPulse CRM contact with a responsible team member and basic identity fields.
>
> #### Input Parameters
>
> **lastName** `string`
>
> Contact last name.
>
> **firstName** `string`
>
> Contact first name.
>
> **responsibleId** `integer` *required*
>
> Team member ID assigned to the contact.
>
> **externalContactId** `string`
>
> External contact ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Contact Attribute
>
> **Slug:** `SEND_PULSE_CRM_CREATE_CONTACT_ATTRIBUTE`
>
> Create a custom attribute for SendPulse CRM contacts.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Attribute name.
>
> **type** `integer`
>
> Attribute type code from 0 through 5.
>
> **options** `array`
>
> Select options.
>
> **mandatory** `boolean`
>
> Whether the attribute is required.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Contact (Deprecated Endpoint)
>
> **Slug:** `SEND_PULSE_CRM_CREATE_CONTACT_DEPRECATED`
>
> Create a SendPulse CRM contact through the deprecated full-contact endpoint.
>
> #### Input Parameters
>
> **tags** `array`
>
> Tag IDs to add.
>
> **emails** `array`
>
> Email addresses.
>
> **phones** `array`
>
> International phone numbers.
>
> **lastName** `string`
>
> Contact last name.
>
> **firstName** `string`
>
> Contact first name.
>
> **attributes** `array`
>
> Contact attributes to add.
>
> **messengers** `array`
>
> Messenger accounts to add.
>
> **attachments** `array`
>
> Previously uploaded file-manager paths to attach.
>
> **responsibleId** `integer` *required*
>
> Team member ID assigned to the contact.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Contact Tag
>
> **Slug:** `SEND_PULSE_CRM_CREATE_CONTACT_TAG`
>
> Create a tag for SendPulse CRM contacts.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Tag name, up to 64 characters.
>
> **colorText** `string`
>
> Text color.
>
> **colorBackground** `string`
>
> Background color.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Custom Tab
>
> **Slug:** `SEND_PULSE_CRM_CREATE_CUSTOM_TAB`
>
> Create a custom tab for a SendPulse CRM entity type.
>
> #### Input Parameters
>
> **name** `string`
>
> Custom tab name.
>
> **entityId** `integer`
>
> Related board or pipeline ID.
>
> **entityType** `integer`
>
> Entity type code from 0 through 3.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Deal
>
> **Slug:** `SEND_PULSE_CRM_CREATE_DEAL`
>
> Create a deal in a SendPulse CRM pipeline.
>
> #### Input Parameters
>
> **name** `string`
>
> Deal name.
>
> **price** `number`
>
> Deal amount.
>
> **stepId** `integer` *required*
>
> Pipeline step ID.
>
> **contact** `array`
>
> Contact IDs associated with the deal.
>
> **currency** `string`
>
> Deal currency such as UAH, USD, or EUR.
>
> **sourceId** `integer`
>
> External source ID.
>
> **attributes** `array`
>
> Deal attribute values.
>
> **pipelineId** `integer` *required*
>
> Pipeline ID.
>
> **attachments** `array`
>
> Previously uploaded file-manager paths to attach.
>
> **responsibleId** `integer`
>
> Responsible team member ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create managers from category
>
> **Slug:** `SEND_PULSE_CRM_CREATE_MANAGER_SETTINGS`
>
> Assign CRM managers to a SendPulse manager-settings section.
>
> #### Input Parameters
>
> **sectionId** `integer`
>
> SectionId value documented by SendPulse.
>
> **responsibleIds** `array`
>
> ResponsibleIds value documented by SendPulse.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create  payment
>
> **Slug:** `SEND_PULSE_CRM_CREATE_PAYMENT`
>
> Record a manual payment for a SendPulse CRM contact or deal.
>
> #### Input Parameters
>
> **price** `integer`
>
> Payment amount
>
> **dealId** `integer`
>
> Deal ID for which you need to create payment.
>
> **currency** `string`
>
> Payment currency
>
> **contactId** `integer`
>
> Contact ID for which you need to create payment.
>
> **description** `string`
>
> Description value documented by SendPulse.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create new pipeline
>
> **Slug:** `SEND_PULSE_CRM_CREATE_PIPELINE`
>
> Create a SendPulse CRM deal pipeline with optional settings.
>
> #### Input Parameters
>
> **name** `string`
>
> Pipeline name
>
> **settings** `array`
>
> Settings value documented by SendPulse.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create a deal attribute
>
> **Slug:** `SEND_PULSE_CRM_CREATE_PIPELINE_ATTRIBUTE`
>
> Create a custom deal attribute in a SendPulse CRM pipeline.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Name value documented by SendPulse.
>
> **type** `integer` *required*
>
> 0 = Text, 1 = Number, 2 = Date, 3 = Link, 4 = Select, 5 = MultiSelect
>
> **options** `array`
>
> Options value documented by SendPulse.
>
> **mandatory** `boolean`
>
> Mandatory value documented by SendPulse.
>
> **pipelineId** `integer` *required*
>
> SendPulse pipelineId parameter.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create a new pipeline step
>
> **Slug:** `SEND_PULSE_CRM_CREATE_PIPELINE_STEP`
>
> Create a stage in a specified SendPulse CRM deal pipeline.
>
> #### Input Parameters
>
> **name** `string`
>
> Name value documented by SendPulse.
>
> **color** `string ("#000000" | "black")`
>
> Step color
>
> **order** `integer`
>
> Order value documented by SendPulse.
>
> **notifyIn** `string ("0" | "15min" | "30min" | "1h" | "2h" | "3h" | "6h" | "12h" | "24h" | "2d" | "3d" | "4d" | "5d" | "6d" | "7d")`
>
> Time notification
>
> **pipelineId** `integer` *required*
>
> SendPulse pipelineId parameter.
>
> **addEndHours** `integer ("1" | "2" | "3" | "4" | "5" | "6" | "8" | "9" | "10")`
>
> Add number of hours or null
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create a new product
>
> **Slug:** `SEND_PULSE_CRM_CREATE_PRODUCT`
>
> Create a SendPulse CRM product with pricing, inventory, and category details.
>
> #### Input Parameters
>
> **seo** `object`
>
> Product SEO info.
>
> **name** `string`
>
> Product name. Max length 255
>
> **type** `number`
>
> Product type . 1 - product, 2 - service, 3 - subscription (expected soon)
>
> **images** `array`
>
> Product images. Path from File manager service
>
> **prices** `array`
>
> Prices value documented by SendPulse.
>
> **balance** `object`
>
> Product balance.
>
> **visible** `integer ("0" | "1")`
>
> Product visibility. 0 - not visible, 1 - visible
>
> **sections** `array`
>
> Product sections.
>
> **categoryId** `number`
>
> Category ID. It can be obtained with the "Get users categories" method
>
> **vendorCode** `string`
>
> Product vendor code. Max length 255
>
> **description** `string`
>
> Product description. Max length 10000
>
> **digitalInfo** `object`
>
> Product digital info.
>
> **productType** `integer ("1" | "2" | "3")`
>
> Product type. 1 - physical, 2 - digital
>
> **availability** `integer ("1" | "2" | "3")`
>
> Product availability. 1 - available, 2 - unavailable, 3 - expecting
>
> **shortDescription** `string`
>
> Product short description. Max length 10000
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Store users categories
>
> **Slug:** `SEND_PULSE_CRM_CREATE_PRODUCT_CATEGORY`
>
> Create a category for organizing SendPulse CRM products.
>
> #### Input Parameters
>
> **name** `string`
>
> Name of the category
>
> **parentId** `number`
>
> ID of parent category. Null for root.
>
> **sections** `array`
>
> Sections belonging to the category
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Product Sections
>
> **Slug:** `SEND_PULSE_CRM_CREATE_PRODUCT_SECTIONS`
>
> Create sections and their attribute values for a SendPulse CRM product.
>
> #### Input Parameters
>
> **sections** `array`
>
> List of sections to update
>
> **productId** `integer` *required*
>
> ID of the product to update sections for
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create tasks
>
> **Slug:** `SEND_PULSE_CRM_CREATE_TASK`
>
> Create a SendPulse CRM task with ownership, scheduling, and optional recurrence.
>
> #### Input Parameters
>
> **name** `string`
>
> Task name
>
> **tags** `array`
>
> IDs of tags
>
> **alert** `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.
>
> **repeat** `integer`
>
> Do you need to repeat the task
>
> **stepId** `integer`
>
> StepId value documented by SendPulse.
>
> **boardId** `integer`
>
> BoardId value documented by SendPulse.
>
> **startAt** `string`
>
> StartAt value documented by SendPulse.
>
> **finishAt** `string`
>
> FinishAt value documented by SendPulse.
>
> **parentId** `integer`
>
> Parent task ID
>
> **priority** `integer`
>
> Priority value documented by SendPulse.
>
> **observers** `array`
>
> Array of users IDs acting as observers
>
> **attributes** `array`
>
> Attributes value documented by SendPulse.
>
> **checklists** `array`
>
> Checklists value documented by SendPulse.
>
> **sourceType** `integer`
>
> SourceType value documented by SendPulse.
>
> **attachments** `array`
>
> First, the file must be uploaded to the file manager, and then the file can be attached.
>
> **connections** `object`
>
> Connections value documented by SendPulse.
>
> **description** `string`
>
> Task description
>
> **repeatSetting** `object`
>
> RepeatSetting value documented by SendPulse.
>
> **responsibleId** `integer`
>
> Responsible user ID
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create attribute value
>
> **Slug:** `SEND_PULSE_CRM_CREATE_TASK_ATTRIBUTE_VALUE`
>
> Set a custom attribute value on a SendPulse CRM task.
>
> #### Input Parameters
>
> **value** `string`
>
> Attribute value as a scalar string or array of values
>
> **taskId** `integer` *required*
>
> SendPulse taskId parameter.
>
> **attributeId** `number`
>
> ID of attribute
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create checklist without items in task
>
> **Slug:** `SEND_PULSE_CRM_CREATE_TASK_CHECKLIST`
>
> Create one empty checklist on a SendPulse CRM task.
>
> #### Input Parameters
>
> **name** `string`
>
> Checklist name
>
> **taskId** `integer` *required*
>
> SendPulse taskId parameter.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create multiple checklists with items in task
>
> **Slug:** `SEND_PULSE_CRM_CREATE_TASK_CHECKLISTS`
>
> Create multiple checklists and their items on a SendPulse CRM task.
>
> #### Input Parameters
>
> **taskId** `integer` *required*
>
> SendPulse taskId parameter.
>
> **checklists** `array`
>
> Checklists value documented by SendPulse.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create a task tag
>
> **Slug:** `SEND_PULSE_CRM_CREATE_TASK_TAG`
>
> Create a task tag
>
> #### Input Parameters
>
> **name** `string`
>
> Tag name
>
> **color** `string`
>
> Tag color
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete CRM Attachment
>
> **Slug:** `SEND_PULSE_CRM_DELETE_ATTACHMENT`
>
> Permanently detach a file attachment from SendPulse CRM.
>
> #### Input Parameters
>
> **attachment\_id** `integer` *required*
>
> ID of the file attachment to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete CRM Task Attribute Value
>
> **Slug:** `SEND_PULSE_CRM_DELETE_ATTRIBUTE_VALUE`
>
> Delete a value from a SendPulse CRM task attribute.
>
> #### Input Parameters
>
> **board\_id** `integer` *required*
>
> ID of the task board containing the attribute.
>
> **value\_id** `integer` *required*
>
> ID of the task attribute value to delete.
>
> **attribute\_id** `integer` *required*
>
> ID of the task attribute containing the value.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete CRM Checklist Item
>
> **Slug:** `SEND_PULSE_CRM_DELETE_CHECKLIST_ITEM`
>
> Permanently delete an item from a SendPulse CRM checklist.
>
> #### Input Parameters
>
> **item\_id** `integer` *required*
>
> ID of the checklist item to delete.
>
> **checklist\_id** `integer` *required*
>
> ID of the checklist containing the item.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete CRM Company
>
> **Slug:** `SEND_PULSE_CRM_DELETE_COMPANY`
>
> Permanently delete a company from SendPulse CRM.
>
> #### Input Parameters
>
> **company\_id** `integer` *required*
>
> ID of the company to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete CRM Company Attribute
>
> **Slug:** `SEND_PULSE_CRM_DELETE_COMPANY_ATTRIBUTE`
>
> Permanently delete a company attribute from SendPulse CRM.
>
> #### Input Parameters
>
> **attribute\_id** `integer` *required*
>
> ID of the company attribute to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete CRM Company Email
>
> **Slug:** `SEND_PULSE_CRM_DELETE_COMPANY_EMAIL`
>
> Remove an email address from a SendPulse CRM company.
>
> #### Input Parameters
>
> **email\_id** `integer` *required*
>
> ID of the email address to delete.
>
> **company\_id** `integer` *required*
>
> ID of the company containing the email address.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete CRM Company Messenger
>
> **Slug:** `SEND_PULSE_CRM_DELETE_COMPANY_MESSENGER`
>
> Remove a messenger from a SendPulse CRM company.
>
> #### Input Parameters
>
> **entity\_id** `integer` *required*
>
> ID of the company containing the messenger.
>
> **entity\_type** `string`
>
> CRM entity type; the API accepts only company.
>
> **messenger\_id** `integer` *required*
>
> ID of the messenger to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete CRM Company Phone
>
> **Slug:** `SEND_PULSE_CRM_DELETE_COMPANY_PHONE`
>
> Remove a phone number from a SendPulse CRM company.
>
> #### Input Parameters
>
> **phone\_id** `integer` *required*
>
> ID of the phone number to delete.
>
> **entity\_id** `integer` *required*
>
> ID of the company containing the phone number.
>
> **entity\_type** `string`
>
> CRM entity type; the API accepts only company.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete CRM Contact Attribute
>
> **Slug:** `SEND_PULSE_CRM_DELETE_CONTACT_ATTRIBUTE`
>
> Permanently delete a contact attribute from SendPulse CRM.
>
> #### Input Parameters
>
> **attribute\_id** `integer` *required*
>
> ID of the contact attribute to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete CRM Contact Attribute Value
>
> **Slug:** `SEND_PULSE_CRM_DELETE_CONTACT_ATTRIBUTE_VALUE`
>
> Remove an attribute value from a SendPulse CRM contact.
>
> #### Input Parameters
>
> **contact\_id** `integer` *required*
>
> ID of the contact containing the attribute value.
>
> **attribute\_id** `integer` *required*
>
> ID of the attribute value to remove from the contact.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete CRM Contact By ID
>
> **Slug:** `SEND_PULSE_CRM_DELETE_CONTACT_BY_ID`
>
> Permanently remove a SendPulse CRM contact by ID.
>
> #### Input Parameters
>
> **contact\_id** `integer` *required*
>
> ID of the contact to remove.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete CRM Contact Comment
>
> **Slug:** `SEND_PULSE_CRM_DELETE_CONTACT_COMMENT`
>
> Remove a note from a SendPulse CRM contact.
>
> #### Input Parameters
>
> **comment\_id** `integer` *required*
>
> ID of the note to remove from the contact.
>
> **contact\_id** `integer` *required*
>
> ID of the contact containing the note.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete CRM Contact Company Relation
>
> **Slug:** `SEND_PULSE_CRM_DELETE_CONTACT_COMPANY_RELATION`
>
> Remove the relation between a SendPulse CRM contact and company.
>
> #### Input Parameters
>
> **company\_id** `integer` *required*
>
> ID of the company to unlink from the contact.
>
> **contact\_id** `integer` *required*
>
> ID of the contact to remove from the company.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete CRM Contact Email
>
> **Slug:** `SEND_PULSE_CRM_DELETE_CONTACT_EMAIL`
>
> Remove an email address from a SendPulse CRM contact.
>
> #### Input Parameters
>
> **email\_id** `integer` *required*
>
> ID of the email address to remove from the contact.
>
> **contact\_id** `integer` *required*
>
> ID of the contact containing the email address.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete CRM Contact Phone
>
> **Slug:** `SEND_PULSE_CRM_DELETE_CONTACT_PHONE`
>
> Remove a phone number from a SendPulse CRM contact.
>
> #### Input Parameters
>
> **phone\_id** `integer` *required*
>
> ID of the phone number to remove from the contact.
>
> **contact\_id** `integer` *required*
>
> ID of the contact containing the phone number.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete CRM Contact Tag
>
> **Slug:** `SEND_PULSE_CRM_DELETE_CONTACT_TAG`
>
> Permanently delete a contact tag from SendPulse CRM.
>
> #### Input Parameters
>
> **tag\_id** `integer` *required*
>
> Tag ID returned by the CRM contact-tag list.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete CRM Contact Tag From Contact
>
> **Slug:** `SEND_PULSE_CRM_DELETE_CONTACT_TAG_FROM_CONTACT`
>
> Remove a tag association from a SendPulse CRM contact.
>
> #### Input Parameters
>
> **tag\_id** `integer` *required*
>
> ID of the tag to remove from the contact.
>
> **contact\_id** `integer` *required*
>
> ID of the contact from which to remove the tag.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete CRM Custom Tab
>
> **Slug:** `SEND_PULSE_CRM_DELETE_CUSTOM_TAB`
>
> Permanently delete a custom tab from SendPulse CRM.
>
> #### Input Parameters
>
> **entity\_id** `integer`
>
> Related entity ID, used only for pipelines and boards.
>
> **entity\_type** `integer ("0" | "1" | "2" | "3")`
>
> Entity type: 0 is contact, 1 is pipeline, 2 is board, and 3 is company.
>
> **custom\_tab\_id** `integer` *required*
>
> Custom tab ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete CRM Custom Tab Relation
>
> **Slug:** `SEND_PULSE_CRM_DELETE_CUSTOM_TAB_RELATION`
>
> Remove attribute relations from a SendPulse CRM custom tab.
>
> #### Input Parameters
>
> **entity\_id** `integer`
>
> Related entity ID, used only for pipelines and boards.
>
> **entity\_ids** `array`
>
> IDs of related attributes to unlink.
>
> **entity\_type** `integer ("0" | "1" | "2" | "3")`
>
> Entity type: 0 is contact, 1 is pipeline, 2 is board, and 3 is company.
>
> **custom\_tab\_id** `integer` *required*
>
> Custom tab ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete CRM Deal
>
> **Slug:** `SEND_PULSE_CRM_DELETE_DEAL`
>
> Permanently delete a deal from SendPulse CRM.
>
> #### Input Parameters
>
> **deal\_id** `integer` *required*
>
> ID of the deal to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete CRM Deal Attribute
>
> **Slug:** `SEND_PULSE_CRM_DELETE_DEAL_ATTRIBUTE`
>
> Remove an attribute from a SendPulse CRM deal.
>
> #### Input Parameters
>
> **deal\_id** `integer` *required*
>
> ID of the deal containing the attribute.
>
> **attribute\_id** `integer` *required*
>
> ID of the attribute to remove from the deal.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete CRM Deal Comment
>
> **Slug:** `SEND_PULSE_CRM_DELETE_DEAL_COMMENT`
>
> Remove a note from a SendPulse CRM deal.
>
> #### Input Parameters
>
> **deal\_id** `integer` *required*
>
> ID of the deal containing the note.
>
> **comment\_id** `integer` *required*
>
> ID of the note to remove from the deal.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Managers From CRM Manager Setting
>
> **Slug:** `SEND_PULSE_CRM_DELETE_MANAGERS_FROM_MANAGER_SETTING`
>
> Remove responsible managers from a SendPulse CRM settings category.
>
> #### Input Parameters
>
> **setting\_id** `integer` *required*
>
> ID of the manager-settings category.
>
> **responsible\_ids** `array`
>
> IDs of responsible managers to remove.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete CRM Pipeline Attribute
>
> **Slug:** `SEND_PULSE_CRM_DELETE_PIPELINE_ATTRIBUTE`
>
> Delete a deal attribute from a SendPulse CRM pipeline.
>
> #### Input Parameters
>
> **pipeline\_id** `integer` *required*
>
> ID of the pipeline containing the deal attribute.
>
> **attribute\_id** `integer` *required*
>
> ID of the deal attribute to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete CRM Pipeline Step
>
> **Slug:** `SEND_PULSE_CRM_DELETE_PIPELINE_STEP`
>
> Delete a step from a SendPulse CRM pipeline.
>
> #### Input Parameters
>
> **step\_id** `integer` *required*
>
> ID of the pipeline step to delete.
>
> **pipeline\_id** `integer` *required*
>
> ID of the pipeline containing the step.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete CRM Product
>
> **Slug:** `SEND_PULSE_CRM_DELETE_PRODUCT`
>
> Delete a SendPulse CRM product by ID.
>
> #### Input Parameters
>
> **product\_id** `integer` *required*
>
> ID of the product to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete CRM Product Category
>
> **Slug:** `SEND_PULSE_CRM_DELETE_PRODUCT_CATEGORY`
>
> Delete a SendPulse CRM product category by ID.
>
> #### Input Parameters
>
> **category\_id** `integer` *required*
>
> ID of the product category to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete CRM Product Section
>
> **Slug:** `SEND_PULSE_CRM_DELETE_PRODUCT_SECTION`
>
> Delete a section from a SendPulse CRM product.
>
> #### Input Parameters
>
> **product\_id** `integer` *required*
>
> ID of the product containing the section.
>
> **section\_id** `integer` *required*
>
> ID of the product section to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete CRM Task
>
> **Slug:** `SEND_PULSE_CRM_DELETE_TASK`
>
> Delete a SendPulse CRM task by ID.
>
> #### Input Parameters
>
> **task\_id** `integer` *required*
>
> ID of the task to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete CRM Task Checklist
>
> **Slug:** `SEND_PULSE_CRM_DELETE_TASK_CHECKLIST`
>
> Delete a checklist from a SendPulse CRM task.
>
> #### Input Parameters
>
> **task\_id** `integer` *required*
>
> ID of the task containing the checklist.
>
> **checklist\_id** `integer` *required*
>
> ID of the checklist to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete CRM Task Tag
>
> **Slug:** `SEND_PULSE_CRM_DELETE_TASK_TAG`
>
> Delete a SendPulse CRM task tag by ID.
>
> #### Input Parameters
>
> **tag\_id** `integer` *required*
>
> ID of the task tag to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Detach CRM Contact From Task
>
> **Slug:** `SEND_PULSE_CRM_DETACH_CONTACT_FROM_TASK`
>
> Detach a contact from a SendPulse CRM task.
>
> #### Input Parameters
>
> **task\_id** `integer` *required*
>
> ID of the task from which to detach the contact.
>
> **contact\_id** `integer` *required*
>
> ID of the contact to detach.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Detach CRM Deal From Task
>
> **Slug:** `SEND_PULSE_CRM_DETACH_DEAL_FROM_TASK`
>
> Detach a deal from a SendPulse CRM task.
>
> #### Input Parameters
>
> **deal\_id** `integer` *required*
>
> ID of the deal to detach.
>
> **task\_id** `integer` *required*
>
> ID of the task from which to detach the deal.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Detach CRM Product From Deal
>
> **Slug:** `SEND_PULSE_CRM_DETACH_PRODUCT_FROM_DEAL`
>
> Detach a SendPulse CRM product from a deal.
>
> #### Input Parameters
>
> **head\_id** `integer` *required*
>
> ID of the deal from which to detach the product.
>
> **product\_id** `integer` *required*
>
> ID of the product to detach.
>
> **category\_id** `integer` *required*
>
> ID of the category containing the product.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Detach CRM Tag From Task
>
> **Slug:** `SEND_PULSE_CRM_DETACH_TAG_FROM_TASK`
>
> Detach a tag from a SendPulse CRM task.
>
> #### Input Parameters
>
> **tag\_id** `integer` *required*
>
> ID of the tag to detach.
>
> **task\_id** `integer` *required*
>
> ID of the task from which to detach the tag.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Detach CRM Task From Task
>
> **Slug:** `SEND_PULSE_CRM_DETACH_TASK_FROM_TASK`
>
> Detach a child task from another SendPulse CRM task.
>
> #### Input Parameters
>
> **task\_id** `integer` *required*
>
> ID of the child task to detach.
>
> **task\_head\_id** `integer` *required*
>
> ID of the parent task.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get All CRM Payments
>
> **Slug:** `SEND_PULSE_CRM_GET_ALL_PAYMENTS`
>
> Retrieve payments belonging to the connected SendPulse account.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get CRM Board Attributes
>
> **Slug:** `SEND_PULSE_CRM_GET_BOARD_ATTRIBUTES`
>
> Get attributes configured for a SendPulse CRM task board.
>
> #### Input Parameters
>
> **board\_id** `integer` *required*
>
> ID of the CRM task board whose attributes to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get CRM Board By ID
>
> **Slug:** `SEND_PULSE_CRM_GET_BOARD_BY_ID`
>
> Get one SendPulse CRM task board by ID.
>
> #### Input Parameters
>
> **board\_id** `integer` *required*
>
> ID of the CRM task board to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get CRM Boards
>
> **Slug:** `SEND_PULSE_CRM_GET_BOARDS`
>
> Retrieve SendPulse CRM task boards. The response schema represents data as a single board object, not a list.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get CRM Category Product
>
> **Slug:** `SEND_PULSE_CRM_GET_CATEGORY_PRODUCT`
>
> Retrieve full CRM product details in a specific category context.
>
> #### Input Parameters
>
> **productId** `integer` *required*
>
> Product ID to retrieve.
>
> **categoryId** `integer` *required*
>
> Category ID containing the product.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get CRM Companies List
>
> **Slug:** `SEND_PULSE_CRM_GET_COMPANIES_LIST`
>
> Retrieve CRM companies using structured filters, sorting, limit, and offset.
>
> #### Input Parameters
>
> **email** `string`
>
> Company email filter.
>
> **limit** `integer`
>
> Maximum companies to return.
>
> **phone** `string`
>
> Company phone filter.
>
> **dateTo** `string`
>
> End of the company date range.
>
> **offset** `integer`
>
> Number of matching companies to skip.
>
> **sortBy** `object`
>
> Company sorting configuration.
>
> **dateFrom** `string`
>
> Beginning of the company date range.
>
> **attributes** `array`
>
> Custom attribute filters.
>
> **companyIds** `array`
>
> Company IDs to include.
>
> **companyName** `string`
>
> Company name filter.
>
> **searchString** `string`
>
> Global search string; when supplied, SendPulse ignores all other filters.
>
> **responsibleId** `array`
>
> Responsible user IDs to include.
>
> **messengerLogin** `string`
>
> Messenger login filter.
>
> **withoutContacts** `boolean`
>
> Provider company contact-state filter.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get CRM Companies Short Data
>
> **Slug:** `SEND_PULSE_CRM_GET_COMPANIES_SHORT_DATA`
>
> Retrieve lightweight CRM company records using structured filters and sorting.
>
> #### Input Parameters
>
> **email** `string`
>
> Company email filter.
>
> **limit** `integer`
>
> Maximum companies to return.
>
> **phone** `string`
>
> Company phone filter.
>
> **dateTo** `string`
>
> End of the company date range.
>
> **offset** `integer`
>
> Number of matching companies to skip.
>
> **sortBy** `object`
>
> Company sorting configuration.
>
> **dateFrom** `string`
>
> Beginning of the company date range.
>
> **attributes** `array`
>
> Custom attribute filters.
>
> **companyIds** `array`
>
> Company IDs to include.
>
> **companyName** `string`
>
> Company name filter.
>
> **searchString** `string`
>
> Global search string; when supplied, SendPulse ignores all other filters.
>
> **responsibleId** `array`
>
> Responsible user IDs to include.
>
> **messengerLogin** `string`
>
> Messenger login filter.
>
> **withoutContacts** `boolean`
>
> Provider company contact-state filter.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get CRM Company Attributes
>
> **Slug:** `SEND_PULSE_CRM_GET_COMPANY_ATTRIBUTES`
>
> Get the SendPulse CRM company attribute list.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get CRM Company By ID
>
> **Slug:** `SEND_PULSE_CRM_GET_COMPANY_BY_ID`
>
> Get one SendPulse CRM company by ID.
>
> #### Input Parameters
>
> **company\_id** `integer` *required*
>
> ID of the CRM company to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get CRM Company Emails
>
> **Slug:** `SEND_PULSE_CRM_GET_COMPANY_EMAILS`
>
> Get email addresses associated with a SendPulse CRM company.
>
> #### Input Parameters
>
> **company\_id** `integer` *required*
>
> ID of the CRM company whose emails to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get CRM Company History
>
> **Slug:** `SEND_PULSE_CRM_GET_COMPANY_HISTORY`
>
> Get one page of SendPulse CRM company history with a continuation cursor.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Number of history records requested per page.
>
> **cursor** `string`
>
> Continuation cursor returned by a previous call.
>
> **offset** `integer`
>
> Zero-based history record offset for the first page.
>
> **date\_to** `string`
>
> End date-time for the history range, for example 2024-11-01 12:12:12+00:00.
>
> **date\_from** `string`
>
> Start date-time for the history range, for example 2024-11-01 12:12:12+00:00.
>
> **company\_id** `integer` *required*
>
> ID of the CRM company whose history to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get CRM Company Messengers
>
> **Slug:** `SEND_PULSE_CRM_GET_COMPANY_MESSENGERS`
>
> Get messenger accounts associated with a SendPulse CRM company.
>
> #### Input Parameters
>
> **company\_id** `integer` *required*
>
> ID of the CRM company whose messengers to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get CRM Company Phones
>
> **Slug:** `SEND_PULSE_CRM_GET_COMPANY_PHONES`
>
> Get phone numbers associated with a SendPulse CRM company.
>
> #### Input Parameters
>
> **company\_id** `integer` *required*
>
> ID of the CRM company whose phones to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get CRM Contact Attributes
>
> **Slug:** `SEND_PULSE_CRM_GET_CONTACT_ATTRIBUTES`
>
> Get the SendPulse CRM contact attribute list.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get CRM Contact Attribute Values
>
> **Slug:** `SEND_PULSE_CRM_GET_CONTACT_ATTRIBUTE_VALUES`
>
> Retrieve the configured attribute values for a CRM contact.
>
> #### Input Parameters
>
> **contactId** `integer` *required*
>
> Contact ID returned by SendPulse CRM.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get CRM Contact by External ID
>
> **Slug:** `SEND_PULSE_CRM_GET_CONTACT_BY_EXTERNAL_ID`
>
> Look up a CRM contact by an external system contact ID.
>
> #### Input Parameters
>
> **externalContactId** `integer` *required*
>
> External contact ID from another source system.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get CRM Contact by ID
>
> **Slug:** `SEND_PULSE_CRM_GET_CONTACT_BY_ID`
>
> Retrieve identity, ownership, channels, and related data for a CRM contact.
>
> #### Input Parameters
>
> **contactId** `integer` *required*
>
> Contact ID returned by SendPulse CRM.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get CRM Contact by Messenger External ID
>
> **Slug:** `SEND_PULSE_CRM_GET_CONTACT_BY_MESSENGER_EXTERNAL_ID`
>
> Look up a CRM contact by its external messenger contact ID.
>
> #### Input Parameters
>
> **messengerContactId** `string` *required*
>
> External contact ID from a connected messenger.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Contact Calls
>
> **Slug:** `SEND_PULSE_CRM_GET_CONTACT_CALLS`
>
> List telephony calls associated with a SendPulse CRM contact.
>
> #### Input Parameters
>
> **to** `string`
>
> End date and time.
>
> **from\_** `string`
>
> Start date and time.
>
> **state** `integer ("1" | "2" | "3")`
>
> Call state: 1 pending, 2 successful, or 3 failed.
>
> **call\_type** `integer ("0" | "1")`
>
> Call type: 0 incoming or 1 outgoing.
>
> **contact\_id** `integer` *required*
>
> Contact ID.
>
> **contact\_email** `string`
>
> Contact email filter.
>
> **contact\_phone** `string`
>
> Contact phone filter.
>
> **responsible\_ids** `array`
>
> Responsible user IDs.
>
> **contact\_last\_name** `string`
>
> Contact last-name filter.
>
> **contact\_first\_name** `string`
>
> Contact first-name filter.
>
> **integration\_group\_id** `integer`
>
> Integration group ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get CRM Contact Deals
>
> **Slug:** `SEND_PULSE_CRM_GET_CONTACT_DEALS`
>
> Retrieve all CRM deals associated with a contact.
>
> #### Input Parameters
>
> **contactId** `integer` *required*
>
> Contact ID returned by SendPulse CRM.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get CRM Contact EDU Payments
>
> **Slug:** `SEND_PULSE_CRM_GET_CONTACT_EDU_PAYMENTS`
>
> Retrieve EDU course payment history for a CRM contact.
>
> #### Input Parameters
>
> **contactId** `integer` *required*
>
> Contact ID returned by SendPulse CRM.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get CRM Contact EDU Statistics
>
> **Slug:** `SEND_PULSE_CRM_GET_CONTACT_EDU_STATISTIC`
>
> Retrieve course, lesson, and test progress for a CRM contact.
>
> #### Input Parameters
>
> **contactId** `integer` *required*
>
> Contact ID returned by SendPulse CRM.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get CRM Contact History
>
> **Slug:** `SEND_PULSE_CRM_GET_CONTACT_HISTORY`
>
> Retrieve a CRM contact's activity history within a required date range.
>
> #### Input Parameters
>
> **to\_date** `string` *required*
>
> Inclusive range end as a date-time, for example 2024-12-13 12:12:12+00:00.
>
> **from\_date** `string` *required*
>
> Inclusive range start as a date-time, for example 2024-12-12 12:12:12+00:00.
>
> **contact\_id** `integer` *required*
>
> Contact ID returned by SendPulse CRM.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Contact List by Email
>
> **Slug:** `SEND_PULSE_CRM_GET_CONTACT_LIST_BY_EMAIL`
>
> Find SendPulse CRM contacts by full or partial email address.
>
> #### Input Parameters
>
> **email** `string`
>
> Contact email to search for.
>
> **isEmailFullSearch** `boolean`
>
> Whether the email must match completely.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Contacts List
>
> **Slug:** `SEND_PULSE_CRM_GET_CONTACTS_LIST`
>
> Search and list SendPulse CRM contacts.
>
> #### Input Parameters
>
> **to** `string`
>
> Creation end date in YYYY-MM-DD.
>
> **ids** `array`
>
> Contact IDs.
>
> **email** `string`
>
> Email filter.
>
> **from\_** `string`
>
> Creation start date in YYYY-MM-DD.
>
> **limit** `integer`
>
> Records to return.
>
> **phone** `string`
>
> Phone filter.
>
> **offset** `integer`
>
> Records to skip.
>
> **sortBy** `object`
>
> Sort configuration.
>
> **tagIds** `array`
>
> Contact tag IDs.
>
> **lastName** `string`
>
> Last-name filter.
>
> **location** `string`
>
> Location filter.
>
> **updateTo** `string`
>
> Update end date in YYYY-MM-DD.
>
> **firstName** `string`
>
> First-name filter.
>
> **attributes** `array`
>
> Attribute filters.
>
> **sourceType** `array`
>
> Source type codes.
>
> **updateFrom** `string`
>
> Update start date in YYYY-MM-DD.
>
> **messengerLogin** `string`
>
> Messenger login filter.
>
> **responsibleIds** `array`
>
> Responsible user IDs.
>
> **messengerTypeIds** `array`
>
> Messenger type IDs.
>
> **fieldValueConditions** `array`
>
> Field-value conditions.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get CRM Custom Tabs
>
> **Slug:** `SEND_PULSE_CRM_GET_CUSTOM_TABS`
>
> Retrieve custom CRM tab definitions grouped by entity type.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get CRM Deal
>
> **Slug:** `SEND_PULSE_CRM_GET_DEAL`
>
> Retrieve details for a CRM deal by ID.
>
> #### Input Parameters
>
> **dealId** `integer` *required*
>
> Deal ID returned by SendPulse CRM.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get CRM Deal Attribute Values
>
> **Slug:** `SEND_PULSE_CRM_GET_DEAL_ATTRIBUTE_VALUES`
>
> Retrieve configured attribute values for a CRM deal.
>
> #### Input Parameters
>
> **dealId** `integer` *required*
>
> Deal ID returned by SendPulse CRM.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get calls by deal
>
> **Slug:** `SEND_PULSE_CRM_GET_DEAL_CALLS`
>
> List telephony calls associated with a SendPulse CRM deal.
>
> #### Input Parameters
>
> **dealId** `integer` *required*
>
> SendPulse dealId parameter.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get CRM Deal Notes
>
> **Slug:** `SEND_PULSE_CRM_GET_DEAL_COMMENTS`
>
> Retrieve notes and their attachments for a CRM deal.
>
> #### Input Parameters
>
> **dealId** `integer` *required*
>
> Deal ID returned by SendPulse CRM.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get CRM Deal Contacts
>
> **Slug:** `SEND_PULSE_CRM_GET_DEAL_CONTACTS`
>
> Retrieve contacts associated with a CRM deal.
>
> #### Input Parameters
>
> **dealId** `integer` *required*
>
> Deal ID returned by SendPulse CRM.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get CRM Deal History
>
> **Slug:** `SEND_PULSE_CRM_GET_DEAL_HISTORY`
>
> Retrieve a CRM deal's history within a required date range.
>
> #### Input Parameters
>
> **deal\_id** `integer` *required*
>
> Deal ID returned by SendPulse CRM.
>
> **to\_date** `string` *required*
>
> Inclusive history range end as a date-time.
>
> **from\_date** `string` *required*
>
> Inclusive history range start as a date-time.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get CRM Deal Payments
>
> **Slug:** `SEND_PULSE_CRM_GET_DEAL_PAYMENTS`
>
> Retrieve payments associated with a CRM deal.
>
> #### Input Parameters
>
> **dealId** `integer` *required*
>
> Deal ID returned by SendPulse CRM.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Deals List
>
> **Slug:** `SEND_PULSE_CRM_GET_DEALS_LIST`
>
> Search and list SendPulse CRM deals.
>
> #### Input Parameters
>
> **name** `string`
>
> Deal name filter.
>
> **email** `string`
>
> Associated contact email.
>
> **limit** `integer`
>
> Records to return.
>
> **phone** `string`
>
> Associated contact phone.
>
> **filter** `array`
>
> Deal-field filters.
>
> **offset** `integer`
>
> Records to skip.
>
> **sortBy** `object`
>
> Sort configuration.
>
> **lastName** `string`
>
> Associated contact last name.
>
> **firstName** `string`
>
> Associated contact first name.
>
> **unlimited** `boolean`
>
> Return all active deals without a limit.
>
> **attributes** `array`
>
> Attribute filters.
>
> **expiration** `integer`
>
> Expiration filter code from 1 through 5.
>
> **pipelineIds** `array`
>
> Pipeline IDs.
>
> **completionDateTo** `string`
>
> Completion end date.
>
> **completionDateFrom** `string`
>
> Completion start date.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get CRM Managers by Section
>
> **Slug:** `SEND_PULSE_CRM_GET_MANAGERS_BY_SECTION`
>
> Retrieve managers assigned to a CRM manager settings section.
>
> #### Input Parameters
>
> **sectionId** `integer` *required*
>
> CRM manager settings section ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get CRM Manager Settings Managers
>
> **Slug:** `SEND_PULSE_CRM_GET_MANAGER_SETTINGS_MANAGERS`
>
> Retrieve all managers available in CRM manager settings.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get CRM Messenger Types
>
> **Slug:** `SEND_PULSE_CRM_GET_MESSENGER_TYPES`
>
> Retrieve messenger types supported by SendPulse CRM.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get CRM Payments by Contact ID
>
> **Slug:** `SEND_PULSE_CRM_GET_PAYMENTS_BY_CONTACT_ID`
>
> Retrieve payments associated with a CRM contact.
>
> #### Input Parameters
>
> **contactId** `integer` *required*
>
> Contact ID returned by SendPulse CRM.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get CRM Pipeline by ID
>
> **Slug:** `SEND_PULSE_CRM_GET_PIPELINE_BY_ID`
>
> Retrieve a CRM pipeline, including its steps and settings, by ID.
>
> #### Input Parameters
>
> **pipelineId** `integer` *required*
>
> Pipeline ID returned by SendPulse CRM.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get CRM Pipeline Steps
>
> **Slug:** `SEND_PULSE_CRM_GET_PIPELINE_STEPS`
>
> Retrieve steps configured for a CRM pipeline.
>
> #### Input Parameters
>
> **pipelineId** `integer` *required*
>
> Pipeline ID returned by SendPulse CRM.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get CRM Product by ID
>
> **Slug:** `SEND_PULSE_CRM_GET_PRODUCT_BY_ID`
>
> Retrieve the complete CRM product record by ID.
>
> #### Input Parameters
>
> **productId** `integer` *required*
>
> Product ID to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get CRM Product Categories
>
> **Slug:** `SEND_PULSE_CRM_GET_PRODUCT_CATEGORIES`
>
> Retrieve the complete hierarchical CRM product category tree.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get CRM Products by Contact Deals
>
> **Slug:** `SEND_PULSE_CRM_GET_PRODUCTS_BY_CONTACT_DEALS`
>
> Retrieve products associated with CRM deals linked to a contact.
>
> #### Input Parameters
>
> **contactId** `integer` *required*
>
> CRM contact ID whose deal products to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get CRM Products by Deal ID
>
> **Slug:** `SEND_PULSE_CRM_GET_PRODUCTS_BY_DEAL_ID`
>
> Retrieve products, quantities, and pricing attached to a CRM deal.
>
> #### Input Parameters
>
> **dealId** `integer` *required*
>
> CRM deal ID whose products to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get products by filter
>
> **Slug:** `SEND_PULSE_CRM_GET_PRODUCTS_BY_FILTER`
>
> Search SendPulse CRM products by category, price, stock, visibility, or text filters.
>
> #### Input Parameters
>
> **limit** `number`
>
> Maximum number of results to return.
>
> **price** `object`
>
> Filter by product price or old price.
>
> **dateTo** `string`
>
> End date for filtering (format: YYYY-MM-DD).
>
> **offset** `number`
>
> Offset for pagination.
>
> **search** `string`
>
> Text search by product name or code.
>
> **balance** `object`
>
> Filter by product stock balance and unit type.
>
> **orderBy** `object`
>
> Sorting options.
>
> **visible** `integer ("0" | "1")`
>
> Product visibility status (0 = hidden, 1 = visible).
>
> **dateFrom** `string`
>
> Start date for filtering (format: YYYY-MM-DD).
>
> **sections** `array`
>
> Filter by section-specific key-value attributes.
>
> **purchases** `object`
>
> Filter by number of purchases.
>
> **categoryId** `number`
>
> Category ID to filter products.
>
> **categoryIds** `array`
>
> List of category IDs to include in filter.
>
> **description** `string`
>
> Description for products
>
> **typeProduct** `integer ("1" | "2")`
>
> Product type (1 = physical, 2 = digital/service).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get CRM Task by ID
>
> **Slug:** `SEND_PULSE_CRM_GET_TASK_BY_ID`
>
> Retrieve the complete state of a CRM task by ID.
>
> #### Input Parameters
>
> **taskId** `integer` *required*
>
> CRM task ID to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get CRM Task Checklists
>
> **Slug:** `SEND_PULSE_CRM_GET_TASK_CHECKLISTS`
>
> Retrieve checklist data for a CRM task. The response is modeled as a single checklist with a single item.
>
> #### Input Parameters
>
> **taskId** `integer` *required*
>
> CRM task ID whose checklists to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get CRM Task History
>
> **Slug:** `SEND_PULSE_CRM_GET_TASK_HISTORY`
>
> Retrieve a CRM task audit trail within a required date-time range.
>
> #### Input Parameters
>
> **taskId** `integer` *required*
>
> CRM task ID whose history to retrieve.
>
> **toDate** `string` *required*
>
> End of the history window as an ISO 8601 date-time.
>
> **fromDate** `string` *required*
>
> Start of the history window as an ISO 8601 date-time.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get CRM Task Repeat Templates
>
> **Slug:** `SEND_PULSE_CRM_GET_TASK_REPEAT_TEMPLATES`
>
> Retrieve predefined templates for recurring CRM tasks.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get CRM Task Tags
>
> **Slug:** `SEND_PULSE_CRM_GET_TASK_TAGS`
>
> Retrieve all tags available for CRM tasks.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get calls
>
> **Slug:** `SEND_PULSE_CRM_GET_TELEPHONY_CALLS`
>
> Search SendPulse CRM telephony calls by date, direction, state, or assignee.
>
> #### Input Parameters
>
> **to** `string`
>
> End of the call date range in ISO 8601 date-time format.
>
> **from\_** `string`
>
> Start of the call date range in ISO 8601 date-time format.
>
> **state** `integer`
>
> Call state: 1 pending, 2 successful, or 3 failed.
>
> **callType** `integer`
>
> Call type: 0 incoming or 1 outgoing.
>
> **contactEmail** `string`
>
> Filter by contact email address.
>
> **contactPhone** `string`
>
> Filter by contact phone number.
>
> **responsibleIds** `array`
>
> CRM user IDs responsible for the calls.
>
> **contactLastName** `string`
>
> Filter by contact last name.
>
> **contactFirstName** `string`
>
> Filter by contact first name.
>
> **integrationGroupId** `integer`
>
> Telephony integration group ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get CRM Users
>
> **Slug:** `SEND_PULSE_CRM_GET_USERS`
>
> Retrieve active confirmed team members available for CRM assignments.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List CRM Contact Tags
>
> **Slug:** `SEND_PULSE_CRM_LIST_CONTACT_TAGS`
>
> Get SendPulse CRM contact tags with optional exact or partial name filters.
>
> #### Input Parameters
>
> **name** `string`
>
> Exact tag name to match.
>
> **search** `string`
>
> Text to find within tag names using a partial match.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List CRM Deal Attributes by Pipeline
>
> **Slug:** `SEND_PULSE_CRM_LIST_DEAL_ATTRIBUTES_BY_PIPELINE`
>
> List deal attribute definitions for a CRM pipeline.
>
> #### Input Parameters
>
> **pipelineId** `integer` *required*
>
> Pipeline ID returned by SendPulse CRM.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List CRM Manager Settings Sections
>
> **Slug:** `SEND_PULSE_CRM_LIST_MANAGER_SETTINGS_SECTIONS`
>
> Retrieve all sections configured in CRM manager settings.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List CRM Pipeline Attributes
>
> **Slug:** `SEND_PULSE_CRM_LIST_PIPELINE_ATTRIBUTES`
>
> Retrieve deal attribute definitions configured for a CRM pipeline.
>
> #### Input Parameters
>
> **pipelineId** `integer` *required*
>
> Pipeline ID returned by SendPulse CRM.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get tasks
>
> **Slug:** `SEND_PULSE_CRM_LIST_TASKS`
>
> Retrieves a list of tasks based on selected filters
>
> #### Input Parameters
>
> **name** `string`
>
> Name value documented by SendPulse.
>
> **sort** `object`
>
> Sort value documented by SendPulse.
>
> **tags** `array`
>
> IDs of tags
>
> **type** `integer ("1" | "2" | "3")`
>
> Type value documented by SendPulse.
>
> **status** `integer ("1" | "2")`
>
> Status value documented by SendPulse.
>
> **stepId** `array`
>
> Array of step IDs
>
> **boardId** `integer`
>
> BoardId value documented by SendPulse.
>
> **contacts** `string`
>
> Contacts value documented by SendPulse.
>
> **dealName** `string`
>
> DealName value documented by SendPulse.
>
> **parentId** `array`
>
> Array of parent task IDs
>
> **priority** `integer`
>
> Priority value documented by SendPulse.
>
> **tagMatch** `string ("any" | "all")`
>
> Filter by tags (all - all tags, any - any tag). Default: any
>
> **endedAtTo** `string`
>
> EndedAtTo value documented by SendPulse.
>
> **observers** `array`
>
> Array of users IDs acting as observers
>
> **startAtTo** `string`
>
> StartAtTo value documented by SendPulse.
>
> **attributes** `array`
>
> Attributes value documented by SendPulse.
>
> **finishAtTo** `string`
>
> FinishAtTo value documented by SendPulse.
>
> **createdAtTo** `string`
>
> CreatedAtTo value documented by SendPulse.
>
> **endedAtFrom** `string`
>
> EndedAtFrom value documented by SendPulse.
>
> **startAtFrom** `string`
>
> StartAtFrom value documented by SendPulse.
>
> **updatedAtTo** `string`
>
> UpdatedAtTo value documented by SendPulse.
>
> **finishAtFrom** `string`
>
> FinishAtFrom value documented by SendPulse.
>
> **createdAtFrom** `string`
>
> CreatedAtFrom value documented by SendPulse.
>
> **responsibleId** `array`
>
> Array of responsible users IDs
>
> **updatedAtFrom** `string`
>
> UpdatedAtFrom value documented by SendPulse.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Remove CRM Contact Messenger
>
> **Slug:** `SEND_PULSE_CRM_REMOVE_CONTACT_MESSENGER`
>
> Remove a messenger from a SendPulse CRM contact.
>
> #### Input Parameters
>
> **contact\_id** `integer` *required*
>
> ID of the contact containing the messenger.
>
> **messenger\_id** `integer` *required*
>
> ID of the messenger to remove from the contact.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Remove CRM Deal Contact
>
> **Slug:** `SEND_PULSE_CRM_REMOVE_DEAL_CONTACT`
>
> Remove a contact association from a SendPulse CRM deal.
>
> #### Input Parameters
>
> **deal\_id** `integer` *required*
>
> ID of the deal from which to remove the contact.
>
> **contact\_id** `integer` *required*
>
> ID of the contact to remove from the deal.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Remove CRM Deal Expiration
>
> **Slug:** `SEND_PULSE_CRM_REMOVE_DEAL_EXPIRATION`
>
> Remove the expiration setting from a SendPulse CRM deal.
>
> #### Input Parameters
>
> **deal\_id** `integer` *required*
>
> Deal ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Reorder CRM Checklist Item
>
> **Slug:** `SEND_PULSE_CRM_REORDER_CHECKLIST_ITEM`
>
> Change the position of an item within a CRM task checklist.
>
> #### Input Parameters
>
> **order** `number`
>
> New item position in the checklist.
>
> **itemId** `integer` *required*
>
> Checklist item ID to reorder.
>
> **checklistId** `integer` *required*
>
> Checklist ID containing the item.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Set/unset the parent task
>
> **Slug:** `SEND_PULSE_CRM_SET_TASK_PARENT`
>
> Set or clear the parent relationship for a SendPulse CRM task.
>
> #### Input Parameters
>
> **taskId** `integer` *required*
>
> SendPulse taskId parameter.
>
> **parentId** `number`
>
> Parent task ID or null
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update file attachment
>
> **Slug:** `SEND_PULSE_CRM_UPDATE_ATTACHMENT`
>
> Update a SendPulse CRM attachment's file link using a file previously uploaded to the SendPulse file manager.
>
> #### Input Parameters
>
> **link** `string`
>
> Path of a file previously uploaded to the SendPulse file manager.
>
> **attachmentId** `integer` *required*
>
> SendPulse attachmentId parameter.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update board by ID
>
> **Slug:** `SEND_PULSE_CRM_UPDATE_BOARD`
>
> Update the name and settings of a SendPulse CRM task board by ID.
>
> #### Input Parameters
>
> **name** `string`
>
> Name value documented by SendPulse.
>
> **boardId** `integer` *required*
>
> SendPulse boardId parameter.
>
> **settings** `array`
>
> Settings value documented by SendPulse.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update attribute for board
>
> **Slug:** `SEND_PULSE_CRM_UPDATE_BOARD_ATTRIBUTE`
>
> Update a custom attribute configured on a SendPulse CRM task board.
>
> #### Input Parameters
>
> **name** `string`
>
> Attribute name
>
> **type** `number`
>
> Attribute type: 0 -string 1 - number 2 - date 3 - link 4 - list 5 - multiList
>
> **order** `integer`
>
> Attribute order
>
> **status** `integer`
>
> Status value documented by SendPulse.
>
> **boardId** `integer` *required*
>
> SendPulse boardId parameter.
>
> **options** `array`
>
> Attribute options (only for "list" and "multiList" types
>
> **mandatory** `boolean`
>
> Is attribute required
>
> **attributeId** `integer` *required*
>
> SendPulse attributeId parameter.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update steps for board
>
> **Slug:** `SEND_PULSE_CRM_UPDATE_BOARD_STEP`
>
> Update a SendPulse CRM task-board step name, color, or display order.
>
> #### Input Parameters
>
> **name** `string`
>
> Step name
>
> **color** `string`
>
> Step color
>
> **order** `integer`
>
> Step order
>
> **stepId** `integer` *required*
>
> SendPulse stepId parameter.
>
> **boardId** `integer` *required*
>
> SendPulse boardId parameter.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update checklist item
>
> **Slug:** `SEND_PULSE_CRM_UPDATE_CHECKLIST_ITEM`
>
> Update the text or completion state of a SendPulse CRM checklist item.
>
> #### Input Parameters
>
> **name** `string`
>
> Checklist item name
>
> **isDone** `number`
>
> Is checklist item done (checked). 0 - no, 1 - yes
>
> **itemId** `integer` *required*
>
> SendPulse itemId parameter.
>
> **checklistId** `integer` *required*
>
> SendPulse checklistId parameter.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update company
>
> **Slug:** `SEND_PULSE_CRM_UPDATE_COMPANY`
>
> Update a SendPulse CRM company's name, responsible user, annual business volume, or currency.
>
> #### Input Parameters
>
> **currency** `string`
>
> Currency value documented by SendPulse.
>
> **companyId** `integer` *required*
>
> SendPulse companyId parameter.
>
> **companyName** `string`
>
> Company name.
>
> **responsibleId** `integer`
>
> ResponsibleId value documented by SendPulse.
>
> **annualBusinessVolume** `integer`
>
> AnnualBusinessVolume value documented by SendPulse.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update a company attribute
>
> **Slug:** `SEND_PULSE_CRM_UPDATE_COMPANY_ATTRIBUTE`
>
> Update a company attribute
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Name value documented by SendPulse.
>
> **type** `integer`
>
> 0 = Text, 1 = Number, 2 = Date, 3 = Link, 4 = Select, 5 = MultiSelect
>
> **order** `integer` *required*
>
> Order value documented by SendPulse.
>
> **status** `integer`
>
> 0 = Inactive, 1 = Active, 2 = Hidden
>
> **options** `array`
>
> Options value documented by SendPulse.
>
> **mandatory** `boolean`
>
> Mandatory value documented by SendPulse.
>
> **attributeId** `integer` *required*
>
> Company attribute ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update email
>
> **Slug:** `SEND_PULSE_CRM_UPDATE_COMPANY_EMAIL`
>
> Replace an email address associated with a SendPulse CRM company.
>
> #### Input Parameters
>
> **data** `object`
>
> Data value documented by SendPulse.
>
> **emailId** `integer` *required*
>
> SendPulse emailId parameter.
>
> **companyId** `integer` *required*
>
> SendPulse companyId parameter.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update messenger
>
> **Slug:** `SEND_PULSE_CRM_UPDATE_COMPANY_MESSENGER`
>
> Update a messenger account associated with a SendPulse CRM company.
>
> #### Input Parameters
>
> **data** `object`
>
> Data value documented by SendPulse.
>
> **entityId** `integer` *required*
>
> Company ID.
>
> **entityType** `string` *required*
>
> SendPulse entityType parameter.
>
> **messengerId** `integer` *required*
>
> SendPulse messengerId parameter.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update phone
>
> **Slug:** `SEND_PULSE_CRM_UPDATE_COMPANY_PHONE`
>
> Replace a phone number associated with a SendPulse CRM company.
>
> #### Input Parameters
>
> **data** `object`
>
> Data value documented by SendPulse.
>
> **phoneId** `integer` *required*
>
> SendPulse phoneId parameter.
>
> **entityId** `integer` *required*
>
> Company ID.
>
> **entityType** `string` *required*
>
> SendPulse entityType parameter.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update information about the contact
>
> **Slug:** `SEND_PULSE_CRM_UPDATE_CONTACT`
>
> Update the name or responsible team member of a SendPulse CRM contact.
>
> #### Input Parameters
>
> **lastName** `string`
>
> Contact last name
>
> **contactId** `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
>
> **firstName** `string`
>
> Contact first name
>
> **responsibleId** `integer` *required*
>
> Team member ID to assign to a contact. It can be obtained with the "Get a list of team members" method
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update a contact attribute
>
> **Slug:** `SEND_PULSE_CRM_UPDATE_CONTACT_ATTRIBUTE`
>
> Update a contact attribute
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Name value documented by SendPulse.
>
> **type** `integer`
>
> 0 = Text, 1 = Number, 2 = Date, 3 = Link, 4 = Select, 5 = MultiSelect
>
> **order** `integer` *required*
>
> Order value documented by SendPulse.
>
> **status** `integer`
>
> 0 = Inactive, 1 = Active, 2 = Hidden
>
> **options** `array`
>
> Options value documented by SendPulse.
>
> **mandatory** `boolean`
>
> Mandatory value documented by SendPulse.
>
> **attributeId** `integer` *required*
>
> SendPulse attributeId parameter.
>
> **contactCardShow** `boolean`
>
> ContactCardShow value documented by SendPulse.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update contact attribute value
>
> **Slug:** `SEND_PULSE_CRM_UPDATE_CONTACT_ATTRIBUTE_VALUE`
>
> Updates the attribute for the specified contact. Provided property values will be overwritten.
>
> #### Input Parameters
>
> **value** `string` *required*
>
> New attribute value. The maximum number of characters is 5500
>
> **contactId** `integer` *required*
>
> Contact ID for which you want to update the field. It can be obtained with the "Get a list of contacts" method
>
> **attributeId** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update contact note
>
> **Slug:** `SEND_PULSE_CRM_UPDATE_CONTACT_COMMENT`
>
> Updates the note of the specified contact. Provided property values will be overwritten.
>
> #### Input Parameters
>
> **message** `string` *required*
>
> New note message. The maximum number of characters is 65,535
>
> **commentId** `integer` *required*
>
> Note ID you want to update. It can be obtained with the "Get a list of contacts" method
>
> **contactId** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update the email address of the contact
>
> **Slug:** `SEND_PULSE_CRM_UPDATE_CONTACT_EMAIL`
>
> Updates the email address of the specified contact
>
> #### Input Parameters
>
> **email** `string` *required*
>
> New email address
>
> **emailId** `integer` *required*
>
> Email address ID you want to update. It can be obtained with the "Get a list of contacts" method
>
> **contactId** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update information about messenger of the contact
>
> **Slug:** `SEND_PULSE_CRM_UPDATE_CONTACT_MESSENGER`
>
> Updates information about a given messenger for the specified contact. Provided property values will be overwritten.
>
> #### Input Parameters
>
> **login** `string` *required*
>
> Contacts login in the specified messenger
>
> **typeId** `integer` *required*
>
> TypeId value documented by SendPulse.
>
> **contactId** `integer` *required*
>
> Contact ID for which you want to update messenger information. It can be obtained with the "Get a list of contacts" method
>
> **messengerId** `integer` *required*
>
> Messenger ID you want to update. It can be obtained with the "Get a list of contacts" method
>
> **isMainChatbot** `boolean`
>
> Determine if chatbot messenger is the main one
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update the phone number of the contact
>
> **Slug:** `SEND_PULSE_CRM_UPDATE_CONTACT_PHONE`
>
> Updates the phone number of the specified contact. Provided property values will be overwritten.
>
> #### Input Parameters
>
> **phone** `string` *required*
>
> New phone number in the international format
>
> **phoneId** `integer` *required*
>
> The phone number ID you want to update. It can be obtained with the "Get a list of contacts" method
>
> **contactId** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update a tag
>
> **Slug:** `SEND_PULSE_CRM_UPDATE_CONTACT_TAG`
>
> Updates the specified tag with a new name. Provided property values will be overwritten.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> New tag name. The maximum number of characters is 255
>
> **tagId** `integer` *required*
>
> Tag ID you want to update. It can be obtained with the "Get a list of contact tags" method
>
> **colorText** `string`
>
> Text color
>
> **colorBackground** `string`
>
> Background color
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update custom tabs
>
> **Slug:** `SEND_PULSE_CRM_UPDATE_CUSTOM_TAB`
>
> Update the name and entity placement of a SendPulse CRM custom tab.
>
> #### Input Parameters
>
> **name** `string`
>
> Custom tab name
>
> **order** `integer`
>
> Custom tab order
>
> **entityId** `integer`
>
> Related entity ID. Only for pipelines and boards
>
> **isVisible** `boolean`
>
> Indicates whether the entity is visible to users
>
> **entityType** `integer ("0" | "1" | "2" | "3")`
>
> 0 - contact, 1 - pipeline, 2 - board, 3 - company
>
> **customTabId** `integer` *required*
>
> Custom tab ID
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update the deal attribute value
>
> **Slug:** `SEND_PULSE_CRM_UPDATE_DEAL_ATTRIBUTE_VALUE`
>
> Updates the deal attribute with the new value. Existing values will be overwritten.
>
> #### Input Parameters
>
> **value** `string` *required*
>
> New attribute value. The maximum number of characters is 5500
>
> **dealId** `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
>
> **attributeId** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update information about a deal by its ID
>
> **Slug:** `SEND_PULSE_CRM_UPDATE_DEAL_BY_ID`
>
> Updates information in the specified deal. Provided property values will be overwritten
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Deal name
>
> **order** `integer`
>
> Field display order. If empty, the deal will be placed at the top of the list.
>
> **price** `number` *required*
>
> Deal amount
>
> **dealId** `integer` *required*
>
> Deal ID to be updated. You can get it in the "Get a list of deals" method
>
> **status** `integer` *required*
>
> Status value documented by SendPulse.
>
> **stepId** `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"
>
> **currency** `string`
>
> Deal currency. Accepts values in the form of UAH, USD, EUR
>
> **sourceId** `integer`
>
> Custom source ID of the deal from an external source
>
> **pipelineId** `integer` *required*
>
> Pipeline ID in which the deal is located. It can be obtained with the method "Get a list of pipelines"
>
> **responsibleId** `integer`
>
> Team member ID to assign to a deal. It can be obtained with the "Get a list of team members" method
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update a note to a deal
>
> **Slug:** `SEND_PULSE_CRM_UPDATE_DEAL_COMMENT`
>
> Updates the selected note in the specified deal. Existing values will be overwritten
>
> #### Input Parameters
>
> **dealId** `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
>
> **message** `string` *required*
>
> New note message. The maximum number of characters is 65,535
>
> **commentId** `integer` *required*
>
> ID of the note to be updated. It can be obtained with the "Get a list of deal notes" method
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update managers from category
>
> **Slug:** `SEND_PULSE_CRM_UPDATE_MANAGER_SETTING`
>
> Replace manager assignments in a SendPulse CRM manager-settings section.
>
> #### Input Parameters
>
> **sectionId** `integer`
>
> SectionId value documented by SendPulse.
>
> **settingId** `integer` *required*
>
> SendPulse settingId parameter.
>
> **responsibleIds** `array`
>
> ResponsibleIds value documented by SendPulse.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update information about a pipeline by its ID
>
> **Slug:** `SEND_PULSE_CRM_UPDATE_PIPELINE`
>
> Update the name, currency, or settings of a SendPulse CRM deal pipeline.
>
> #### Input Parameters
>
> **name** `string`
>
> Pipeline name
>
> **order** `integer`
>
> Field display order
>
> **settings** `array`
>
> Settings value documented by SendPulse.
>
> **pipelineId** `integer` *required*
>
> Pipeline ID to be updated.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update a deal attribute
>
> **Slug:** `SEND_PULSE_CRM_UPDATE_PIPELINE_ATTRIBUTE`
>
> Update a deal attribute
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Name value documented by SendPulse.
>
> **type** `integer`
>
> 0 = Text, 1 = Number, 2 = Date, 3 = Link, 4 = Select, 5 = MultiSelect
>
> **order** `integer` *required*
>
> Order value documented by SendPulse.
>
> **status** `integer`
>
> 0 = Inactive, 1 = Active, 2 = Hidden
>
> **options** `array`
>
> Options value documented by SendPulse.
>
> **mandatory** `boolean`
>
> Mandatory value documented by SendPulse.
>
> **pipelineId** `integer` *required*
>
> SendPulse pipelineId parameter.
>
> **attributeId** `integer` *required*
>
> SendPulse attributeId parameter.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update a pipeline step
>
> **Slug:** `SEND_PULSE_CRM_UPDATE_PIPELINE_STEP`
>
> Update a pipeline step
>
> #### Input Parameters
>
> **name** `string`
>
> Name value documented by SendPulse.
>
> **color** `string ("#000000" | "black")`
>
> Step color
>
> **order** `integer`
>
> Order value documented by SendPulse.
>
> **stepId** `integer` *required*
>
> SendPulse stepId parameter.
>
> **notifyIn** `string ("0" | "15min" | "30min" | "1h" | "2h" | "3h" | "6h" | "12h" | "24h" | "2d" | "3d" | "4d" | "5d" | "6d" | "7d")`
>
> Time notification
>
> **pipelineId** `integer` *required*
>
> SendPulse pipelineId parameter.
>
> **addEndHours** `integer ("1" | "2" | "3" | "4" | "5" | "6" | "8" | "9" | "10")`
>
> Add number of hours or null
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update product by id
>
> **Slug:** `SEND_PULSE_CRM_UPDATE_PRODUCT`
>
> Update details, stock, or visibility for a SendPulse CRM product.
>
> #### Input Parameters
>
> **seo** `object`
>
> SEO-related metadata
>
> **name** `string`
>
> Product name
>
> **images** `array`
>
> Array of product image URLs
>
> **balance** `object`
>
> Stock balance information
>
> **visible** `number`
>
> Visibility flag (0 - hidden, 1 - visible)
>
> **productId** `integer` *required*
>
> ID of the product to update
>
> **categoryId** `number`
>
> Category ID the product belongs to
>
> **vendorCode** `string`
>
> Vendor or manufacturer code
>
> **description** `string`
>
> Full product description
>
> **digitalInfo** `object`
>
> Digital product details
>
> **availability** `number`
>
> Product availability status
>
> **shortDescription** `string`
>
> Short product summary
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update users category by id
>
> **Slug:** `SEND_PULSE_CRM_UPDATE_PRODUCT_CATEGORY`
>
> Rename or move a SendPulse CRM product category by ID.
>
> #### Input Parameters
>
> **name** `string`
>
> Name value documented by SendPulse.
>
> **parentId** `number`
>
> ParentId value documented by SendPulse.
>
> **categoryId** `integer` *required*
>
> SendPulse categoryId parameter.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update price in product
>
> **Slug:** `SEND_PULSE_CRM_UPDATE_PRODUCT_PRICES`
>
> Replace the configured prices for a SendPulse CRM product.
>
> #### Input Parameters
>
> **prices** `array`
>
> List of prices for the product
>
> **productId** `integer` *required*
>
> ID of the product to update prices for
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Product Sections
>
> **Slug:** `SEND_PULSE_CRM_UPDATE_PRODUCT_SECTIONS`
>
> Replace or update sections and their attribute values for a SendPulse CRM product.
>
> #### Input Parameters
>
> **sections** `array`
>
> List of sections to update
>
> **productId** `integer` *required*
>
> ID of the product to update sections for
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update quantity or amount products in deal
>
> **Slug:** `SEND_PULSE_CRM_UPDATE_PRODUCTS_IN_DEAL`
>
> Update quantities and prices for products attached to a SendPulse CRM deal.
>
> #### Input Parameters
>
> **amount** `integer`
>
> Product amount in the deal
>
> **headId** `integer` *required*
>
> SendPulse headId parameter.
>
> **quantity** `integer`
>
> Product quantity in the deal
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update task attribute value
>
> **Slug:** `SEND_PULSE_CRM_UPDATE_TASK_ATTRIBUTE_VALUE`
>
> Update a custom attribute value on a SendPulse CRM task.
>
> #### Input Parameters
>
> **value** `string`
>
> Attribute value as a scalar string or array of values
>
> **boardId** `integer` *required*
>
> SendPulse boardId path parameter.
>
> **valueId** `integer` *required*
>
> SendPulse valueId parameter.
>
> **attributeId** `integer` *required*
>
> SendPulse attributeId parameter.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update a task by ID
>
> **Slug:** `SEND_PULSE_CRM_UPDATE_TASK_BY_ID`
>
> Update a task by ID
>
> #### Input Parameters
>
> **name** `string`
>
> Task name
>
> **tags** `array`
>
> IDs of tags
>
> **repeat** `integer`
>
> Do you need to repeat the task
>
> **stepId** `integer`
>
> StepId value documented by SendPulse.
>
> **taskId** `integer` *required*
>
> SendPulse taskId parameter.
>
> **boardId** `integer`
>
> BoardId value documented by SendPulse.
>
> **startAt** `string`
>
> StartAt value documented by SendPulse.
>
> **finishAt** `string`
>
> FinishAt value documented by SendPulse.
>
> **parentId** `integer`
>
> Parent task ID
>
> **priority** `integer`
>
> Priority value documented by SendPulse.
>
> **observers** `array`
>
> Array of users IDs acting as observers
>
> **sourceType** `integer`
>
> SourceType value documented by SendPulse.
>
> **description** `string`
>
> Task description
>
> **responsibleId** `integer`
>
> Responsible user ID
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update multiple checklists with items in task
>
> **Slug:** `SEND_PULSE_CRM_UPDATE_TASK_CHECKLISTS`
>
> Replace multiple checklists and their items on a SendPulse CRM task.
>
> #### Input Parameters
>
> **taskId** `integer` *required*
>
> SendPulse taskId parameter.
>
> **checklists** `array`
>
> Checklists value documented by SendPulse.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update checklist without items in task
>
> **Slug:** `SEND_PULSE_CRM_UPDATE_TASK_CHECKLIST_SINGLE`
>
> Rename one checklist on a SendPulse CRM task without changing its items.
>
> #### Input Parameters
>
> **name** `string`
>
> Checklist name
>
> **taskId** `integer` *required*
>
> SendPulse taskId parameter.
>
> **checklistId** `integer` *required*
>
> SendPulse checklistId parameter.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update comment in task
>
> **Slug:** `SEND_PULSE_CRM_UPDATE_TASK_COMMENT`
>
> Edit an existing internal comment on a SendPulse CRM task.
>
> #### Input Parameters
>
> **taskId** `integer` *required*
>
> SendPulse taskId parameter.
>
> **message** `string`
>
> Comment message
>
> **commentId** `integer` *required*
>
> SendPulse commentId parameter.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update a task tag
>
> **Slug:** `SEND_PULSE_CRM_UPDATE_TASK_TAG`
>
> Update a task tag
>
> #### Input Parameters
>
> **name** `string`
>
> Tag name
>
> **color** `string`
>
> Tag color
>
> **tagId** `integer` *required*
>
> SendPulse tagId parameter.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Upload files
>
> **Slug:** `SEND_PULSE_CRM_UPLOAD_FILES`
>
> Upload one or more files for later attachment to SendPulse CRM records.
>
> #### Input Parameters
>
> **files** `array`
>
> Array of file binaries
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update or create deal expiration
>
> **Slug:** `SEND_PULSE_CRM_UPSERT_DEAL_EXPIRATION`
>
> Create or update expiration and notification settings for a SendPulse CRM deal.
>
> #### Input Parameters
>
> **date** `string`
>
> Expiration date
>
> **time** `string`
>
> Expiration time
>
> **dealId** `integer` *required*
>
> Deal ID
>
> **notifyIn** `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.
>
> **dealAction** `integer ("1" | "2")`
>
> Deal event: 1 created or 2 updated.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Files
>
> **Slug:** `SEND_PULSE_DELETE_FILES`
>
> Permanently 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
>
> **file\_paths** `array` *required*
>
> Full File Manager paths of 1-25 files to permanently delete with separate sequential requests.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Mailing List
>
> **Slug:** `SEND_PULSE_DELETE_MAILING_LIST`
>
> Permanently delete one Bulk Email mailing list and its membership.
>
> #### Input Parameters
>
> **mailing\_list\_id** `integer` *required*
>
> ID of the mailing list to permanently delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Education Student
>
> **Slug:** `SEND_PULSE_EDU_CREATE_STUDENT`
>
> Create a SendPulse Education student and optionally enroll them in a course tariff.
>
> #### Input Parameters
>
> **email** `string`
>
> Student email address.
>
> **tag\_ids** `array`
>
> Tag IDs to assign to the student.
>
> **language** `string`
>
> Preferred language or locale code.
>
> **course\_id** `integer`
>
> Course ID for enrollment.
>
> **last\_name** `string`
>
> Student last name.
>
> **first\_name** `string`
>
> Student first name.
>
> **course\_tariff\_id** `integer`
>
> Course tariff ID for enrollment.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Education Student
>
> **Slug:** `SEND_PULSE_EDU_DELETE_STUDENT`
>
> Permanently delete a student and associated education data from the school.
>
> #### Input Parameters
>
> **student\_id** `integer` *required*
>
> Student ID to permanently delete from the school.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Education Courses
>
> **Slug:** `SEND_PULSE_EDU_GET_COURSES`
>
> Get all Education courses associated with the connected account.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Course Tariffs
>
> **Slug:** `SEND_PULSE_EDU_GET_COURSE_TARIFFS`
>
> Get all pricing tariffs available for an Education course.
>
> #### Input Parameters
>
> **course\_id** `integer` *required*
>
> Course ID whose tariffs to return.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Education Schools
>
> **Slug:** `SEND_PULSE_EDU_GET_SCHOOLS`
>
> Get the schools registered in the connected SendPulse Education account.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Student Course Statistics
>
> **Slug:** `SEND_PULSE_EDU_GET_STUDENT_COURSE_STATISTICS`
>
> Get a student's enrollment, progress, assessment, and tariff statistics across Education courses.
>
> #### Input Parameters
>
> **student\_id** `integer` *required*
>
> Student ID whose cross-course progress to return.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Education Student Audience
>
> **Slug:** `SEND_PULSE_EDU_GET_STUDENTS_AUDITORY`
>
> Search and filter the SendPulse Education student audience.
>
> #### Input Parameters
>
> **sort** `string ("asc" | "desc")`
>
> Sort direction.
>
> **tags** `array`
>
> Tag IDs assigned to students.
>
> **email** `string`
>
> Student email substring.
>
> **limit** `integer` *required*
>
> Maximum matching students to return.
>
> **offset** `integer` *required*
>
> Number of matching students to skip.
>
> **is\_paid** `boolean`
>
> Whether the student paid for at least one course.
>
> **order\_by** `string ("firstName" | "studentStatusOnCourse" | "studentTest" | "studentDateRegistrationOnCourse")`
>
> Field used to sort results.
>
> **course\_id** `integer`
>
> Course ID filter.
>
> **last\_name** `string`
>
> Student last-name substring.
>
> **first\_name** `string`
>
> Student first-name substring.
>
> **course\_status** `array`
>
> Student course statuses.
>
> **search\_string** `string`
>
> Free-text student search.
>
> **promo\_code\_ids** `array`
>
> Promo code IDs used by students.
>
> **date\_last\_entry** `object`
>
> Last login date range.
>
> **used\_promo\_code** `boolean`
>
> Whether any promo code was used.
>
> **paid\_courses\_value** `integer`
>
> Paid course count used by the comparison.
>
> **course\_restrictions** `string ("none" | "open" | "closed")`
>
> Course access restriction filter.
>
> **paid\_courses\_condition** `string ("=" | "\>=" | "\<=")`
>
> Comparison operator for paid course count.
>
> **date\_registration\_on\_course** `object`
>
> Course registration date range.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Students By Course
>
> **Slug:** `SEND_PULSE_EDU_GET_STUDENTS_BY_COURSE`
>
> Get a filtered page of students enrolled in a SendPulse Education course.
>
> #### Input Parameters
>
> **sort** `string ("asc" | "desc")`
>
> Sort direction.
>
> **tags** `array`
>
> Tag IDs assigned to students.
>
> **email** `string`
>
> Student email substring.
>
> **limit** `integer` *required*
>
> Maximum matching students to return.
>
> **offset** `integer` *required*
>
> Number of matching students to skip.
>
> **is\_paid** `boolean`
>
> Whether the student paid for at least one course.
>
> **order\_by** `string ("firstName" | "studentStatusOnCourse" | "studentTest" | "studentDateRegistrationOnCourse")`
>
> Field used to sort results.
>
> **progress** `object`
>
> Lesson, test, and certificate progress filters.
>
> **course\_id** `integer` *required*
>
> Course ID.
>
> **last\_name** `string`
>
> Student last-name substring.
>
> **lesson\_id** `integer`
>
> Lesson ID filter.
>
> **first\_name** `string`
>
> Student first-name substring.
>
> **tariff\_ids** `array`
>
> Assigned tariff IDs.
>
> **course\_status** `array`
>
> Student course statuses.
>
> **search\_string** `string`
>
> Free-text student search.
>
> **promo\_code\_ids** `array`
>
> Promo code IDs used by students.
>
> **tags\_condition** `string ("all" | "any")`
>
> Require all or any supplied tags.
>
> **without\_tariff** `boolean`
>
> Whether students must lack or have a tariff; omit when tariff\_ids is set.
>
> **date\_last\_entry** `object`
>
> Last login date range.
>
> **used\_promo\_code** `boolean`
>
> Whether any promo code was used.
>
> **date\_registration\_on\_course** `object`
>
> Course registration date range.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Education Tags
>
> **Slug:** `SEND_PULSE_EDU_GET_TAGS`
>
> Get the complete list of tags available in SendPulse Education.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Student Groups By Course
>
> **Slug:** `SEND_PULSE_EDU_LIST_GROUPS_BY_COURSE`
>
> List all student groups associated with an Education course.
>
> #### Input Parameters
>
> **course\_id** `integer` *required*
>
> Course ID whose student groups to list.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Mark Education Students As Paid
>
> **Slug:** `SEND_PULSE_EDU_MARK_STUDENTS_AS_PAID`
>
> Mark one or more SendPulse Education students as paid for a course.
>
> #### Input Parameters
>
> **ids** `array`
>
> Student IDs to mark as paid.
>
> **course\_id** `integer` *required*
>
> Course ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Remove Student From Course
>
> **Slug:** `SEND_PULSE_EDU_REMOVE_STUDENT_FROM_COURSE`
>
> Permanently remove a student's enrollment from an Education course.
>
> #### Input Parameters
>
> **course\_id** `integer` *required*
>
> Course ID from which to remove the student.
>
> **student\_id** `integer` *required*
>
> Student ID to remove from the course.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Assign Facebook Contact Operator
>
> **Slug:** `SEND_PULSE_FACEBOOK_ASSIGN_CONTACT_OPERATOR`
>
> Assign a responsible operator to a SendPulse Facebook contact chat.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID whose chat to assign.
>
> **operator\_id** `integer` *required*
>
> Operator ID to make responsible for the chat.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Close Facebook Contact Chat
>
> **Slug:** `SEND_PULSE_FACEBOOK_CLOSE_CONTACT_CHAT`
>
> Close a SendPulse Facebook contact chat and lower its queue priority.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID whose chat to close.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Facebook Contact Note
>
> **Slug:** `SEND_PULSE_FACEBOOK_CREATE_CONTACT_NOTE`
>
> Create an internal operator note for a SendPulse Facebook contact.
>
> #### Input Parameters
>
> **text** `string` *required*
>
> Operator note text.
>
> **bot\_id** `string` *required*
>
> Bot ID associated with the contact.
>
> **contact\_id** `string` *required*
>
> Contact ID to annotate.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Facebook Contact
>
> **Slug:** `SEND_PULSE_FACEBOOK_DELETE_CONTACT`
>
> Permanently remove a contact from a SendPulse Facebook bot audience.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID to permanently remove.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Facebook Contact Note
>
> **Slug:** `SEND_PULSE_FACEBOOK_DELETE_CONTACT_NOTE`
>
> Permanently remove an operator note from a SendPulse Facebook contact.
>
> #### Input Parameters
>
> **bot\_id** `string` *required*
>
> Bot ID associated with the contact.
>
> **note\_id** `string` *required*
>
> Note ID to permanently remove.
>
> **contact\_id** `string` *required*
>
> Contact ID associated with the note.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Facebook Contact Tag
>
> **Slug:** `SEND_PULSE_FACEBOOK_DELETE_CONTACT_TAG`
>
> Remove a tag from a SendPulse Facebook contact.
>
> #### Input Parameters
>
> **tag** `string` *required*
>
> Tag to remove.
>
> **contact\_id** `string` *required*
>
> Contact ID from which to remove the tag.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Facebook Contact Variable
>
> **Slug:** `SEND_PULSE_FACEBOOK_DELETE_CONTACT_VARIABLE`
>
> Delete one variable value from a SendPulse Facebook contact.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID whose variable value to delete.
>
> **variable\_id** `string`
>
> Variable ID; provide this or variable\_name.
>
> **variable\_name** `string`
>
> Variable name; provide this or variable\_id.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Resume Facebook Contact Automation
>
> **Slug:** `SEND_PULSE_FACEBOOK_DELETE_PAUSE_AUTOMATION`
>
> Remove an automation pause and resume autoflows for a SendPulse Facebook contact.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID whose autoflows to resume.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Disable Facebook Contact
>
> **Slug:** `SEND_PULSE_FACEBOOK_DISABLE_CONTACT`
>
> Disable a SendPulse Facebook contact so campaigns and autoflows are not sent to them.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID to disable.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Enable Facebook Contact
>
> **Slug:** `SEND_PULSE_FACEBOOK_ENABLE_CONTACT`
>
> Enable a SendPulse Facebook contact so campaigns and autoflows can resume.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID to enable.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Facebook Get Account
>
> **Slug:** `SEND_PULSE_FACEBOOK_GET_ACCOUNT`
>
> Returns information about your current account pricing plan, the number of messages in your plan, bots, contacts, list of tags, and variables
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Facebook Get Bot Statistics
>
> **Slug:** `SEND_PULSE_FACEBOOK_GET_BOT_STATISTICS`
>
> Returns general statistics info by bot
>
> #### Input Parameters
>
> **bot\_id** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Facebook Get Chat Messages
>
> **Slug:** `SEND_PULSE_FACEBOOK_GET_CHAT_MESSAGES`
>
> Returns a page of messages in correspondence with the specified Facebook subscriber, with a continuation cursor for further pages.
>
> #### Input Parameters
>
> **size** `integer`
>
> The limit of pagination items, that will be returned
>
> **skip** `integer`
>
> The offset of pagination items, where starts a current items batch
>
> **order** `string ("asc" | "desc")`
>
> Sort order ASC or DESC
>
> **cursor** `string`
>
> Continuation cursor returned by a previous call.
>
> **contact\_id** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Facebook Get Chats
>
> **Slug:** `SEND_PULSE_FACEBOOK_GET_CHATS`
>
> Returns a list of chats with subscribers with information about the contact and the last message received from the contact
>
> #### Input Parameters
>
> **size** `integer`
>
> Provider size query parameter.
>
> **skip** `integer`
>
> Provider skip query parameter.
>
> **bot\_id** `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.
>
> **cursor** `string`
>
> Continuation cursor returned by a previous call.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Facebook Get Contact
>
> **Slug:** `SEND_PULSE_FACEBOOK_GET_CONTACT`
>
> Returns information on the selected contact: bot and contact ID, information from Facebook, list of tags and variables, activity data and date added
>
> #### Input Parameters
>
> **id** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Facebook Get Contact Notes
>
> **Slug:** `SEND_PULSE_FACEBOOK_GET_CONTACT_NOTES`
>
> Returns a list of existing operator notes by contact
>
> #### Input Parameters
>
> **bot\_id** `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.
>
> **contact\_id** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Facebook Get Contact Pause Automation
>
> **Slug:** `SEND_PULSE_FACEBOOK_GET_CONTACT_PAUSE_AUTOMATION`
>
> Returns the time remaining until autoflows are stopped for this contact
>
> #### Input Parameters
>
> **contact\_id** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Facebook Get Contacts By Tag
>
> **Slug:** `SEND_PULSE_FACEBOOK_GET_CONTACTS_BY_TAG`
>
> Returns a list of contacts by tag for the specified bot
>
> #### Input Parameters
>
> **tag** `string` *required*
>
> created contacts tag to search by
>
> **size** `integer`
>
> The limit of pagination items, that will be returned
>
> **skip** `integer`
>
> The offset of pagination items, where starts a current items batch
>
> **bot\_id** `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.
>
> **cursor** `string`
>
> Continuation cursor returned by a previous call.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Facebook Get Contacts By Variable
>
> **Slug:** `SEND_PULSE_FACEBOOK_GET_CONTACTS_BY_VARIABLE`
>
> Returns 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
>
> **size** `integer`
>
> The limit of pagination items, that will be returned
>
> **skip** `integer`
>
> The offset of pagination items, where starts a current items batch
>
> **bot\_id** `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.
>
> **cursor** `string`
>
> Continuation cursor returned by a previous call.
>
> **variable\_id** `string`
>
> Contact's variable ID
>
> **variable\_name** `string`
>
> ontact variable name to search by
>
> **variable\_value** `string` *required*
>
> Contact's variable value
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Facebook Get Flows
>
> **Slug:** `SEND_PULSE_FACEBOOK_GET_FLOWS`
>
> Returns 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
>
> **size** `integer`
>
> The limit of pagination items, that will be returned
>
> **skip** `integer`
>
> The offset of pagination items, where starts a current items batch
>
> **bot\_id** `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.
>
> **cursor** `string`
>
> Continuation cursor returned by a previous call.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Facebook Get Triggers
>
> **Slug:** `SEND_PULSE_FACEBOOK_GET_TRIGGERS`
>
> Returns 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
>
> **size** `integer`
>
> The limit of pagination items, that will be returned
>
> **skip** `integer`
>
> The offset of pagination items, where starts a current items batch
>
> **bot\_id** `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.
>
> **cursor** `string`
>
> Continuation cursor returned by a previous call.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Facebook List Bot Variables
>
> **Slug:** `SEND_PULSE_FACEBOOK_LIST_BOT_VARIABLES`
>
> Returns 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
>
> **size** `integer`
>
> The limit of pagination items, that will be returned
>
> **skip** `integer`
>
> The offset of pagination items, where starts a current items batch
>
> **bot\_id** `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.
>
> **cursor** `string`
>
> Continuation cursor returned by a previous call.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Facebook List Tags
>
> **Slug:** `SEND_PULSE_FACEBOOK_LIST_TAGS`
>
> Returns 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
>
> **size** `integer`
>
> The limit of pagination items, that will be returned
>
> **skip** `integer`
>
> The offset of pagination items, where starts a current items batch
>
> **bot\_id** `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.
>
> **cursor** `string`
>
> Continuation cursor returned by a previous call.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Mark Facebook Contact Messages Read
>
> **Slug:** `SEND_PULSE_FACEBOOK_MARK_CONTACT_MESSAGES_AS_READ`
>
> Mark all messages from a SendPulse Facebook contact as read.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID whose unread count will be reset.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Mark Facebook Contact Unread
>
> **Slug:** `SEND_PULSE_FACEBOOK_MARK_CONTACT_UNREAD`
>
> Mark the last message from a SendPulse Facebook contact as unread.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> ID of the Facebook contact whose last message will be marked unread.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Open Facebook Contact Chat
>
> **Slug:** `SEND_PULSE_FACEBOOK_OPEN_CONTACT_CHAT`
>
> Mark a SendPulse Facebook contact chat as open and increase its queue priority.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID whose chat to open.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Run Facebook Flow
>
> **Slug:** `SEND_PULSE_FACEBOOK_RUN_FLOW`
>
> Launch a selected SendPulse Facebook flow for a contact with optional one-time data.
>
> #### Input Parameters
>
> **flow\_id** `string` *required*
>
> Flow ID to launch.
>
> **contact\_id** `string` *required*
>
> Contact ID for which to launch the flow.
>
> **external\_data** `object`
>
> One-time custom values available to the selected flow.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Run Facebook Flow by Trigger
>
> **Slug:** `SEND_PULSE_FACEBOOK_RUN_FLOW_BY_TRIGGER`
>
> Launch a SendPulse Facebook flow for a contact using a trigger keyword.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID for which to launch the flow.
>
> **external\_data** `object`
>
> One-time custom values available to the selected flow.
>
> **trigger\_keyword** `string` *required*
>
> Keyword of the flow trigger to invoke.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Send Facebook Chatbot Campaign
>
> **Slug:** `SEND_PULSE_FACEBOOK_SEND_CAMPAIGN`
>
> Send immediately or schedule a campaign to subscribers of a SendPulse Facebook bot.
>
> #### Input Parameters
>
> **title** `string` *required*
>
> Campaign title.
>
> **bot\_id** `string` *required*
>
> Bot ID whose subscribers will receive the campaign.
>
> **filter** `object`
>
> Optional subscriber targeting filter.
>
> **send\_at** `string`
>
> Scheduled date and time in Y-m-d H:i format; omit to send immediately.
>
> **messages** `array` *required*
>
> Campaign messages and channel-specific content.
>
> **message\_tag** `string ("HUMAN_AGENT" | "CUSTOMER_FEEDBACK")`
>
> Facebook Messenger policy tag.
>
> **message\_notification\_type** `string ("REGULAR" | "SILENT_PUSH" | "NO_PUSH")`
>
> Facebook notification delivery mode.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Send Facebook Contact Message
>
> **Slug:** `SEND_PULSE_FACEBOOK_SEND_CONTACT_MESSAGE`
>
> Send text, media, or template content to a SendPulse Facebook contact.
>
> #### Input Parameters
>
> **message** `object` *required*
>
> Message type and content.
>
> **contact\_id** `string` *required*
>
> Contact ID that will receive the message.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Send Text to Facebook Contact
>
> **Slug:** `SEND_PULSE_FACEBOOK_SEND_TEXT_TO_CONTACT`
>
> Send a text message to a SendPulse Facebook contact.
>
> #### Input Parameters
>
> **text** `string` *required*
>
> Text message to send; may include emoji.
>
> **contact\_id** `string` *required*
>
> Contact ID that will receive the message.
>
> **message\_tag** `string ("HUMAN_AGENT" | "CUSTOMER_FEEDBACK")` *required*
>
> Facebook Messenger policy tag.
>
> **message\_type** `string ("MESSAGE_TAG" | "RESPONSE")` *required*
>
> Facebook message type.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Send Facebook Typing Indicator
>
> **Slug:** `SEND_PULSE_FACEBOOK_SEND_TYPING_INDICATOR`
>
> Send a transient typing indicator to a SendPulse Facebook contact.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID that will receive the typing indicator.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Pause Facebook Contact Autoflows
>
> **Slug:** `SEND_PULSE_FACEBOOK_SET_CONTACT_PAUSE_AUTOMATION`
>
> Pause autoflows for a SendPulse Facebook contact for a specified number of minutes.
>
> #### Input Parameters
>
> **minutes** `integer` *required*
>
> Number of minutes to pause autoflows.
>
> **contact\_id** `string` *required*
>
> Contact ID whose autoflows should be paused.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Set Facebook Contact Tags
>
> **Slug:** `SEND_PULSE_FACEBOOK_SET_CONTACT_TAG`
>
> Assign one or more tags to a SendPulse Facebook contact.
>
> #### Input Parameters
>
> **tags** `array` *required*
>
> Tags to assign to the contact.
>
> **contact\_id** `string` *required*
>
> Contact ID to update.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Set Facebook Contact Variables
>
> **Slug:** `SEND_PULSE_FACEBOOK_SET_CONTACT_VARIABLE`
>
> Add or update one or more variables on a SendPulse Facebook contact.
>
> #### Input Parameters
>
> **variables** `array` *required*
>
> Variables identified by name or ID and their new values.
>
> **contact\_id** `string` *required*
>
> Contact ID to update.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Unassign Facebook Contact Operators
>
> **Slug:** `SEND_PULSE_FACEBOOK_UN_ASSIGN_CONTACT_OPERATORS`
>
> Remove the responsible operator assignment from a SendPulse Facebook contact chat.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID whose operator assignment to remove.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Facebook Contact Note
>
> **Slug:** `SEND_PULSE_FACEBOOK_UPDATE_CONTACT_NOTE`
>
> Replace an existing operator note for a SendPulse Facebook contact.
>
> #### Input Parameters
>
> **text** `string` *required*
>
> Replacement operator note text.
>
> **bot\_id** `string` *required*
>
> Bot ID associated with the contact.
>
> **note\_id** `string` *required*
>
> Note ID to update.
>
> **contact\_id** `string` *required*
>
> Contact ID associated with the note.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Check File Exists
>
> **Slug:** `SEND_PULSE_FILE_MANAGER_CHECK_FILE_EXIST`
>
> Check whether a file exists at a SendPulse File Manager path.
>
> #### Input Parameters
>
> **path** `string` *required*
>
> Absolute path of the file to check.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create File Manager Directory
>
> **Slug:** `SEND_PULSE_FILE_MANAGER_CREATE_DIRECTORY`
>
> Create a directory in SendPulse File Manager.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Name of the directory to create.
>
> **path\_to\_store** `string` *required*
>
> Absolute parent path where the directory will be created.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Filter File Manager Files
>
> **Slug:** `SEND_PULSE_FILE_MANAGER_FILTER_FILES`
>
> Filter files in a SendPulse File Manager directory by date range and sort order.
>
> #### Input Parameters
>
> **path** `string` *required*
>
> Directory path whose files will be filtered.
>
> **sort** `string ("asc" | "desc")`
>
> Sort order for matching files.
>
> **to\_date** `string`
>
> Inclusive UTC upper bound in Y-m-d H:i format.
>
> **from\_date** `string`
>
> Inclusive UTC lower bound in Y-m-d H:i format.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Directory Contents
>
> **Slug:** `SEND_PULSE_FILE_MANAGER_GET_DIRECTORY_CONTENTS`
>
> Get files and nested folders in a SendPulse File Manager directory.
>
> #### Input Parameters
>
> **directory\_path** `string` *required*
>
> Absolute directory path, such as /images or /uploads/2024.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Account Overview
>
> **Slug:** `SEND_PULSE_GET_ACCOUNT_OVERVIEW`
>
> Return the connected SendPulse account identity, balances, enabled product plans, and usage limits.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Automation Flow Stats
>
> **Slug:** `SEND_PULSE_GET_AUTOMATION_FLOW_STATS`
>
> Return aggregate flow performance and per-element statistics for one Automation 360 flow.
>
> #### Input Parameters
>
> **flow\_id** `integer` *required*
>
> ID of the Automation 360 flow to inspect.
>
> **flow\_type** `string ("maintrigger" | "email" | "push" | "sms" | "filter" | "action" | "goal" | "trigger" | "viber" | "pause")`
>
> Optional Automation 360 element type to include in element statistics.
>
> **include\_deleted** `boolean`
>
> Whether element statistics should include deleted flow elements.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Chatbot Account
>
> **Slug:** `SEND_PULSE_GET_CHATBOT_ACCOUNT`
>
> Return the connected SendPulse account's Chatbots plan, quotas, usage statistics, and connected channel services.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Email Campaign
>
> **Slug:** `SEND_PULSE_GET_EMAIL_CAMPAIGN`
>
> Return configuration, recipient counts, status, and delivery statistics for one Bulk Email campaign.
>
> #### Input Parameters
>
> **campaign\_id** `integer` *required*
>
> ID of the Bulk Email campaign to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get File Storage Overview
>
> **Slug:** `SEND_PULSE_GET_FILE_STORAGE_OVERVIEW`
>
> Return 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Mailing List Verification
>
> **Slug:** `SEND_PULSE_GET_MAILING_LIST_VERIFICATION`
>
> Return 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
>
> **page\_size** `integer`
>
> Maximum email-level verification results to return in this page.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor from a previous response; omit for the first page.
>
> **verification\_id** `integer` *required*
>
> ID of the verified mailing list returned by the verification list.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Assign Instagram Contact Operator
>
> **Slug:** `SEND_PULSE_INSTAGRAM_ASSIGN_CONTACT_OPERATOR`
>
> Assign a responsible operator to a SendPulse Instagram chatbot contact's chat.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID whose chat will be assigned.
>
> **operator\_id** `integer` *required*
>
> Operator ID to assign as responsible for the chat.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Close Instagram Contact Chat
>
> **Slug:** `SEND_PULSE_INSTAGRAM_CLOSE_CONTACT_CHAT`
>
> Close a SendPulse Instagram contact chat and lower its queue priority.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID whose chat to close.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Instagram Contact Note
>
> **Slug:** `SEND_PULSE_INSTAGRAM_CREATE_CONTACT_NOTE`
>
> Create an internal operator note for a SendPulse Instagram contact.
>
> #### Input Parameters
>
> **text** `string` *required*
>
> Operator note text, visible only to operators.
>
> **bot\_id** `string` *required*
>
> Bot ID associated with the contact.
>
> **contact\_id** `string` *required*
>
> Contact ID to annotate.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Instagram Contact
>
> **Slug:** `SEND_PULSE_INSTAGRAM_DELETE_CONTACT`
>
> Permanently remove a contact and its history from a SendPulse Instagram bot audience.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID to permanently remove.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Resume Instagram Contact Automation
>
> **Slug:** `SEND_PULSE_INSTAGRAM_DELETE_CONTACT_AUTOMATION_PAUSE`
>
> Remove an automation pause so a SendPulse Instagram contact resumes autoflows.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID whose automation pause to remove.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Instagram Contact Note
>
> **Slug:** `SEND_PULSE_INSTAGRAM_DELETE_CONTACT_NOTE`
>
> Permanently remove an operator note from a SendPulse Instagram contact.
>
> #### Input Parameters
>
> **bot\_id** `string` *required*
>
> Bot ID associated with the contact.
>
> **note\_id** `string` *required*
>
> Note ID to permanently remove.
>
> **contact\_id** `string` *required*
>
> Contact ID associated with the note.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Remove Instagram Contact Tag
>
> **Slug:** `SEND_PULSE_INSTAGRAM_DELETE_CONTACT_TAG`
>
> Remove a tag from a SendPulse Instagram chatbot contact.
>
> #### Input Parameters
>
> **tag** `string` *required*
>
> Tag to remove from the contact.
>
> **contact\_id** `string` *required*
>
> Contact ID whose tag will be removed.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Instagram Contact Variable
>
> **Slug:** `SEND_PULSE_INSTAGRAM_DELETE_CONTACT_VARIABLE`
>
> Delete a variable value from a SendPulse Instagram chatbot contact.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID whose variable value will be deleted.
>
> **variable\_id** `string`
>
> Variable ID; provide this or variable\_name.
>
> **variable\_name** `string`
>
> Variable name; provide this or variable\_id.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Disable Instagram Contact
>
> **Slug:** `SEND_PULSE_INSTAGRAM_DISABLE_CONTACT`
>
> Disable an Instagram chatbot contact so campaigns and autoflows are no longer sent.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID to disable.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Enable Instagram Contact
>
> **Slug:** `SEND_PULSE_INSTAGRAM_ENABLE_CONTACT`
>
> Enable an Instagram chatbot contact to receive campaigns and autoflows.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID to enable.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Instagram Chatbot Account
>
> **Slug:** `SEND_PULSE_INSTAGRAM_GET_ACCOUNT`
>
> Get pricing-plan limits and usage for the Instagram chatbot service.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Instagram Bot Statistics
>
> **Slug:** `SEND_PULSE_INSTAGRAM_GET_BOTS_STATISTICS`
>
> Get aggregate subscriber and outgoing-message statistics for an Instagram bot.
>
> #### Input Parameters
>
> **bot\_id** `string` *required*
>
> Bot ID whose aggregate statistics to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Instagram Chat Messages
>
> **Slug:** `SEND_PULSE_INSTAGRAM_GET_CHAT_MESSAGES`
>
> Get one page of messages exchanged with an Instagram chatbot contact.
>
> #### Input Parameters
>
> **size** `integer`
>
> Number of messages requested per page.
>
> **skip** `integer`
>
> Zero-based message offset.
>
> **order** `string ("asc" | "desc")`
>
> Message sort order.
>
> **cursor** `string`
>
> Continuation cursor returned by a previous call.
>
> **contact\_id** `string` *required*
>
> Contact ID whose message history to retrieve.
>
> **search\_after** `string`
>
> Message ID after which to search.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Instagram Chats
>
> **Slug:** `SEND_PULSE_INSTAGRAM_GET_CHATS`
>
> Get one page of chats for an Instagram bot.
>
> #### Input Parameters
>
> **size** `integer`
>
> Number of chats requested per page.
>
> **skip** `integer`
>
> Zero-based chat offset.
>
> **bot\_id** `string` *required*
>
> Bot ID whose chats to retrieve.
>
> **cursor** `string`
>
> Continuation cursor returned by a previous call.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Instagram Contact
>
> **Slug:** `SEND_PULSE_INSTAGRAM_GET_CONTACT`
>
> Get an Instagram chatbot contact by contact ID.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Contact ID to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Instagram Contact Notes
>
> **Slug:** `SEND_PULSE_INSTAGRAM_GET_CONTACT_NOTES`
>
> Get internal operator notes for an Instagram chatbot contact.
>
> #### Input Parameters
>
> **bot\_id** `string` *required*
>
> Bot ID associated with the contact.
>
> **contact\_id** `string` *required*
>
> Contact ID whose operator notes to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Instagram Contact Automation Pause
>
> **Slug:** `SEND_PULSE_INSTAGRAM_GET_CONTACT_PAUSE_AUTOMATION`
>
> Get the remaining automation pause for an Instagram chatbot contact.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID whose automation pause to inspect.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Instagram Contacts by Tag
>
> **Slug:** `SEND_PULSE_INSTAGRAM_GET_CONTACTS_BY_TAG`
>
> Get one page of Instagram chatbot contacts matching a tag.
>
> #### Input Parameters
>
> **tag** `string` *required*
>
> Exact contact tag to match.
>
> **size** `integer`
>
> Number of contacts requested per page.
>
> **skip** `integer`
>
> Zero-based contact offset.
>
> **bot\_id** `string` *required*
>
> Bot ID whose contacts to search.
>
> **cursor** `string`
>
> Continuation cursor returned by a previous call.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Instagram Contacts by Variable
>
> **Slug:** `SEND_PULSE_INSTAGRAM_GET_CONTACTS_BY_VARIABLE`
>
> Get one page of Instagram chatbot contacts matching a variable value.
>
> #### Input Parameters
>
> **size** `integer`
>
> Number of contacts requested per page.
>
> **skip** `integer`
>
> Zero-based contact offset.
>
> **bot\_id** `string`
>
> Bot ID required with variable\_name.
>
> **cursor** `string`
>
> Continuation cursor returned by a previous call.
>
> **variable\_id** `string`
>
> Variable ID to match instead of a variable name and bot ID.
>
> **variable\_name** `string`
>
> Variable name to match when bot\_id is also provided.
>
> **variable\_value** `string` *required*
>
> Variable value to match.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Instagram Flows
>
> **Slug:** `SEND_PULSE_INSTAGRAM_GET_FLOWS`
>
> Get one page of automation flows for an Instagram bot.
>
> #### Input Parameters
>
> **size** `integer`
>
> Number of flows requested per page.
>
> **skip** `integer`
>
> Zero-based flow offset.
>
> **bot\_id** `string` *required*
>
> Bot ID whose flows to retrieve.
>
> **cursor** `string`
>
> Continuation cursor returned by a previous call.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Instagram Tags
>
> **Slug:** `SEND_PULSE_INSTAGRAM_GET_TAGS`
>
> Get one page of tags for an Instagram bot.
>
> #### Input Parameters
>
> **size** `integer`
>
> Number of tags requested per page.
>
> **skip** `integer`
>
> Zero-based tag offset.
>
> **bot\_id** `string` *required*
>
> Bot ID whose tags to retrieve.
>
> **cursor** `string`
>
> Continuation cursor returned by a previous call.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Instagram Bot Variables
>
> **Slug:** `SEND_PULSE_INSTAGRAM_LIST_BOT_VARIABLES`
>
> Get one page of variables defined for an Instagram bot.
>
> #### Input Parameters
>
> **size** `integer`
>
> Number of variables requested per page.
>
> **skip** `integer`
>
> Zero-based variable offset.
>
> **bot\_id** `string` *required*
>
> Bot ID whose variables to retrieve.
>
> **cursor** `string`
>
> Continuation cursor returned by a previous call.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Instagram Triggers
>
> **Slug:** `SEND_PULSE_INSTAGRAM_LIST_TRIGGERS`
>
> Get one page of automation triggers for an Instagram bot.
>
> #### Input Parameters
>
> **size** `integer`
>
> Number of triggers requested per page.
>
> **skip** `integer`
>
> Zero-based trigger offset.
>
> **bot\_id** `string` *required*
>
> Bot ID whose triggers to retrieve.
>
> **cursor** `string`
>
> Continuation cursor returned by a previous call.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Mark Instagram Contact Messages Read
>
> **Slug:** `SEND_PULSE_INSTAGRAM_MARK_CONTACT_MESSAGES_AS_READ`
>
> Mark all messages from a SendPulse Instagram contact as read.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID whose unread count will be reset.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Mark Instagram Contact Unread
>
> **Slug:** `SEND_PULSE_INSTAGRAM_MARK_CONTACT_UNREAD`
>
> Mark the last message from a SendPulse Instagram contact as unread.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID whose last message will be marked unread.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Open Instagram Contact Chat
>
> **Slug:** `SEND_PULSE_INSTAGRAM_OPEN_CONTACT_CHAT`
>
> Increase an Instagram chatbot contact's chat priority by marking it open.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID whose chat will be opened.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Run Instagram Flow
>
> **Slug:** `SEND_PULSE_INSTAGRAM_RUN_FLOW`
>
> Launch a selected SendPulse Instagram chatbot flow for a contact, optionally with one-time external data.
>
> #### Input Parameters
>
> **flow\_id** `string` *required*
>
> Flow ID to launch.
>
> **contact\_id** `string` *required*
>
> Contact ID for which to launch the flow.
>
> **external\_data** `object`
>
> Optional one-time custom data available to the selected flow.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Run Instagram Flow by Trigger
>
> **Slug:** `SEND_PULSE_INSTAGRAM_RUN_FLOW_BY_TRIGGER`
>
> Launch a SendPulse Instagram chatbot flow by trigger keyword for a contact.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID for which to launch the flow.
>
> **external\_data** `object`
>
> Optional one-time custom data available to the triggered flow.
>
> **trigger\_keyword** `string` *required*
>
> Trigger keyword that launches the flow.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Send Instagram Chatbot Campaign
>
> **Slug:** `SEND_PULSE_INSTAGRAM_SEND_CAMPAIGN`
>
> Send immediately or schedule a campaign to active subscribers of a SendPulse Instagram bot.
>
> #### Input Parameters
>
> **title** `string` *required*
>
> Campaign title.
>
> **bot\_id** `string` *required*
>
> Bot ID whose active subscribers will receive the campaign.
>
> **filter** `object`
>
> Optional subscriber targeting filter.
>
> **send\_at** `string`
>
> Scheduled date and time in Y-m-d H:i format; omit to send immediately.
>
> **messages** `array` *required*
>
> Campaign messages and their channel-specific content.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Send Message to Instagram Contact
>
> **Slug:** `SEND_PULSE_INSTAGRAM_SEND_MESSAGE_TO_CONTACT`
>
> Send one or more text, image, file, or structured messages to an Instagram chatbot contact.
>
> #### Input Parameters
>
> **messages** `array` *required*
>
> Messages to send, including each message type and channel-specific content.
>
> **contact\_id** `string` *required*
>
> Contact ID that will receive the message.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Assign Instagram Contact Tags
>
> **Slug:** `SEND_PULSE_INSTAGRAM_SET_CONTACT_TAG`
>
> Assign one or more tags to a SendPulse Instagram chatbot contact.
>
> #### Input Parameters
>
> **tags** `array` *required*
>
> Tags to assign to the contact.
>
> **contact\_id** `string` *required*
>
> Contact ID that will receive the tags.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Set Instagram Contact Variables
>
> **Slug:** `SEND_PULSE_INSTAGRAM_SET_CONTACT_VARIABLE`
>
> Add or update variable values for a SendPulse Instagram chatbot contact.
>
> #### Input Parameters
>
> **variables** `array` *required*
>
> Variables and values to add or update.
>
> **contact\_id** `string` *required*
>
> Contact ID whose variables will be set.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Pause Instagram Contact Autoflows
>
> **Slug:** `SEND_PULSE_INSTAGRAM_SET_PAUSE_AUTOMATION`
>
> Pause autoflows for a SendPulse Instagram chatbot contact for a specified number of minutes.
>
> #### Input Parameters
>
> **minutes** `integer` *required*
>
> Number of minutes to pause autoflows.
>
> **contact\_id** `string` *required*
>
> Contact ID whose autoflows will be paused.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Unassign Instagram Contact Operators
>
> **Slug:** `SEND_PULSE_INSTAGRAM_UN_ASSIGN_CONTACT_OPERATORS`
>
> Remove all responsible operators assigned to an Instagram chatbot contact's chat.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID whose responsible operators will be unassigned.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Instagram Contact Note
>
> **Slug:** `SEND_PULSE_INSTAGRAM_UPDATE_CONTACT_NOTE`
>
> Update an existing operator note for a SendPulse Instagram chatbot contact.
>
> #### Input Parameters
>
> **text** `string` *required*
>
> Updated note text.
>
> **bot\_id** `string` *required*
>
> Bot ID associated with the contact.
>
> **note\_id** `string` *required*
>
> Note ID to update.
>
> **contact\_id** `string` *required*
>
> Contact ID associated with the note.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Automation Flows
>
> **Slug:** `SEND_PULSE_LIST_AUTOMATION_FLOWS`
>
> Return one page of Automation 360 flows available to the connected account. Use next\_cursor to continue through additional pages.
>
> #### Input Parameters
>
> **page\_size** `integer`
>
> Maximum automation flows to return in this page.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor from a previous response; omit for the first page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Campaigns
>
> **Slug:** `SEND_PULSE_LIST_CAMPAIGNS`
>
> List email, SMS, or transactional Viber campaigns using channel-specific filters and pagination.
>
> #### Input Parameters
>
> **order** `string ("asc" | "desc")`
>
> Email campaign sort direction; omit the default meaning for SMS and Viber.
>
> **channel** `string ("email" | "sms" | "viber")`
>
> SendPulse channel whose campaign history to return; may be omitted when continuing with next\_cursor.
>
> **date\_to** `string`
>
> Optional end date for SMS history in YYYY-MM-DD HH:MM:SS format; omit for email and Viber.
>
> **date\_from** `string`
>
> Optional start date for SMS history in YYYY-MM-DD HH:MM:SS format; omit for email and Viber.
>
> **page\_size** `integer`
>
> Maximum email or Viber campaigns to return; ignored for SMS.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor from an email or Viber response; omit for SMS or the first page.
>
> **email\_statuses** `array`
>
> Email campaign statuses to include; omit for SMS and Viber.
>
> **scheduled\_only** `boolean`
>
> Set true to return only scheduled email campaigns; omit for SMS and Viber.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Chatbot Bots
>
> **Slug:** `SEND_PULSE_LIST_CHATBOT_BOTS`
>
> List connected bots across all SendPulse chatbot services or return one page for a selected channel. Channel access tokens are never returned.
>
> #### Input Parameters
>
> **channel** `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.
>
> **page\_size** `integer`
>
> Maximum bots to return in a channel-specific page; ignored when channel is all.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor for a channel-specific listing; omit for the first page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Chatbot Dialogs
>
> **Slug:** `SEND_PULSE_LIST_CHATBOT_DIALOGS`
>
> Return one page of recent dialogs across connected SendPulse chatbot services.
>
> #### Input Parameters
>
> **order** `string ("asc" | "desc")`
>
> Order dialogs ascending (asc) or descending (desc).
>
> **page\_size** `integer`
>
> Maximum dialogs to return in this page.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor from a previous response; omit for the first page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List CRM Pipelines
>
> **Slug:** `SEND_PULSE_LIST_CRM_PIPELINES`
>
> Return CRM pipelines, their stages, and settings for account-state discovery and ID lookup.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Mailing List Contacts
>
> **Slug:** `SEND_PULSE_LIST_MAILING_LIST_CONTACTS`
>
> Return one page of contacts and custom variables from a Bulk Email mailing list.
>
> #### Input Parameters
>
> **order** `string ("asc" | "desc")`
>
> Contact sort direction.
>
> **page\_size** `integer`
>
> Number of contacts to return; SendPulse returns up to 100 records per page.
>
> **active\_only** `boolean`
>
> Set true to request active contacts only; omit to include all statuses.
>
> **next\_cursor** `string`
>
> Continuation cursor from a previous response; omit for the first page.
>
> **inactive\_only** `boolean`
>
> Set true to request inactive contacts only; omit to include all statuses.
>
> **mailing\_list\_id** `integer`
>
> ID of the mailing list whose contacts to return; may be omitted when continuing with next\_cursor.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Mailing Lists
>
> **Slug:** `SEND_PULSE_LIST_MAILING_LISTS`
>
> Return one page of Bulk Email mailing lists with subscriber counts and status. Use next\_cursor to continue through additional pages.
>
> #### Input Parameters
>
> **page\_size** `integer`
>
> Number of mailing lists to return; SendPulse allows 1 to 100 records per page.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor from a previous response; omit for the first page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Mailing List Verifications
>
> **Slug:** `SEND_PULSE_LIST_MAILING_LIST_VERIFICATIONS`
>
> Return one page of mailing-list verification jobs with status and result counts. Use next\_cursor to continue through additional pages.
>
> #### Input Parameters
>
> **page\_size** `integer`
>
> Maximum verification jobs to return in this page.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor from a previous response; omit for the first page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Messaging Senders
>
> **Slug:** `SEND_PULSE_LIST_MESSAGING_SENDERS`
>
> List configured sender identities for either the SMS or transactional Viber service.
>
> #### Input Parameters
>
> **channel** `string ("sms" | "viber")` *required*
>
> Messaging service whose approved or pending sender identities to return. Choose sms or viber.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Assign Live Chat Contact Operator
>
> **Slug:** `SEND_PULSE_LIVE_CHAT_ASSIGN_CONTACT_OPERATOR`
>
> Assign a responsible operator to a SendPulse Live Chat contact's chat.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID whose chat will be assigned.
>
> **operator\_id** `integer` *required*
>
> Operator ID to assign as responsible for the chat.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Close Live Chat Contact Chat
>
> **Slug:** `SEND_PULSE_LIVE_CHAT_CLOSE_CONTACT_CHAT`
>
> Close a SendPulse Live Chat contact's chat and lower its priority.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID whose chat will be closed.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Live Chat Contact Note
>
> **Slug:** `SEND_PULSE_LIVE_CHAT_CREATE_CONTACT_NOTE`
>
> Create an operator note for a SendPulse Live Chat contact.
>
> #### Input Parameters
>
> **text** `string` *required*
>
> Operator note text.
>
> **bot\_id** `string` *required*
>
> Bot ID associated with the contact.
>
> **contact\_id** `string` *required*
>
> Contact ID that will receive the note.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Live Chat Contact
>
> **Slug:** `SEND_PULSE_LIVE_CHAT_DELETE_CONTACT`
>
> Remove a contact from the SendPulse Live Chat audience and subscribers list.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID to remove from the audience and subscribers list.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Live Chat Contact Note
>
> **Slug:** `SEND_PULSE_LIVE_CHAT_DELETE_CONTACT_NOTE`
>
> Delete an operator note from a SendPulse Live Chat contact.
>
> #### Input Parameters
>
> **bot\_id** `string` *required*
>
> Bot ID associated with the contact.
>
> **note\_id** `string` *required*
>
> Note ID to delete.
>
> **contact\_id** `string` *required*
>
> Contact ID associated with the note.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Remove Live Chat Contact Tag
>
> **Slug:** `SEND_PULSE_LIVE_CHAT_DELETE_CONTACT_TAG`
>
> Remove a tag from a SendPulse Live Chat contact.
>
> #### Input Parameters
>
> **tag** `string` *required*
>
> Tag to remove from the contact.
>
> **contact\_id** `string` *required*
>
> Contact ID whose tag will be removed.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Live Chat Contact Variable
>
> **Slug:** `SEND_PULSE_LIVE_CHAT_DELETE_CONTACT_VARIABLE`
>
> Delete a variable value from a SendPulse Live Chat contact.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID whose variable value will be deleted.
>
> **variable\_id** `string`
>
> Variable ID; provide this or variable\_name.
>
> **variable\_name** `string`
>
> Variable name; provide this or variable\_id.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Resume Live Chat Contact Autoflows
>
> **Slug:** `SEND_PULSE_LIVE_CHAT_DELETE_PAUSE_AUTOMATION`
>
> Remove an automation pause and resume autoflows for a SendPulse Live Chat contact.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID whose autoflows will be resumed.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Disable Live Chat Contact
>
> **Slug:** `SEND_PULSE_LIVE_CHAT_DISABLE_CONTACT`
>
> Disable a Live Chat contact so campaigns and autoflows are no longer sent.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID to disable.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Enable Live Chat Contact
>
> **Slug:** `SEND_PULSE_LIVE_CHAT_ENABLE_CONTACT`
>
> Enable a Live Chat contact to receive campaigns and autoflows.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID to enable.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Live Chat Chatbot Account
>
> **Slug:** `SEND_PULSE_LIVE_CHAT_GET_ACCOUNT`
>
> Get pricing-plan limits and usage for the Live Chat chatbot service.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Live Chat Bot Statistics
>
> **Slug:** `SEND_PULSE_LIVE_CHAT_GET_BOT_STATISTICS`
>
> Get aggregate subscriber and outgoing-message statistics for a Live Chat bot.
>
> #### Input Parameters
>
> **bot\_id** `string` *required*
>
> Bot ID whose aggregate statistics to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Live Chat Messages
>
> **Slug:** `SEND_PULSE_LIVE_CHAT_GET_CHAT_MESSAGES`
>
> Get one page of messages exchanged with a Live Chat chatbot contact.
>
> #### Input Parameters
>
> **size** `integer`
>
> Number of messages requested per page.
>
> **skip** `integer`
>
> Zero-based message offset.
>
> **order** `string ("asc" | "desc")`
>
> Message sort order.
>
> **cursor** `string`
>
> Continuation cursor returned by a previous call.
>
> **contact\_id** `string` *required*
>
> Contact ID whose message history to retrieve.
>
> **search\_after** `string`
>
> Message ID after which to search.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Live Chat Chats
>
> **Slug:** `SEND_PULSE_LIVE_CHAT_GET_CHATS`
>
> Get one page of chats for a Live Chat bot.
>
> #### Input Parameters
>
> **size** `integer`
>
> Number of chats requested per page.
>
> **skip** `integer`
>
> Zero-based chat offset.
>
> **bot\_id** `string` *required*
>
> Bot ID whose chats to retrieve.
>
> **cursor** `string`
>
> Continuation cursor returned by a previous call.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Live Chat Contact
>
> **Slug:** `SEND_PULSE_LIVE_CHAT_GET_CONTACT`
>
> Get a Live Chat chatbot contact by contact ID.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Contact ID to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Live Chat Contact Notes
>
> **Slug:** `SEND_PULSE_LIVE_CHAT_GET_CONTACT_NOTES`
>
> Get internal operator notes for a Live Chat chatbot contact.
>
> #### Input Parameters
>
> **bot\_id** `string` *required*
>
> Bot ID associated with the contact.
>
> **contact\_id** `string` *required*
>
> Contact ID whose operator notes to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Live Chat Contact Automation Pause
>
> **Slug:** `SEND_PULSE_LIVE_CHAT_GET_CONTACT_PAUSE_AUTOMATION`
>
> Get the remaining automation pause for a Live Chat chatbot contact.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID whose automation pause to inspect.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Live Chat Contacts by Tag
>
> **Slug:** `SEND_PULSE_LIVE_CHAT_GET_CONTACTS_BY_TAG`
>
> Get one page of Live Chat chatbot contacts matching a tag.
>
> #### Input Parameters
>
> **tag** `string` *required*
>
> Exact contact tag to match.
>
> **size** `integer`
>
> Number of contacts requested per page.
>
> **skip** `integer`
>
> Zero-based contact offset.
>
> **bot\_id** `string` *required*
>
> Bot ID whose contacts to search.
>
> **cursor** `string`
>
> Continuation cursor returned by a previous call.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Live Chat Contacts by Variable
>
> **Slug:** `SEND_PULSE_LIVE_CHAT_GET_CONTACTS_BY_VARIABLE`
>
> Get one page of Live Chat chatbot contacts matching a variable value.
>
> #### Input Parameters
>
> **size** `integer`
>
> Number of contacts requested per page.
>
> **skip** `integer`
>
> Zero-based contact offset.
>
> **bot\_id** `string`
>
> Bot ID required with variable\_name.
>
> **cursor** `string`
>
> Continuation cursor returned by a previous call.
>
> **variable\_id** `string`
>
> Variable ID to match instead of a variable name and bot ID.
>
> **variable\_name** `string`
>
> Variable name to match when bot\_id is also provided.
>
> **variable\_value** `string` *required*
>
> Variable value to match.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Live Chat Flows
>
> **Slug:** `SEND_PULSE_LIVE_CHAT_GET_FLOWS`
>
> Get one page of automation flows for a Live Chat bot.
>
> #### Input Parameters
>
> **size** `integer`
>
> Number of flows requested per page.
>
> **skip** `integer`
>
> Zero-based flow offset.
>
> **bot\_id** `string` *required*
>
> Bot ID whose flows to retrieve.
>
> **cursor** `string`
>
> Continuation cursor returned by a previous call.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Live Chat Triggers
>
> **Slug:** `SEND_PULSE_LIVE_CHAT_GET_TRIGGERS`
>
> Get one page of automation triggers for a Live Chat bot.
>
> #### Input Parameters
>
> **size** `integer`
>
> Number of triggers requested per page.
>
> **skip** `integer`
>
> Zero-based trigger offset.
>
> **bot\_id** `string` *required*
>
> Bot ID whose triggers to retrieve.
>
> **cursor** `string`
>
> Continuation cursor returned by a previous call.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Live Chat List Bot Variables
>
> **Slug:** `SEND_PULSE_LIVE_CHAT_LIST_BOT_VARIABLES`
>
> Returns 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
>
> **size** `integer`
>
> The limit of pagination items, that will be returned
>
> **skip** `integer`
>
> The offset of pagination items, where starts a current items batch
>
> **bot\_id** `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.
>
> **cursor** `string`
>
> Continuation cursor returned by a previous call.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Live Chat Tags
>
> **Slug:** `SEND_PULSE_LIVE_CHAT_LIST_TAGS`
>
> Get one page of tags for a Live Chat bot.
>
> #### Input Parameters
>
> **size** `integer`
>
> Number of tags requested per page.
>
> **skip** `integer`
>
> Zero-based tag offset.
>
> **bot\_id** `string` *required*
>
> Bot ID whose tags to retrieve.
>
> **cursor** `string`
>
> Continuation cursor returned by a previous call.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Mark Live Chat Contact Messages Read
>
> **Slug:** `SEND_PULSE_LIVE_CHAT_MARK_CONTACT_MESSAGES_READ`
>
> Mark all messages from a SendPulse Live Chat contact as read.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID whose unread count will be reset.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Mark Live Chat Contact Unread
>
> **Slug:** `SEND_PULSE_LIVE_CHAT_MARK_CONTACT_UNREAD`
>
> Mark the last message from a SendPulse Live Chat contact as unread.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID whose last message will be marked unread.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Open Live Chat Contact Chat
>
> **Slug:** `SEND_PULSE_LIVE_CHAT_OPEN_CONTACT_CHAT`
>
> Increase a SendPulse Live Chat contact's chat priority by marking it open.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID whose chat will be opened.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Run Live Chat Flow
>
> **Slug:** `SEND_PULSE_LIVE_CHAT_RUN_FLOW`
>
> Launch a SendPulse Live Chat flow by ID for a contact.
>
> #### Input Parameters
>
> **flow\_id** `string` *required*
>
> Flow ID to launch.
>
> **contact\_id** `string` *required*
>
> Contact ID for which to launch the flow.
>
> **external\_data** `object`
>
> Custom variable values available during this flow run.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Run Live Chat Flow by Trigger
>
> **Slug:** `SEND_PULSE_LIVE_CHAT_RUN_FLOW_BY_TRIGGER`
>
> Launch a SendPulse Live Chat flow by trigger keyword for a contact.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID for which to launch the flow.
>
> **external\_data** `object`
>
> Custom variable values available during this flow run.
>
> **trigger\_keyword** `string` *required*
>
> Trigger keyword that launches the flow.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Send Live Chat Contact Message
>
> **Slug:** `SEND_PULSE_LIVE_CHAT_SEND_CONTACT_MESSAGE`
>
> Send one or more messages to a SendPulse Live Chat contact.
>
> #### Input Parameters
>
> **messages** `array` *required*
>
> Messages and channel-specific content to send.
>
> **contact\_id** `string` *required*
>
> Contact ID that will receive the messages.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Set Live Chat Contact Name
>
> **Slug:** `SEND_PULSE_LIVE_CHAT_SET_CONTACT_NAME`
>
> Update the display name of a SendPulse Live Chat contact.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> New contact display name.
>
> **contact\_id** `string` *required*
>
> Contact ID whose display name to update.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Set Live Chat Contact Tags
>
> **Slug:** `SEND_PULSE_LIVE_CHAT_SET_CONTACT_TAG`
>
> Assign one or more tags to a SendPulse Live Chat contact.
>
> #### Input Parameters
>
> **tags** `array` *required*
>
> Tags to assign to the contact.
>
> **contact\_id** `string` *required*
>
> Contact ID to tag.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Set Live Chat Contact Variables
>
> **Slug:** `SEND_PULSE_LIVE_CHAT_SET_CONTACT_VARIABLE`
>
> Add or update variable values for a SendPulse Live Chat contact.
>
> #### Input Parameters
>
> **variables** `array` *required*
>
> Variables and values to assign.
>
> **contact\_id** `string` *required*
>
> Contact ID whose variables to update.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Pause Live Chat Contact Automation
>
> **Slug:** `SEND_PULSE_LIVE_CHAT_SET_PAUSE_AUTOMATION`
>
> Pause autoflows for a SendPulse Live Chat contact for a specified duration.
>
> #### Input Parameters
>
> **minutes** `integer` *required*
>
> Number of minutes to pause autoflows.
>
> **contact\_id** `string` *required*
>
> Contact ID whose autoflows to pause.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Unassign Live Chat Contact Operators
>
> **Slug:** `SEND_PULSE_LIVE_CHAT_UN_ASSIGN_CONTACT_OPERATORS`
>
> Remove the responsible operator assignment from a SendPulse Live Chat contact.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID whose operator assignment to remove.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Live Chat Contact Note
>
> **Slug:** `SEND_PULSE_LIVE_CHAT_UPDATE_CONTACT_NOTE`
>
> Replace the text of an operator note for a SendPulse Live Chat contact.
>
> #### Input Parameters
>
> **text** `string` *required*
>
> Replacement note text.
>
> **bot\_id** `string` *required*
>
> Bot ID associated with the contact.
>
> **note\_id** `string` *required*
>
> Note ID to update.
>
> **contact\_id** `string` *required*
>
> Contact ID associated with the note.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Popup Project
>
> **Slug:** `SEND_PULSE_POPUPS_CREATE_WIDGET`
>
> Create a SendPulse project that can contain popup widgets.
>
> #### Input Parameters
>
> **url** `string`
>
> Absolute project website URL.
>
> **name** `string`
>
> Project name.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Popup
>
> **Slug:** `SEND_PULSE_POPUPS_DELETE_POPUP`
>
> Permanently delete a SendPulse popup and its display rules and statistics.
>
> #### Input Parameters
>
> **popup\_id** `string` *required*
>
> Popup UUID to permanently delete.
>
> **is\_enabled** `boolean`
>
> Optional deletion state flag documented by SendPulse.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Popup NPS Statistics
>
> **Slug:** `SEND_PULSE_POPUPS_GET_NPS_STATISTICS_BY_POPUP_ID`
>
> Get NPS variant vote totals and button details for a SendPulse popup.
>
> #### Input Parameters
>
> **end** `integer`
>
> Optional end date as a Unix timestamp.
>
> **start** `integer`
>
> Optional start date as a Unix timestamp.
>
> **popup\_id** `string` *required*
>
> NPS popup UUID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Aggregated Popup NPS Statistics
>
> **Slug:** `SEND_PULSE_POPUPS_GET_POPUP_AGGREGATED_NPS_STATISTICS`
>
> Get aggregated NPS results for a SendPulse popup and optional time range.
>
> #### Input Parameters
>
> **end** `integer`
>
> Optional end Unix timestamp.
>
> **start** `integer`
>
> Optional start Unix timestamp.
>
> **popup\_id** `string` *required*
>
> NPS popup UUID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Popup Conditions
>
> **Slug:** `SEND_PULSE_POPUPS_GET_POPUP_CONDITIONS`
>
> Get all available targeting and display conditions for SendPulse popups.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Popup Statistics
>
> **Slug:** `SEND_PULSE_POPUPS_GET_POPUP_STATISTICS`
>
> Get engagement statistics for a SendPulse popup and optional time range.
>
> #### Input Parameters
>
> **end** `integer`
>
> Optional end Unix timestamp.
>
> **start** `integer`
>
> Optional start Unix timestamp.
>
> **popup\_id** `string` *required*
>
> Popup UUID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Project Popup Statistics
>
> **Slug:** `SEND_PULSE_POPUPS_GET_PROJECT_WIDGET_STATISTICS`
>
> Get aggregate engagement statistics for all popups in a SendPulse project.
>
> #### Input Parameters
>
> **end** `integer`
>
> Optional end Unix timestamp.
>
> **start** `integer`
>
> Optional start Unix timestamp.
>
> **project\_id** `string` *required*
>
> Popup project UUID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Popup Subscriber
>
> **Slug:** `SEND_PULSE_POPUPS_GET_SUBSCRIBER_BY_ID`
>
> Get detailed information about a SendPulse popup subscriber.
>
> #### Input Parameters
>
> **subscriber\_id** `integer` *required*
>
> Subscriber ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Subscribers By Popup
>
> **Slug:** `SEND_PULSE_POPUPS_GET_SUBSCRIBERS_BY_POPUP`
>
> Get subscribers acquired through a specific SendPulse popup.
>
> #### Input Parameters
>
> **popup\_id** `string` *required*
>
> Popup UUID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Popup Tariff Limits
>
> **Slug:** `SEND_PULSE_POPUPS_GET_TARIFF_LIMITS`
>
> Get the authenticated account's SendPulse popup plan limits.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Popups By Project
>
> **Slug:** `SEND_PULSE_POPUPS_LIST_POPUPS_BY_PROJECT_ID`
>
> Get one page of popups associated with a SendPulse popup project.
>
> #### Input Parameters
>
> **first** `integer`
>
> Maximum popups to return on this page.
>
> **project\_id** `string` *required*
>
> Popup project UUID.
>
> **next\_cursor** `string`
>
> Opaque cursor from the previous page; omit for the first page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Quiz Popups By Project
>
> **Slug:** `SEND_PULSE_POPUPS_LIST_QUIZ_POPUPS_BY_PROJECT`
>
> Get one page of quiz popups associated with a SendPulse popup project.
>
> #### Input Parameters
>
> **first** `integer`
>
> Maximum quiz popups to return on this page.
>
> **project\_id** `string` *required*
>
> Popup project UUID.
>
> **next\_cursor** `string`
>
> Opaque cursor from the previous page; omit for the first page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Subscribers By Popup Project
>
> **Slug:** `SEND_PULSE_POPUPS_LIST_SUBSCRIBERS_BY_PROJECT`
>
> List subscribers associated with a SendPulse popup project.
>
> #### Input Parameters
>
> **project\_id** `string` *required*
>
> Popup project UUID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Popup Projects
>
> **Slug:** `SEND_PULSE_POPUPS_LIST_WIDGETS`
>
> Get one page of SendPulse popup projects.
>
> #### Input Parameters
>
> **first** `integer`
>
> Maximum projects to return on this page.
>
> **next\_cursor** `string`
>
> Opaque cursor from the previous page; omit for the first page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Set Popup State
>
> **Slug:** `SEND_PULSE_POPUPS_SET_POPUP_STATE`
>
> Enable or disable a SendPulse popup on its website.
>
> #### Input Parameters
>
> **popup\_id** `string` *required*
>
> Popup UUID.
>
> **is\_enabled** `boolean`
>
> True to enable the popup or false to disable it.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Remove Mailing List Contacts
>
> **Slug:** `SEND_PULSE_REMOVE_MAILING_LIST_CONTACTS`
>
> Remove a batch of email addresses from one Bulk Email mailing list without globally blacklisting them.
>
> #### Input Parameters
>
> **emails** `array` *required*
>
> Email addresses to remove from this mailing list; SendPulse allows at most 100 per request.
>
> **mailing\_list\_id** `integer` *required*
>
> ID of the mailing list from which to remove contacts.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Files
>
> **Slug:** `SEND_PULSE_SEARCH_FILES`
>
> Search recursively for File Manager files by keyword within a directory path.
>
> #### Input Parameters
>
> **query** `string` *required*
>
> Keyword to match against File Manager files.
>
> **directory\_path** `string`
>
> Directory path from which to search recursively.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Add SMS Blacklist Entries
>
> **Slug:** `SEND_PULSE_SMS_ADD_SMS_BLACKLIST`
>
> Globally suppress phone numbers from future SendPulse SMS messages.
>
> #### Input Parameters
>
> **phones** `array` *required*
>
> Phone numbers to suppress globally from SMS sending.
>
> **description** `string` *required*
>
> Reason for blacklisting the phone numbers.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Add phone numbers to a mailing list
>
> **Slug:** `SEND_PULSE_SMS_ADD_SMS_NUMBERS`
>
> Add phone numbers to a mailing list using the official SendPulse sms API.
>
> #### Input Parameters
>
> **phones** `array` *required*
>
> Phones.
>
> **address\_book\_id** `integer` *required*
>
> Mailing list ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Add phone numbers with complex variables
>
> **Slug:** `SEND_PULSE_SMS_ADD_SMS_NUMBERS_WITH_VARIABLES`
>
> Add phone numbers with complex variables using the official SendPulse sms API.
>
> #### Input Parameters
>
> **phones** `object` *required*
>
> Phones.
>
> **address\_book\_id** `integer` *required*
>
> Mailing list ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Calculate SMS Campaign Cost
>
> **Slug:** `SEND_PULSE_SMS_CALCULATE_SMS_COST`
>
> Estimate the SendPulse price and currency for an SMS campaign without sending it.
>
> #### Input Parameters
>
> **body** `string` *required*
>
> SMS message text to price.
>
> **route** `string`
>
> Optional route configuration serialized as a JSON object.
>
> **phones** `array`
>
> Phone numbers to price instead of a mailing list.
>
> **sender** `string` *required*
>
> SMS sender name used for the estimate.
>
> **address\_book\_id** `integer`
>
> Mailing-list ID whose phone numbers should be priced.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Cancel a campaign before sending has started
>
> **Slug:** `SEND_PULSE_SMS_CANCEL_SMS_CAMPAIGN`
>
> Cancel a campaign before sending has started using the official SendPulse sms API.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> Id.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create a campaign for a mailing list
>
> **Slug:** `SEND_PULSE_SMS_CREATE_SMS_CAMPAIGN`
>
> Create a campaign for a mailing list using the official SendPulse sms API.
>
> #### Input Parameters
>
> **body** `string` *required*
>
> Body.
>
> **date** `string`
>
> Date.
>
> **route** `object`
>
> e.g. \{'UA':'national'}
>
> **sender** `string` *required*
>
> Sender.
>
> **emulate** `boolean`
>
> Emulate.
>
> **address\_book\_id** `integer` *required*
>
> Mailing list ID.
>
> **use\_dynamic\_list** `boolean`
>
> Use dynamic list.
>
> **stat\_link\_tracking** `boolean`
>
> Stat link tracking.
>
> **stat\_link\_need\_protocol** `boolean`
>
> Stat link need protocol.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete SMS Campaign
>
> **Slug:** `SEND_PULSE_SMS_DELETE_SMS_CAMPAIGN`
>
> Permanently delete an SMS campaign that has not started.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> SMS campaign ID to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get SMS Blacklist
>
> **Slug:** `SEND_PULSE_SMS_GET_SMS_BLACKLIST`
>
> Get the SendPulse SMS phone-number suppression list.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get SMS Campaign Information
>
> **Slug:** `SEND_PULSE_SMS_GET_SMS_CAMPAIGN_INFO`
>
> Get SendPulse delivery and spend information for an SMS campaign.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> SMS campaign ID to inspect.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get SMS Number Information
>
> **Slug:** `SEND_PULSE_SMS_GET_SMS_NUMBER_INFO`
>
> Get profile and variable information for a phone number in a SendPulse mailing list.
>
> #### Input Parameters
>
> **phone\_number** `string` *required*
>
> Phone number whose mailing-list profile to retrieve.
>
> **address\_book\_id** `integer` *required*
>
> Mailing-list ID containing the phone number.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Remove Numbers From SMS Blacklist
>
> **Slug:** `SEND_PULSE_SMS_REMOVE_SMS_BLACKLIST`
>
> Remove phone numbers from the account-wide SMS blacklist.
>
> #### Input Parameters
>
> **phones** `array` *required*
>
> Phone numbers to remove from the SMS blacklist.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Remove SMS Numbers From Mailing List
>
> **Slug:** `SEND_PULSE_SMS_REMOVE_SMS_NUMBERS`
>
> Remove phone numbers from one mailing list without globally blacklisting them.
>
> #### Input Parameters
>
> **phones** `array` *required*
>
> Phone numbers to remove from the mailing list.
>
> **addressBookId** `integer` *required*
>
> Mailing list ID from which to remove the numbers.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create a campaign for a list of phone numbers
>
> **Slug:** `SEND_PULSE_SMS_SEND_SMS_TO_NUMBERS`
>
> Create a campaign for a list of phone numbers using the official SendPulse sms API.
>
> #### Input Parameters
>
> **body** `string` *required*
>
> Body.
>
> **date** `string`
>
> Date.
>
> **route** `object`
>
> Route.
>
> **phones** `array` *required*
>
> Phones.
>
> **sender** `string` *required*
>
> Sender.
>
> **emulate** `boolean`
>
> Emulate.
>
> **stat\_link\_tracking** `boolean`
>
> Stat link tracking.
>
> **stat\_link\_need\_protocol** `boolean`
>
> Stat link need protocol.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update variables for multiple phone numbers
>
> **Slug:** `SEND_PULSE_SMS_UPDATE_SMS_VARIABLES_BATCH`
>
> Update variables for multiple phone numbers using the official SendPulse sms API.
>
> #### Input Parameters
>
> **phones** `array` *required*
>
> Phones.
>
> **variables** `array` *required*
>
> Variables.
>
> **address\_book\_id** `integer` *required*
>
> Mailing list ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update SMS Contact Variables
>
> **Slug:** `SEND_PULSE_SMS_UPDATE_SMS_VARIABLES_SINGLE`
>
> Change custom variables for one SMS contact in a SendPulse address book.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> Address book ID.
>
> **phone** `string` *required*
>
> Phone number of the contact to update. Common formatting is removed before sending.
>
> **variables** `array` *required*
>
> Variables and values to update.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Add a domain
>
> **Slug:** `SEND_PULSE_SMTP_ADD_SMTP_DOMAIN`
>
> Add a domain using the official SendPulse smtp API.
>
> #### Input Parameters
>
> **domain** `string` *required*
>
> Domain.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get SMTP Allowed Domains
>
> **Slug:** `SEND_PULSE_SMTP_GET_SMTP_ALLOWED_DOMAINS`
>
> List SMTP sender domains and their SPF, DKIM, and DMARC validation status.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Daily SMTP Bounces
>
> **Slug:** `SEND_PULSE_SMTP_GET_SMTP_BOUNCES_DAY`
>
> Get one page of SendPulse SMTP bounce records for a 24-hour period.
>
> #### Input Parameters
>
> **date** `string`
>
> UTC report date in YYYY-MM-DD format.
>
> **limit** `integer`
>
> Number of bounce records requested per page.
>
> **cursor** `string`
>
> Continuation cursor returned by a previous call.
>
> **offset** `integer`
>
> Zero-based bounce record offset.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get SMTP Bounce Total
>
> **Slug:** `SEND_PULSE_SMTP_GET_SMTP_BOUNCES_TOTAL`
>
> Get the total SendPulse SMTP bounce count for the last 24-hour period.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get SMTP Email Information
>
> **Slug:** `SEND_PULSE_SMTP_GET_SMTP_EMAIL_INFO`
>
> Get delivery, SMTP response, and tracking details for a SendPulse SMTP email.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> SMTP email ID to inspect.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get SMTP Emails
>
> **Slug:** `SEND_PULSE_SMTP_GET_SMTP_EMAILS`
>
> Get one page of historical SendPulse SMTP delivery records.
>
> #### Input Parameters
>
> **to** `string`
>
> End date in YYYY-MM-DD format.
>
> **limit** `integer`
>
> Number of SMTP email records requested per page.
>
> **cursor** `string`
>
> Offset cursor returned by a previous call.
>
> **offset** `integer`
>
> Zero-based SMTP email record offset.
>
> **sender** `string`
>
> Sender email address filter.
>
> **country** `string`
>
> Recipient country filter.
>
> **date\_from** `string`
>
> Start date in YYYY-MM-DD format.
>
> **recipient** `string`
>
> Recipient email address filter.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get information for a list of emails
>
> **Slug:** `SEND_PULSE_SMTP_GET_SMTP_EMAILS_BATCH_INFO`
>
> Get information for a list of emails using the official SendPulse smtp API.
>
> #### Input Parameters
>
> **emails** `array` *required*
>
> Emails.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get SMTP Email Total
>
> **Slug:** `SEND_PULSE_SMTP_GET_SMTP_EMAILS_TOTAL`
>
> Get the cumulative count of emails sent through SendPulse SMTP.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get SMTP IP Addresses
>
> **Slug:** `SEND_PULSE_SMTP_GET_SMTP_IPS`
>
> List outbound IP addresses used by the SendPulse SMTP relay.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get SMTP Senders
>
> **Slug:** `SEND_PULSE_SMTP_GET_SMTP_SENDERS`
>
> List verified email addresses authorized to send through SendPulse SMTP.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get SMTP Unsubscribed Users
>
> **Slug:** `SEND_PULSE_SMTP_GET_SMTP_UNSUBSCRIBED`
>
> Get one page of email addresses suppressed from SendPulse SMTP delivery.
>
> #### Input Parameters
>
> **date** `string`
>
> Unsubscribe date filter in YYYY-MM-DD format.
>
> **limit** `integer`
>
> Number of unsubscribe records requested per page.
>
> **cursor** `string`
>
> Offset cursor returned by a previous call.
>
> **offset** `integer`
>
> Zero-based unsubscribe record offset.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Remove SMTP Unsubscribes
>
> **Slug:** `SEND_PULSE_SMTP_REMOVE_SMTP_UNSUBSCRIBE`
>
> Remove explicitly re-consented email addresses from the SMTP unsubscribe list.
>
> #### Input Parameters
>
> **emails** `array` *required*
>
> Email addresses to remove from the SMTP unsubscribe list.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Resubscribe a recipient
>
> **Slug:** `SEND_PULSE_SMTP_RESUBSCRIBE_SMTP_RECIPIENT`
>
> Resubscribe a recipient using the official SendPulse smtp API.
>
> #### Input Parameters
>
> **lang** `string ("ru" | "en" | "ua" | "tr" | "es" | "pt")`
>
> Lang.
>
> **email** `string` *required*
>
> Email.
>
> **sender** `string` *required*
>
> Sender.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search SMTP Unsubscribe Status
>
> **Slug:** `SEND_PULSE_SMTP_SEARCH_SMTP_UNSUBSCRIBE`
>
> Check whether an email address is suppressed from SendPulse SMTP sending.
>
> #### Input Parameters
>
> **email** `string` *required*
>
> Email address whose SMTP suppression status to check.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Send an email
>
> **Slug:** `SEND_PULSE_SMTP_SEND_SMTP_EMAIL`
>
> Send 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
>
> **email** `object` *required*
>
> Email.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Unsubscribe a recipient
>
> **Slug:** `SEND_PULSE_SMTP_UNSUBSCRIBE_SMTP_RECIPIENTS`
>
> Unsubscribe a recipient using the official SendPulse smtp API.
>
> #### Input Parameters
>
> **recipients** `array` *required*
>
> Recipients to unsubscribe.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Assign Telegram Contact Operator
>
> **Slug:** `SEND_PULSE_TELEGRAM_ASSIGN_CONTACT_OPERATOR`
>
> Assign an operator as responsible for a SendPulse Telegram contact chat.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID whose chat should be assigned.
>
> **operator\_id** `integer` *required*
>
> Operator ID to assign as responsible for the chat.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Close Telegram Contact Chat
>
> **Slug:** `SEND_PULSE_TELEGRAM_CLOSE_CONTACT_CHAT`
>
> Close a SendPulse Telegram contact chat and lower its priority.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID whose chat should be closed.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Telegram Contact Note
>
> **Slug:** `SEND_PULSE_TELEGRAM_CREATE_CONTACT_NOTE`
>
> Create an internal operator note for a SendPulse Telegram contact.
>
> #### Input Parameters
>
> **text** `string` *required*
>
> Operator note text.
>
> **bot\_id** `string` *required*
>
> Bot ID associated with the contact.
>
> **contact\_id** `string` *required*
>
> Contact ID to annotate.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Telegram Contact
>
> **Slug:** `SEND_PULSE_TELEGRAM_DELETE_CONTACT`
>
> Remove a SendPulse Telegram contact from the audience and subscriber list.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID to remove from the audience and subscriber list.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Telegram Contact Note
>
> **Slug:** `SEND_PULSE_TELEGRAM_DELETE_CONTACT_NOTE`
>
> Delete an operator note from a SendPulse Telegram contact.
>
> #### Input Parameters
>
> **bot\_id** `string` *required*
>
> Bot ID associated with the contact.
>
> **note\_id** `string` *required*
>
> Note ID to delete.
>
> **contact\_id** `string` *required*
>
> Contact ID associated with the note.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Resume Telegram Contact Autoflows
>
> **Slug:** `SEND_PULSE_TELEGRAM_DELETE_CONTACT_PAUSE_AUTOMATION`
>
> Resume paused autoflows for a SendPulse Telegram contact.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID whose autoflows should resume.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Telegram Contact Tag
>
> **Slug:** `SEND_PULSE_TELEGRAM_DELETE_CONTACT_TAG`
>
> Remove a tag from a SendPulse Telegram contact.
>
> #### Input Parameters
>
> **tag** `string` *required*
>
> Tag to remove from the contact.
>
> **contact\_id** `string` *required*
>
> Contact ID to update.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Telegram Contact Variable
>
> **Slug:** `SEND_PULSE_TELEGRAM_DELETE_CONTACT_VARIABLE`
>
> Delete a variable value from a SendPulse Telegram contact by variable ID or name.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID to update.
>
> **variable\_id** `string`
>
> ID of the variable to delete.
>
> **variable\_name** `string`
>
> Name of the variable to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Disable Telegram Contact
>
> **Slug:** `SEND_PULSE_TELEGRAM_DISABLE_CONTACT`
>
> Disable a SendPulse Telegram contact so campaigns and autoflows are no longer sent.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID to disable.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Enable Telegram Contact
>
> **Slug:** `SEND_PULSE_TELEGRAM_ENABLE_CONTACT`
>
> Enable a SendPulse Telegram contact to receive campaigns and autoflows.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID to enable.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Telegram Get Account
>
> **Slug:** `SEND_PULSE_TELEGRAM_GET_ACCOUNT`
>
> Returns information about the current Telegram account pricing plan and usage, including message, bot, contact, tag, and variable limits or statistics.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Telegram Get Bot Statistics
>
> **Slug:** `SEND_PULSE_TELEGRAM_GET_BOT_STATISTICS`
>
> Returns general statistics info by bot
>
> #### Input Parameters
>
> **bot\_id** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get a list of variables
>
> **Slug:** `SEND_PULSE_TELEGRAM_GET_BOT_VARIABLES`
>
> Returns 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
>
> **size** `integer`
>
> Maximum items to return on this page.
>
> **bot\_id** `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.
>
> **next\_cursor** `string`
>
> Opaque cursor returned by the previous page; omit for the first page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Telegram Get Chat Messages
>
> **Slug:** `SEND_PULSE_TELEGRAM_GET_CHAT_MESSAGES`
>
> Returns a page of messages in correspondence with the specified subscriber, with a continuation cursor for further pages.
>
> #### Input Parameters
>
> **size** `integer`
>
> The limit of pagination items, that will be returned
>
> **skip** `integer`
>
> The offset of pagination items, where starts a current items batch
>
> **order** `string ("asc" | "desc")`
>
> Sort order ASC or DESC
>
> **cursor** `string`
>
> Continuation cursor returned by a previous call.
>
> **contact\_id** `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.
>
> **search\_after** `string`
>
> The id of element after which elements will be searched
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Telegram Get Contact
>
> **Slug:** `SEND_PULSE_TELEGRAM_GET_CONTACT`
>
> Returns information on the selected contact: bot and contact ID, information from messenger, list of tags and variables, activity data and date added
>
> #### Input Parameters
>
> **id** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Telegram Get Contact By Telegram Id
>
> **Slug:** `SEND_PULSE_TELEGRAM_GET_CONTACT_BY_TELEGRAM_ID`
>
> Returns a bot contact by Telegram ID.
>
> #### Input Parameters
>
> **bot\_id** `string` *required*
>
> Bot identifier
>
> **telegram\_id** `integer` *required*
>
> Telegram ID of the user or chat
>
> **business\_connection\_id** `string`
>
> Telegram business connection identifier (optional)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Telegram Get Contact Notes
>
> **Slug:** `SEND_PULSE_TELEGRAM_GET_CONTACT_NOTES`
>
> Returns a list of existing operator notes by contact
>
> #### Input Parameters
>
> **bot\_id** `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.
>
> **contact\_id** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Telegram Get Contact Pause Automation
>
> **Slug:** `SEND_PULSE_TELEGRAM_GET_CONTACT_PAUSE_AUTOMATION`
>
> Returns the time remaining until autoflows are stopped for this contact
>
> #### Input Parameters
>
> **contact\_id** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Telegram Get Contacts By Tag
>
> **Slug:** `SEND_PULSE_TELEGRAM_GET_CONTACTS_BY_TAG`
>
> Returns a list of contacts by tag for the specified bot
>
> #### Input Parameters
>
> **tag** `string` *required*
>
> Created contacts tag to search by
>
> **size** `integer`
>
> The limit of pagination items, that will be returned
>
> **skip** `integer`
>
> The offset of pagination items, where starts a current items batch
>
> **bot\_id** `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.
>
> **cursor** `string`
>
> Continuation cursor returned by a previous call.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Telegram Get Contacts By Variable
>
> **Slug:** `SEND_PULSE_TELEGRAM_GET_CONTACTS_BY_VARIABLE`
>
> Returns contacts matching a variable value, identified by variable ID or by variable name and bot ID.
>
> #### Input Parameters
>
> **size** `integer`
>
> The limit of pagination items, that will be returned
>
> **skip** `integer`
>
> The offset of pagination items, where starts a current items batch
>
> **bot\_id** `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.
>
> **cursor** `string`
>
> Continuation cursor returned by a previous call.
>
> **variable\_id** `string`
>
> Contacts variable ID to search by; required parameter if you do not pass variable\_name and bot\_id.
>
> **variable\_name** `string`
>
> Contacts variable name to search by; required parameter and passed with the bot\_id parameter, if you do not pass variable\_id.
>
> **variable\_value** `string` *required*
>
> Contact's variable value
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Telegram Get Flows
>
> **Slug:** `SEND_PULSE_TELEGRAM_GET_FLOWS`
>
> Returns 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
>
> **size** `integer`
>
> The limit of pagination items, that will be returned
>
> **skip** `integer`
>
> The offset of pagination items, where starts a current items batch
>
> **bot\_id** `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.
>
> **cursor** `string`
>
> Continuation cursor returned by a previous call.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get a list of tags
>
> **Slug:** `SEND_PULSE_TELEGRAM_GET_TAGS`
>
> Returns 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
>
> **size** `integer`
>
> Maximum items to return on this page.
>
> **bot\_id** `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.
>
> **next\_cursor** `string`
>
> Opaque cursor returned by the previous page; omit for the first page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get a list of triggers
>
> **Slug:** `SEND_PULSE_TELEGRAM_GET_TRIGGERS`
>
> Returns 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
>
> **size** `integer`
>
> Maximum items to return on this page.
>
> **bot\_id** `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.
>
> **next\_cursor** `string`
>
> Opaque cursor returned by the previous page; omit for the first page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Telegram List Chats
>
> **Slug:** `SEND_PULSE_TELEGRAM_LIST_CHATS`
>
> Returns a list of chats with subscribers with information about the contact and the last message received from the contact
>
> #### Input Parameters
>
> **size** `integer`
>
> Provider size query parameter.
>
> **skip** `integer`
>
> Provider skip query parameter.
>
> **bot\_id** `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.
>
> **cursor** `string`
>
> Continuation cursor returned by a previous call.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Mark Telegram Contact Messages Read
>
> **Slug:** `SEND_PULSE_TELEGRAM_MARK_CONTACT_MESSAGES_AS_READ`
>
> Mark all messages from a SendPulse Telegram contact as read.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> ID of the Telegram contact whose unread message count will be reset.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Mark Telegram Contact Unread
>
> **Slug:** `SEND_PULSE_TELEGRAM_MARK_CONTACT_UNREAD`
>
> Mark the last message from a SendPulse Telegram contact as unread.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> ID of the Telegram contact whose last message will be marked unread.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Open Telegram Contact Chat
>
> **Slug:** `SEND_PULSE_TELEGRAM_OPEN_CONTACT_CHAT`
>
> Open a SendPulse Telegram contact chat and increase its priority.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID whose chat should be opened.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Pause Telegram Contact Autoflows
>
> **Slug:** `SEND_PULSE_TELEGRAM_PAUSE_CONTACT_AUTOFLOWS`
>
> Pause autoflows for a SendPulse Telegram contact for a specified number of minutes.
>
> #### Input Parameters
>
> **minutes** `integer` *required*
>
> Number of minutes to pause autoflows.
>
> **contact\_id** `string` *required*
>
> Contact ID whose autoflows should be paused.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] React to Telegram Message
>
> **Slug:** `SEND_PULSE_TELEGRAM_REACT_TO_MESSAGE`
>
> Send an emoji reaction to a specific message from a SendPulse Telegram contact.
>
> #### Input Parameters
>
> **reaction** `object` *required*
>
> Reaction details.
>
> **contact\_id** `string` *required*
>
> Contact ID that owns the message.
>
> **message\_id** `string` *required*
>
> Message ID to react to.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Run Telegram Flow
>
> **Slug:** `SEND_PULSE_TELEGRAM_RUN_FLOW`
>
> Launch a Telegram chatbot flow by ID for a contact.
>
> #### Input Parameters
>
> **flow\_id** `string` *required*
>
> ID of the flow to launch.
>
> **contact\_id** `string` *required*
>
> Contact ID for which to launch the flow.
>
> **external\_data** `object`
>
> One-time custom values available to the launched flow.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Run Telegram Flow by Trigger
>
> **Slug:** `SEND_PULSE_TELEGRAM_RUN_FLOW_BY_TRIGGER`
>
> Launch a Telegram chatbot flow by trigger keyword for a contact.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID for which to launch the flow.
>
> **external\_data** `object`
>
> One-time custom values available to the launched flow.
>
> **trigger\_keyword** `string` *required*
>
> Keyword configured to launch the flow.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Send Telegram Chatbot Campaign
>
> **Slug:** `SEND_PULSE_TELEGRAM_SEND_CAMPAIGN`
>
> Send immediately or schedule a campaign to subscribers of a SendPulse Telegram bot.
>
> #### Input Parameters
>
> **title** `string` *required*
>
> Campaign title.
>
> **bot\_id** `string` *required*
>
> Bot ID whose subscribers will receive the campaign.
>
> **send\_at** `string`
>
> Scheduled date and time in Y-m-d H:i format; omit to send now.
>
> **messages** `array` *required*
>
> Campaign messages to send.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Send Telegram Contact Message
>
> **Slug:** `SEND_PULSE_TELEGRAM_SEND_CONTACT_MESSAGE`
>
> Send text, media, a carousel, or an action message to a SendPulse Telegram contact.
>
> #### Input Parameters
>
> **message** `object` *required*
>
> Message type and content to send.
>
> **contact\_id** `string` *required*
>
> Contact ID to message.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Send Text to Telegram Contact
>
> **Slug:** `SEND_PULSE_TELEGRAM_SEND_TEXT_TO_CONTACT`
>
> Send a text message to a specified SendPulse Telegram contact.
>
> #### Input Parameters
>
> **text** `string` *required*
>
> Text message content, up to 1024 Unicode characters.
>
> **contact\_id** `string` *required*
>
> Contact ID to message.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Set Telegram Contact Tags
>
> **Slug:** `SEND_PULSE_TELEGRAM_SET_CONTACT_TAG`
>
> Assign one or more tags to a SendPulse Telegram contact.
>
> #### Input Parameters
>
> **tags** `array` *required*
>
> Tags to assign to the contact.
>
> **contact\_id** `string` *required*
>
> Contact ID to update.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Set Telegram Contact Variables
>
> **Slug:** `SEND_PULSE_TELEGRAM_SET_CONTACT_VARIABLE`
>
> Add or update one or more variables on a SendPulse Telegram contact.
>
> #### Input Parameters
>
> **variables** `array` *required*
>
> Variables identified by name or ID and their new values.
>
> **contact\_id** `string` *required*
>
> Contact ID to update.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Unassign Telegram Contact Operator
>
> **Slug:** `SEND_PULSE_TELEGRAM_UN_ASSIGN_CONTACT_OPERATOR`
>
> Remove the assigned responsible operator from a SendPulse Telegram contact chat.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID whose responsible operator should be removed.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Telegram Contact Note
>
> **Slug:** `SEND_PULSE_TELEGRAM_UPDATE_CONTACT_NOTE`
>
> Update an existing internal operator note for a Telegram contact.
>
> #### Input Parameters
>
> **text** `string` *required*
>
> Operator note text.
>
> **bot\_id** `string` *required*
>
> Bot ID associated with the contact.
>
> **note\_id** `string` *required*
>
> ID of the operator note to update.
>
> **contact\_id** `string` *required*
>
> Contact ID associated with the note.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Assign TikTok Contact Operator
>
> **Slug:** `SEND_PULSE_TIKTOK_ASSIGN_CONTACT_OPERATOR`
>
> Assign an operator to a TikTok contact chat.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID whose chat to assign.
>
> **operator\_id** `integer` *required*
>
> ID of the operator to assign.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Close TikTok Contact Chat
>
> **Slug:** `SEND_PULSE_TIKTOK_CLOSE_CONTACT_CHAT`
>
> Close a TikTok contact chat and lower its queue priority.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID to update.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create TikTok Contact Note
>
> **Slug:** `SEND_PULSE_TIKTOK_CREATE_CONTACT_NOTE`
>
> Create an internal operator note for a TikTok contact.
>
> #### Input Parameters
>
> **text** `string` *required*
>
> Operator note text.
>
> **bot\_id** `string` *required*
>
> Bot ID associated with the contact.
>
> **contact\_id** `string` *required*
>
> Contact ID to annotate.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete TikTok Contact
>
> **Slug:** `SEND_PULSE_TIKTOK_DELETE_CONTACT`
>
> Permanently remove a contact from a TikTok bot audience.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID to update.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete TikTok Contact Note
>
> **Slug:** `SEND_PULSE_TIKTOK_DELETE_CONTACT_NOTE`
>
> Permanently delete an internal operator note for a TikTok contact.
>
> #### Input Parameters
>
> **bot\_id** `string` *required*
>
> Bot ID associated with the contact.
>
> **note\_id** `string` *required*
>
> ID of the operator note to delete.
>
> **contact\_id** `string` *required*
>
> Contact ID associated with the note.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Resume TikTok Contact Automation
>
> **Slug:** `SEND_PULSE_TIKTOK_DELETE_CONTACT_PAUSE_AUTOMATION`
>
> Remove an automation pause from a TikTok contact.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID to update.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Remove TikTok Contact Tag
>
> **Slug:** `SEND_PULSE_TIKTOK_DELETE_CONTACT_TAG`
>
> Remove a tag from a TikTok contact.
>
> #### Input Parameters
>
> **tag** `string` *required*
>
> Tag to remove from the contact.
>
> **contact\_id** `string` *required*
>
> Contact ID from which to remove the tag.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete TikTok Contact Variable Value
>
> **Slug:** `SEND_PULSE_TIKTOK_DELETE_CONTACT_VARIABLE`
>
> Permanently delete one variable value from a TikTok contact.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID whose variable value to delete.
>
> **variable\_id** `string`
>
> ID of the variable whose value to delete.
>
> **variable\_name** `string`
>
> Name of the variable whose value to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Disable TikTok Contact
>
> **Slug:** `SEND_PULSE_TIKTOK_DISABLE_CONTACT`
>
> Disable a TikTok contact without deleting its data.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID to update.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Enable TikTok Contact
>
> **Slug:** `SEND_PULSE_TIKTOK_ENABLE_CONTACT`
>
> Re-enable a TikTok contact for campaigns and autoflows.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID to update.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get account info
>
> **Slug:** `SEND_PULSE_TIKTOK_GET_ACCOUNT`
>
> Returns information about your current account pricing plan, the number of messages in your plan, bots, contacts, list of tags, and variables
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get general statistics info by bot
>
> **Slug:** `SEND_PULSE_TIKTOK_GET_BOT_STATISTICS`
>
> Returns general statistics info by bot
>
> #### Input Parameters
>
> **bot\_id** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get a list of chats
>
> **Slug:** `SEND_PULSE_TIKTOK_GET_CHAT_LIST`
>
> Returns a list of chats with subscribers with information about the contact and the last message received from the contact
>
> #### Input Parameters
>
> **size** `integer`
>
> Maximum items to return on this page.
>
> **bot\_id** `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.
>
> **next\_cursor** `string`
>
> Opaque cursor returned by the previous page; omit for the first page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get a list of messages
>
> **Slug:** `SEND_PULSE_TIKTOK_GET_CHAT_MESSAGES`
>
> Returns a page of messages in correspondence with the specified TikTok subscriber. Use the returned cursor to retrieve further pages.
>
> #### Input Parameters
>
> **size** `integer`
>
> Maximum items to return on this page.
>
> **order** `string ("asc" | "desc")`
>
> Sort order ASC or DESC
>
> **contact\_id** `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.
>
> **next\_cursor** `string`
>
> Opaque cursor returned by the previous page; omit for the first page.
>
> **search\_after** `string`
>
> The id of element after which elements will be searched
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get contact info via a contact ID
>
> **Slug:** `SEND_PULSE_TIKTOK_GET_CONTACT`
>
> Returns information on the selected contact: bot and contact ID, information from messenger, list of tags and variables, activity data and date added
>
> #### Input Parameters
>
> **id** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get a list of contact's operator notes
>
> **Slug:** `SEND_PULSE_TIKTOK_GET_CONTACT_NOTES`
>
> Returns a list of existing operator notes by contact
>
> #### Input Parameters
>
> **bot\_id** `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.
>
> **contact\_id** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get remaining time for automation pause
>
> **Slug:** `SEND_PULSE_TIKTOK_GET_CONTACT_PAUSE_AUTOMATION`
>
> Returns the time remaining until autoflows are stopped for this contact
>
> #### Input Parameters
>
> **contact\_id** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get a list of contacts by tag
>
> **Slug:** `SEND_PULSE_TIKTOK_GET_CONTACTS_BY_TAG`
>
> Returns a list of contacts by tag for the specified bot
>
> #### Input Parameters
>
> **tag** `string` *required*
>
> Created contact’s tag to search by
>
> **size** `integer`
>
> Maximum items to return on this page.
>
> **bot\_id** `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.
>
> **next\_cursor** `string`
>
> Opaque cursor returned by the previous page; omit for the first page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get contacts by variable
>
> **Slug:** `SEND_PULSE_TIKTOK_GET_CONTACTS_BY_VARIABLE`
>
> Returns TikTok contacts matching a variable value, using a variable ID or a variable name and bot ID.
>
> #### Input Parameters
>
> **size** `integer`
>
> Maximum items to return on this page.
>
> **bot\_id** `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.
>
> **next\_cursor** `string`
>
> Opaque cursor returned by the previous page; omit for the first page.
>
> **variable\_id** `string`
>
> Contact’s variable ID to search by; required parameter if you do not pass variable\_name and bot\_id.
>
> **variable\_name** `string`
>
> Contact’s variable name to search by; required parameter and passed with the bot\_id parameter, if you do not pass variable\_id.
>
> **variable\_value** `string` *required*
>
> Contact's variable value
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get a list of flows
>
> **Slug:** `SEND_PULSE_TIKTOK_GET_FLOWS`
>
> Returns 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
>
> **size** `integer`
>
> Maximum items to return on this page.
>
> **bot\_id** `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.
>
> **next\_cursor** `string`
>
> Opaque cursor returned by the previous page; omit for the first page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get a list of tags
>
> **Slug:** `SEND_PULSE_TIKTOK_GET_TAG_LIST`
>
> Return 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
>
> **size** `integer`
>
> Maximum items to return on this page.
>
> **bot\_id** `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.
>
> **next\_cursor** `string`
>
> Opaque cursor returned by the previous page; omit for the first page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get a list of triggers
>
> **Slug:** `SEND_PULSE_TIKTOK_GET_TRIGGERS`
>
> Return 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
>
> **size** `integer`
>
> Maximum items to return on this page.
>
> **bot\_id** `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.
>
> **next\_cursor** `string`
>
> Opaque cursor returned by the previous page; omit for the first page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get a list of variables
>
> **Slug:** `SEND_PULSE_TIKTOK_LIST_VARIABLES`
>
> Return 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
>
> **size** `integer`
>
> Maximum items to return on this page.
>
> **bot\_id** `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.
>
> **next\_cursor** `string`
>
> Opaque cursor returned by the previous page; omit for the first page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Mark TikTok Contact Chat Unread
>
> **Slug:** `SEND_PULSE_TIKTOK_MARK_CONTACT_CHAT_UNREAD`
>
> Mark the last message from a SendPulse TikTok contact as unread.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> ID of the TikTok contact whose last message will be marked unread.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Mark TikTok Contact Messages Read
>
> **Slug:** `SEND_PULSE_TIKTOK_MARK_CONTACT_MESSAGES_AS_READ`
>
> Mark all messages from a SendPulse TikTok contact as read.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> ID of the TikTok contact whose unread message count will be reset.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Open TikTok Contact Chat
>
> **Slug:** `SEND_PULSE_TIKTOK_OPEN_CONTACT_CHAT`
>
> Open a TikTok contact chat and increase its queue priority.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID to update.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Run TikTok Flow
>
> **Slug:** `SEND_PULSE_TIKTOK_RUN_FLOW`
>
> Launch a TikTok chatbot flow by ID for a contact.
>
> #### Input Parameters
>
> **flow\_id** `string` *required*
>
> ID of the flow to launch.
>
> **contact\_id** `string` *required*
>
> Contact ID for which to launch the flow.
>
> **external\_data** `object`
>
> One-time custom values available to the launched flow.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Run TikTok Flow by Trigger
>
> **Slug:** `SEND_PULSE_TIKTOK_RUN_FLOW_BY_TRIGGER`
>
> Launch a TikTok chatbot flow by trigger keyword for a contact.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID for which to launch the flow.
>
> **external\_data** `object`
>
> One-time custom values available to the launched flow.
>
> **trigger\_keyword** `string` *required*
>
> Keyword configured to launch the flow.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Send TikTok Chatbot Campaign
>
> **Slug:** `SEND_PULSE_TIKTOK_SEND_CAMPAIGN`
>
> Send immediately or schedule a campaign to a TikTok bot audience.
>
> #### Input Parameters
>
> **title** `string` *required*
>
> Campaign title.
>
> **bot\_id** `string` *required*
>
> Bot ID whose subscribers will receive the campaign.
>
> **filter** `object`
>
> Optional subscriber targeting filter.
>
> **send\_at** `string`
>
> Scheduled date and time in Y-m-d H:i format; omit to send immediately.
>
> **messages** `array` *required*
>
> Campaign messages with channel-specific type and content objects.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Send TikTok Contact Message
>
> **Slug:** `SEND_PULSE_TIKTOK_SEND_CONTACT_MESSAGE`
>
> Send one or more messages directly to a TikTok contact.
>
> #### Input Parameters
>
> **messages** `array` *required*
>
> Messages to send, with channel-specific type and content objects.
>
> **contact\_id** `string` *required*
>
> Contact ID that will receive the message.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Assign TikTok Contact Tags
>
> **Slug:** `SEND_PULSE_TIKTOK_SET_CONTACT_TAG`
>
> Assign one or more tags to a TikTok contact.
>
> #### Input Parameters
>
> **tags** `array` *required*
>
> Tags to assign to the contact.
>
> **contact\_id** `string` *required*
>
> Contact ID to tag.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Set TikTok Contact Variables
>
> **Slug:** `SEND_PULSE_TIKTOK_SET_CONTACT_VARIABLE`
>
> Assign or update variable values for a TikTok contact.
>
> #### Input Parameters
>
> **variables** `array` *required*
>
> Variables to assign by name or ID.
>
> **contact\_id** `string` *required*
>
> Contact ID whose variables to update.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Pause TikTok Contact Automation
>
> **Slug:** `SEND_PULSE_TIKTOK_SET_PAUSE_AUTOMATION`
>
> Pause all autoflows for a TikTok contact for a specified duration.
>
> #### Input Parameters
>
> **minutes** `integer` *required*
>
> Number of minutes to pause autoflows.
>
> **contact\_id** `string` *required*
>
> Contact ID whose autoflows to pause.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Unassign TikTok Contact Operator
>
> **Slug:** `SEND_PULSE_TIKTOK_UNASSIGN_CONTACT_OPERATOR`
>
> Remove the assigned operator from a TikTok contact chat.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID to update.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update TikTok Contact Note
>
> **Slug:** `SEND_PULSE_TIKTOK_UPDATE_CONTACT_NOTE`
>
> Update an existing internal operator note for a TikTok contact.
>
> #### Input Parameters
>
> **text** `string` *required*
>
> Operator note text.
>
> **bot\_id** `string` *required*
>
> Bot ID associated with the contact.
>
> **note\_id** `string` *required*
>
> ID of the operator note to update.
>
> **contact\_id** `string` *required*
>
> Contact ID associated with the note.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Mailing List
>
> **Slug:** `SEND_PULSE_UPDATE_MAILING_LIST`
>
> Rename an existing Bulk Email mailing list.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> New mailing list name.
>
> **mailing\_list\_id** `integer` *required*
>
> ID of the mailing list to rename.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Upload File
>
> **Slug:** `SEND_PULSE_UPLOAD_FILE`
>
> Upload one file to an existing File Manager directory and return the provider-reported absolute path when available.
>
> #### Input Parameters
>
> **file** `object` *required*
>
> File to upload.
>
> **video\_width** `integer`
>
> Optional output width used only for supported video uploads.
>
> **video\_height** `integer`
>
> Optional output height used only for supported video uploads.
>
> **directory\_path** `string` *required*
>
> Absolute path of the existing File Manager destination directory.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Verification Report
>
> **Slug:** `SEND_PULSE_VERIFIER_CREATE_VERIFICATION_REPORT`
>
> Start generating a downloadable SendPulse mailing-list verification report.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> Verified mailing list ID.
>
> **lang** `string`
>
> Language code for report headers.
>
> **format** `integer ("2" | "3" | "4")`
>
> Report format: 2 for CSV, 3 for XLS, or 4 for XLSX.
>
> **status** `array`
>
> Status codes to include: 0 unverified, 1 valid, 2 unconfirmed, 3 invalid.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Download Verification Report
>
> **Slug:** `SEND_PULSE_VERIFIER_DOWNLOAD_VERIFICATION_REPORT`
>
> Download a generated SendPulse verification report; SendPulse deletes its server copy after download.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> Verified mailing list ID.
>
> **format** `integer`
>
> Report format code used during creation.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Single Email Verification Result
>
> **Slug:** `SEND_PULSE_VERIFIER_GET_SINGLE_VERIFICATION_RESULT`
>
> Get SendPulse verification results for one email address.
>
> #### Input Parameters
>
> **email** `string` *required*
>
> Email address whose verification result to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Verification Progress
>
> **Slug:** `SEND_PULSE_VERIFIER_GET_VERIFICATION_PROGRESS`
>
> Get the current progress of a SendPulse mailing-list verification.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> Mailing list ID being verified.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Verify Mailing List
>
> **Slug:** `SEND_PULSE_VERIFIER_VERIFY_MAILING_LIST`
>
> Start verification of a SendPulse mailing list.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> Mailing list ID to verify.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Verify Single Email
>
> **Slug:** `SEND_PULSE_VERIFIER_VERIFY_SINGLE_EMAIL`
>
> Start a SendPulse verification for one email address.
>
> #### Input Parameters
>
> **email** `string` *required*
>
> Email address to verify.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] View Verification Report
>
> **Slug:** `SEND_PULSE_VERIFIER_VIEW_VERIFICATION_REPORT`
>
> View metadata and a sample from a generated SendPulse verification report.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> Verified mailing list ID.
>
> **format** `integer`
>
> Report format code used during creation.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Add phone number to the blacklist
>
> **Slug:** `SEND_PULSE_VIBER_ADD_VIBER_BLACKLIST`
>
> Add phone number to the blacklist using the official SendPulse viber API.
>
> #### Input Parameters
>
> **phones** `array` *required*
>
> Phones.
>
> **description** `string`
>
> Description.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Assign Viber Chatbot Contact Operator
>
> **Slug:** `SEND_PULSE_VIBER_CHATBOT_ASSIGN_CONTACT_OPERATOR`
>
> Assign an operator as responsible for a SendPulse Viber chatbot contact's chat.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID whose chat should be assigned.
>
> **operator\_id** `integer` *required*
>
> Operator ID to assign to the chat.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Close Viber Contact Chat
>
> **Slug:** `SEND_PULSE_VIBER_CHATBOT_CLOSE_CONTACT_CHAT`
>
> Close a Viber contact chat and lower its queue priority.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID to update.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Viber Chatbot Contact Note
>
> **Slug:** `SEND_PULSE_VIBER_CHATBOT_CREATE_CONTACT_NOTE`
>
> Create an internal operator note for a SendPulse Viber chatbot contact.
>
> #### Input Parameters
>
> **text** `string` *required*
>
> Operator note text.
>
> **bot\_id** `string` *required*
>
> Bot ID associated with the contact.
>
> **contact\_id** `string` *required*
>
> Contact ID to annotate.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Viber Chatbot Contact
>
> **Slug:** `SEND_PULSE_VIBER_CHATBOT_DELETE_CONTACT`
>
> Permanently remove a contact from a SendPulse Viber chatbot audience.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID to permanently remove.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Resume Viber Chatbot Contact Automations
>
> **Slug:** `SEND_PULSE_VIBER_CHATBOT_DELETE_CONTACT_AUTOMATION_PAUSE`
>
> Remove an automation pause and resume automated flows for a SendPulse Viber chatbot contact.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID whose automated flows should resume.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Viber Chatbot Contact Note
>
> **Slug:** `SEND_PULSE_VIBER_CHATBOT_DELETE_CONTACT_NOTE`
>
> Permanently remove an operator note from a SendPulse Viber chatbot contact.
>
> #### Input Parameters
>
> **bot\_id** `string` *required*
>
> Bot ID associated with the contact.
>
> **note\_id** `string` *required*
>
> Note ID to permanently remove.
>
> **contact\_id** `string` *required*
>
> Contact ID associated with the note.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Remove Viber Chatbot Contact Tag
>
> **Slug:** `SEND_PULSE_VIBER_CHATBOT_DELETE_CONTACT_TAG`
>
> Remove a tag from a SendPulse Viber chatbot contact.
>
> #### Input Parameters
>
> **tag** `string` *required*
>
> Tag to remove from the contact.
>
> **contact\_id** `string` *required*
>
> Contact ID whose tag should be removed.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Viber Chatbot Contact Variable
>
> **Slug:** `SEND_PULSE_VIBER_CHATBOT_DELETE_CONTACT_VARIABLE`
>
> Delete one variable from a SendPulse Viber chatbot contact.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID whose variable should be deleted.
>
> **variable\_id** `string`
>
> Variable ID; provide this or variable\_name.
>
> **variable\_name** `string`
>
> Variable name; provide this or variable\_id.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Disable Viber Chatbot Contact
>
> **Slug:** `SEND_PULSE_VIBER_CHATBOT_DISABLE_CONTACT`
>
> Disable a SendPulse Viber chatbot contact so the contact can no longer interact with the bot.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID to disable.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Enable Viber Chatbot Contact
>
> **Slug:** `SEND_PULSE_VIBER_CHATBOT_ENABLE_CONTACT`
>
> Enable a previously disabled SendPulse Viber chatbot contact.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID to enable.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get account info
>
> **Slug:** `SEND_PULSE_VIBER_CHATBOT_GET_ACCOUNT`
>
> Returns Viber chatbot account pricing plan limits and usage statistics for messages, bots, contacts, and variables, including the plan's tag limit.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get general statistics info by bot
>
> **Slug:** `SEND_PULSE_VIBER_CHATBOT_GET_BOT_STATISTICS`
>
> Returns general statistics info by bot
>
> #### Input Parameters
>
> **bot\_id** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get a list of messages
>
> **Slug:** `SEND_PULSE_VIBER_CHATBOT_GET_CHAT_MESSAGES`
>
> Returns a page of messages in correspondence with the specified Viber chatbot subscriber, with pagination and optional ordering.
>
> #### Input Parameters
>
> **size** `integer`
>
> Maximum items to return on this page.
>
> **order** `string ("asc" | "desc")`
>
> Sort order ASC or DESC
>
> **contact\_id** `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.
>
> **next\_cursor** `string`
>
> Opaque cursor returned by the previous page; omit for the first page.
>
> **search\_after** `string`
>
> The id of element after which elements will be searched
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get a list of chats
>
> **Slug:** `SEND_PULSE_VIBER_CHATBOT_GET_CHATS`
>
> Returns a list of chats with subscribers with information about the contact and the last message received from the contact
>
> #### Input Parameters
>
> **size** `integer`
>
> Maximum items to return on this page.
>
> **bot\_id** `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.
>
> **next\_cursor** `string`
>
> Opaque cursor returned by the previous page; omit for the first page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get contact info via a contact ID
>
> **Slug:** `SEND_PULSE_VIBER_CHATBOT_GET_CONTACT`
>
> Returns information on the selected contact: bot and contact ID, information from messenger, list of tags and variables, activity data and date added
>
> #### Input Parameters
>
> **id** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get a list of contact's operator notes
>
> **Slug:** `SEND_PULSE_VIBER_CHATBOT_GET_CONTACT_NOTES`
>
> Returns a list of existing operator notes by contact
>
> #### Input Parameters
>
> **bot\_id** `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.
>
> **contact\_id** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get remaining time for automation pause
>
> **Slug:** `SEND_PULSE_VIBER_CHATBOT_GET_CONTACT_PAUSE_AUTOMATION`
>
> Returns the time remaining until autoflows are stopped for this contact
>
> #### Input Parameters
>
> **contact\_id** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get a list of contacts by tag
>
> **Slug:** `SEND_PULSE_VIBER_CHATBOT_GET_CONTACTS_BY_TAG`
>
> Returns a list of contacts by tag for the specified bot
>
> #### Input Parameters
>
> **tag** `string` *required*
>
> Created contact’s tag to search by
>
> **size** `integer`
>
> Maximum items to return on this page.
>
> **bot\_id** `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.
>
> **next\_cursor** `string`
>
> Opaque cursor returned by the previous page; omit for the first page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get contacts by variable
>
> **Slug:** `SEND_PULSE_VIBER_CHATBOT_GET_CONTACTS_BY_VARIABLE`
>
> Returns a page of contacts matching a variable value, using either a variable identifier or a variable name and bot ID.
>
> #### Input Parameters
>
> **size** `integer`
>
> Maximum items to return on this page.
>
> **bot\_id** `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.
>
> **next\_cursor** `string`
>
> Opaque cursor returned by the previous page; omit for the first page.
>
> **variable\_id** `string`
>
> Contact’s variable ID to search by; required parameter if you do not pass variable\_name and bot\_id.
>
> **variable\_name** `string`
>
> Contact’s variable name to search by; required parameter and passed with the bot\_id parameter, if you do not pass variable\_id.
>
> **variable\_value** `string` *required*
>
> Contact's variable value
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Viber Chatbot Flows
>
> **Slug:** `SEND_PULSE_VIBER_CHATBOT_GET_FLOWS`
>
> Requests flows configured for a SendPulse Viber chatbot bot; the declared response contains a single flow object.
>
> #### Input Parameters
>
> **size** `integer`
>
> Maximum flows to return.
>
> **skip** `integer`
>
> Number of flows to skip.
>
> **bot\_id** `string` *required*
>
> Bot ID whose flows to return.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Viber Chatbot Tags
>
> **Slug:** `SEND_PULSE_VIBER_CHATBOT_GET_TAGS`
>
> Return one page of tags configured for a SendPulse Viber chatbot bot.
>
> #### Input Parameters
>
> **size** `integer`
>
> Maximum tags to return.
>
> **skip** `integer`
>
> Number of tags to skip.
>
> **bot\_id** `string` *required*
>
> Bot ID whose tags to return.
>
> **next\_cursor** `string`
>
> Continuation cursor from a previous response.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Viber Chatbot Variables
>
> **Slug:** `SEND_PULSE_VIBER_CHATBOT_LIST_BOT_VARIABLES`
>
> Return one page of variables configured for a SendPulse Viber chatbot bot.
>
> #### Input Parameters
>
> **size** `integer`
>
> Maximum variables to return.
>
> **skip** `integer`
>
> Number of variables to skip.
>
> **bot\_id** `string` *required*
>
> Bot ID whose variables to return.
>
> **next\_cursor** `string`
>
> Continuation cursor from a previous response.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Viber Chatbot Triggers
>
> **Slug:** `SEND_PULSE_VIBER_CHATBOT_LIST_TRIGGERS`
>
> Return one page of triggers configured for a SendPulse Viber chatbot bot.
>
> #### Input Parameters
>
> **size** `integer`
>
> Maximum triggers to return.
>
> **skip** `integer`
>
> Number of triggers to skip.
>
> **bot\_id** `string` *required*
>
> Bot ID whose triggers to return.
>
> **next\_cursor** `string`
>
> Continuation cursor from a previous response.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Mark Viber Chatbot Contact Messages Read
>
> **Slug:** `SEND_PULSE_VIBER_CHATBOT_MARK_CONTACT_MESSAGES_READ`
>
> Mark all messages from a SendPulse Viber chatbot contact as read.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> ID of the Viber chatbot contact whose unread message count will be reset.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Mark Viber Chatbot Contact Unread
>
> **Slug:** `SEND_PULSE_VIBER_CHATBOT_MARK_CONTACT_UNREAD`
>
> Mark the last message from a SendPulse Viber chatbot contact as unread.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> ID of the Viber chatbot contact whose last message will be marked unread.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Open Viber Chatbot Contact Chat
>
> **Slug:** `SEND_PULSE_VIBER_CHATBOT_OPEN_CONTACT_CHAT`
>
> Open a SendPulse Viber chatbot contact chat and raise its queue priority.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID whose chat should be opened.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Run Viber Chatbot Flow
>
> **Slug:** `SEND_PULSE_VIBER_CHATBOT_RUN_FLOW`
>
> Run a specific SendPulse Viber chatbot flow for a contact.
>
> #### Input Parameters
>
> **flow\_id** `string` *required*
>
> Flow ID to run.
>
> **contact\_id** `string` *required*
>
> Contact ID for which to run the flow.
>
> **external\_data** `object`
>
> One-time custom variables available to the selected flow.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Run Viber Chatbot Flow by Trigger
>
> **Slug:** `SEND_PULSE_VIBER_CHATBOT_RUN_FLOW_BY_TRIGGER`
>
> Run the SendPulse Viber chatbot flow associated with a trigger keyword for a contact.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID for which to run the flow.
>
> **external\_data** `object`
>
> One-time custom variables available to the triggered flow.
>
> **trigger\_keyword** `string` *required*
>
> Keyword or command that launches the flow.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Send Viber Chatbot Campaign
>
> **Slug:** `SEND_PULSE_VIBER_CHATBOT_SEND_CAMPAIGN`
>
> Send immediately or schedule a campaign to a Viber bot audience.
>
> #### Input Parameters
>
> **title** `string` *required*
>
> Campaign title.
>
> **bot\_id** `string` *required*
>
> Bot ID whose subscribers will receive the campaign.
>
> **filter** `object`
>
> Optional subscriber targeting filter.
>
> **send\_at** `string`
>
> Scheduled date and time in Y-m-d H:i format; omit to send immediately.
>
> **messages** `array` *required*
>
> Campaign messages with channel-specific type and content objects.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Send Viber Chatbot Contact Message
>
> **Slug:** `SEND_PULSE_VIBER_CHATBOT_SEND_CONTACT_MESSAGE`
>
> Send one or more messages to a SendPulse Viber chatbot contact.
>
> #### Input Parameters
>
> **messages** `array` *required*
>
> Messages to send, including each message type and content.
>
> **contact\_id** `string` *required*
>
> Contact ID that should receive the message.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Assign Viber Chatbot Contact Tags
>
> **Slug:** `SEND_PULSE_VIBER_CHATBOT_SET_CONTACT_TAG`
>
> Assign one or more tags to a SendPulse Viber chatbot contact.
>
> #### Input Parameters
>
> **tags** `array` *required*
>
> Tags to assign to the contact.
>
> **contact\_id** `string` *required*
>
> Contact ID whose tags should be updated.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Assign Viber Chatbot Contact Variables
>
> **Slug:** `SEND_PULSE_VIBER_CHATBOT_SET_CONTACT_VARIABLE`
>
> Assign values to one or more variables on a SendPulse Viber chatbot contact.
>
> #### Input Parameters
>
> **variables** `array` *required*
>
> Variables to assign to the contact.
>
> **contact\_id** `string` *required*
>
> Contact ID whose variables should be updated.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Pause Viber Chatbot Contact Automations
>
> **Slug:** `SEND_PULSE_VIBER_CHATBOT_SET_PAUSE_AUTOMATION`
>
> Pause automated flows for a SendPulse Viber chatbot contact for a specified duration.
>
> #### Input Parameters
>
> **minutes** `integer` *required*
>
> Number of minutes to pause automated flows.
>
> **contact\_id** `string` *required*
>
> Contact ID whose automated flows should be paused.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Unassign Viber Chatbot Contact Operators
>
> **Slug:** `SEND_PULSE_VIBER_CHATBOT_UNASSIGN_CONTACT_OPERATORS`
>
> Unassign responsible operators from a SendPulse Viber chatbot contact's chat.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID whose operators should be unassigned.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Viber Chatbot Contact Note
>
> **Slug:** `SEND_PULSE_VIBER_CHATBOT_UPDATE_CONTACT_NOTE`
>
> Replace the text of an operator note on a SendPulse Viber chatbot contact.
>
> #### Input Parameters
>
> **text** `string` *required*
>
> Replacement operator note text.
>
> **bot\_id** `string` *required*
>
> Bot ID associated with the contact.
>
> **note\_id** `string` *required*
>
> Note ID to update.
>
> **contact\_id** `string` *required*
>
> Contact ID associated with the note.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create a Viber campaign
>
> **Slug:** `SEND_PULSE_VIBER_CREATE_VIBER_CAMPAIGN`
>
> Create a Viber campaign using the official SendPulse viber API.
>
> #### Input Parameters
>
> **message** `string`
>
> Message.
>
> **send\_date** `string` *required*
>
> 'now' or 'YYYY-MM-DD HH:MM:SS'
>
> **sender\_id** `integer` *required*
>
> Sender id.
>
> **task\_name** `string`
>
> Task name.
>
> **additional** `object`
>
> Additional.
>
> **recipients** `array`
>
> Recipients.
>
> **address\_book** `integer`
>
> Address book.
>
> **message\_type** `integer ("2" | "3")` *required*
>
> 2 - promo, 3 - system
>
> **stretch\_time** `integer`
>
> Stretch time.
>
> **message\_live\_time** `integer` *required*
>
> Message live time.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Viber Blacklist
>
> **Slug:** `SEND_PULSE_VIBER_GET_VIBER_BLACKLIST`
>
> Retrieve one page of globally blacklisted Viber contacts.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Number of blacklist records requested per page.
>
> **offset** `integer`
>
> Zero-based blacklist record offset.
>
> **next\_cursor** `string`
>
> Continuation cursor returned by a previous call.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Viber Campaign Statistics
>
> **Slug:** `SEND_PULSE_VIBER_GET_VIBER_CAMPAIGN_STATS`
>
> Retrieve delivery and engagement statistics for a Viber campaign.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> Viber campaign ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Viber Campaign Recipients
>
> **Slug:** `SEND_PULSE_VIBER_GET_VIBER_RECIPIENTS`
>
> Retrieve recipient-level delivery records for a Viber campaign.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> Viber campaign ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Viber Sender Profile
>
> **Slug:** `SEND_PULSE_VIBER_GET_VIBER_SENDER_PROFILE`
>
> Retrieve configuration and verification status for a Viber sender ID.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> Viber sender ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Remove Numbers From Viber Blacklist
>
> **Slug:** `SEND_PULSE_VIBER_REMOVE_VIBER_BLACKLIST`
>
> Remove specified phone numbers from the Viber blacklist.
>
> #### Input Parameters
>
> **phones** `array` *required*
>
> Phone numbers to remove from the Viber blacklist. Common formatting is removed before sending.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Web Push Campaign
>
> **Slug:** `SEND_PULSE_WEB_PUSH_CREATE_WEB_PUSH_CAMPAIGN`
>
> Create and queue a SendPulse browser notification campaign.
>
> #### Input Parameters
>
> **ttl** `integer` *required*
>
> Notification lifetime in seconds, up to 86400.
>
> **body** `string` *required*
>
> Notification body text.
>
> **icon** `string`
>
> JSON string containing an icon name and Base64 data.
>
> **link** `string`
>
> Destination URL opened from the notification.
>
> **image** `string`
>
> JSON string containing an image name and Base64 data.
>
> **title** `string` *required*
>
> Web push campaign title.
>
> **filter** `object`
>
> Custom-variable segmentation filter.
>
> **buttons** `string`
>
> JSON string defining up to two notification buttons.
>
> **send\_date** `string`
>
> Scheduled campaign date and time.
>
> **filter\_url** `string`
>
> JSON string containing URL filters.
>
> **website\_id** `integer` *required*
>
> Target SendPulse website ID.
>
> **filter\_lang** `string`
>
> Subscriber language filter.
>
> **stretch\_time** `integer`
>
> Optional delivery time-stretch setting.
>
> **filter\_region** `string`
>
> JSON string containing country-code filters.
>
> **filter\_browser** `string`
>
> Subscriber browser filter.
>
> **filter\_subscription\_date\_to** `string`
>
> Latest subscription date to target.
>
> **filter\_subscription\_date\_from** `string`
>
> Earliest subscription date to target.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Web Push Campaigns
>
> **Slug:** `SEND_PULSE_WEB_PUSH_GET_WEB_PUSH_CAMPAIGNS`
>
> Get one page of historical SendPulse web push campaigns.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Number of web push campaigns requested per page.
>
> **cursor** `string`
>
> Offset cursor returned by a previous call.
>
> **offset** `integer`
>
> Zero-based web push campaign offset.
>
> **date\_to** `string`
>
> Campaign end date-time filter in YYYY-MM-DD HH:MM:SS format.
>
> **date\_from** `string`
>
> Campaign start date-time filter in YYYY-MM-DD HH:MM:SS format.
>
> **website\_id** `integer`
>
> Website ID used to filter campaigns.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Web Push Campaign Statistics
>
> **Slug:** `SEND_PULSE_WEB_PUSH_GET_WEB_PUSH_CAMPAIGN_STATS`
>
> Get delivery and redirect statistics for a SendPulse web push campaign.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> Web push campaign ID to inspect.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Web Push Website Code
>
> **Slug:** `SEND_PULSE_WEB_PUSH_GET_WEB_PUSH_CODE`
>
> Get the JavaScript integration code for a SendPulse Web Push website.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> Web push website ID whose code to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Web Push Subscriber Total
>
> **Slug:** `SEND_PULSE_WEB_PUSH_GET_WEB_PUSH_SUBSCRIBERS_TOTAL`
>
> Get the total subscriber count for a SendPulse Web Push website.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> Web push website ID whose subscribers to count.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Web Push Subscriptions
>
> **Slug:** `SEND_PULSE_WEB_PUSH_GET_WEB_PUSH_SUBSCRIPTIONS`
>
> Get one page of subscribers for a SendPulse Web Push website.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> Web push website ID whose subscribers to list.
>
> **limit** `integer`
>
> Number of subscribers requested per page.
>
> **cursor** `string`
>
> Offset cursor returned by a previous call.
>
> **offset** `integer`
>
> Zero-based subscriber offset.
>
> **subscription\_date\_to** `string`
>
> Latest subscription date in YYYY-MM-DD format.
>
> **subscription\_date\_from** `string`
>
> Earliest subscription date in YYYY-MM-DD format.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Web Push Variables
>
> **Slug:** `SEND_PULSE_WEB_PUSH_GET_WEB_PUSH_VARIABLES`
>
> List custom segmentation variables for a SendPulse Web Push website.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> Web push website ID whose variables to list.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Web Push Website Information
>
> **Slug:** `SEND_PULSE_WEB_PUSH_GET_WEB_PUSH_WEBSITE_INFO`
>
> Get status and subscriber counts for a SendPulse Web Push website.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> Web push website ID to inspect.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Web Push Websites
>
> **Slug:** `SEND_PULSE_WEB_PUSH_GET_WEB_PUSH_WEBSITES`
>
> Get one page of websites connected to SendPulse Web Push.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Number of websites requested per page.
>
> **cursor** `string`
>
> Offset cursor returned by a previous call.
>
> **offset** `integer`
>
> Zero-based website offset.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Web Push Website Total
>
> **Slug:** `SEND_PULSE_WEB_PUSH_GET_WEB_PUSH_WEBSITES_TOTAL`
>
> Get the number of websites configured for SendPulse Web Push.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Set Web Push Subscriber State
>
> **Slug:** `SEND_PULSE_WEB_PUSH_SET_WEB_PUSH_SUBSCRIBER_STATE`
>
> Activate or deactivate a SendPulse web push subscriber.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> Web push subscriber ID.
>
> **state** `integer ("0" | "1")` *required*
>
> Subscriber state: 1 to activate or 0 to deactivate.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Assign WhatsApp Contact Operator
>
> **Slug:** `SEND_PULSE_WHATSAPP_ASSIGN_CONTACT_OPERATOR`
>
> Assign a SendPulse operator as responsible for a WhatsApp contact chat.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID whose chat will be assigned.
>
> **operator\_id** `integer` *required*
>
> SendPulse operator ID to assign.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Close WhatsApp Contact Chat
>
> **Slug:** `SEND_PULSE_WHATSAPP_CLOSE_CONTACT_CHAT`
>
> Close a SendPulse WhatsApp contact chat and lower its queue priority.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID whose chat should be closed.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create WhatsApp Contact
>
> **Slug:** `SEND_PULSE_WHATSAPP_CREATE_CONTACT`
>
> Create a contact in a SendPulse WhatsApp bot audience.
>
> #### Input Parameters
>
> **name** `string`
>
> Contact name.
>
> **tags** `array`
>
> Tags to assign to the contact.
>
> **phone** `string` *required*
>
> Phone number in international format.
>
> **bot\_id** `string` *required*
>
> Bot ID to which the contact should be added.
>
> **variables** `array`
>
> Variables to assign to the contact.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create WhatsApp Contact Note
>
> **Slug:** `SEND_PULSE_WHATSAPP_CREATE_CONTACT_NOTE`
>
> Create an internal operator note for a SendPulse WhatsApp contact.
>
> #### Input Parameters
>
> **text** `string` *required*
>
> Operator note text.
>
> **bot\_id** `string` *required*
>
> Bot ID associated with the contact.
>
> **contact\_id** `string` *required*
>
> Contact ID to annotate.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete WhatsApp Contact
>
> **Slug:** `SEND_PULSE_WHATSAPP_DELETE_CONTACT`
>
> Permanently remove a contact from a SendPulse WhatsApp bot audience.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID to permanently remove.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete WhatsApp Contact Note
>
> **Slug:** `SEND_PULSE_WHATSAPP_DELETE_CONTACT_NOTE`
>
> Permanently remove an operator note from a SendPulse WhatsApp contact.
>
> #### Input Parameters
>
> **bot\_id** `string` *required*
>
> Bot ID associated with the contact.
>
> **note\_id** `string` *required*
>
> Note ID to permanently remove.
>
> **contact\_id** `string` *required*
>
> Contact ID associated with the note.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Remove WhatsApp Contact Tag
>
> **Slug:** `SEND_PULSE_WHATSAPP_DELETE_CONTACT_TAG`
>
> Remove one tag from a SendPulse WhatsApp contact.
>
> #### Input Parameters
>
> **tag** `string` *required*
>
> Exact case-sensitive tag to remove.
>
> **contact\_id** `string` *required*
>
> Contact ID from which to remove the tag.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete WhatsApp Contact Variable Value
>
> **Slug:** `SEND_PULSE_WHATSAPP_DELETE_CONTACT_VARIABLE`
>
> Delete one stored variable value from a SendPulse WhatsApp contact.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID whose variable value will be deleted.
>
> **variable\_id** `string`
>
> Variable ID; provide this or variable\_name.
>
> **variable\_name** `string`
>
> Variable name; provide this or variable\_id.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Resume WhatsApp Contact Automation
>
> **Slug:** `SEND_PULSE_WHATSAPP_DELETE_PAUSE_AUTOMATION`
>
> Remove an automation pause and resume autoflows for a WhatsApp contact.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID whose automation pause will be removed.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Disable WhatsApp Contact
>
> **Slug:** `SEND_PULSE_WHATSAPP_DISABLE_CONTACT`
>
> Disable a WhatsApp contact from receiving campaigns and autoflows.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID to disable.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Enable WhatsApp Contact
>
> **Slug:** `SEND_PULSE_WHATSAPP_ENABLE_CONTACT`
>
> Enable a WhatsApp contact to receive campaigns and autoflows.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID to enable.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get WhatsApp Chatbot Account
>
> **Slug:** `SEND_PULSE_WHATSAPP_GET_ACCOUNT`
>
> Return the SendPulse WhatsApp chatbot plan, limits, and usage statistics.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get WhatsApp Bot Statistics
>
> **Slug:** `SEND_PULSE_WHATSAPP_GET_BOT_STATISTICS`
>
> Return aggregate subscriber and outgoing-message statistics for a SendPulse WhatsApp bot.
>
> #### Input Parameters
>
> **bot\_id** `string` *required*
>
> Bot ID whose statistics to return.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List WhatsApp Bot Variables
>
> **Slug:** `SEND_PULSE_WHATSAPP_GET_BOT_VARIABLES`
>
> Return one page of variables configured for a SendPulse WhatsApp bot.
>
> #### Input Parameters
>
> **size** `integer`
>
> Maximum variables to return.
>
> **skip** `integer`
>
> Number of variables to skip.
>
> **bot\_id** `string` *required*
>
> Bot ID whose variables to return.
>
> **next\_cursor** `string`
>
> Continuation cursor from a previous response.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List WhatsApp Chat Messages
>
> **Slug:** `SEND_PULSE_WHATSAPP_GET_CHAT_MESSAGES`
>
> Return one page of messages exchanged with a SendPulse WhatsApp contact.
>
> #### Input Parameters
>
> **size** `integer`
>
> Maximum messages to return.
>
> **skip** `integer`
>
> Number of messages to skip.
>
> **order** `string ("asc" | "desc")`
>
> Message sort order.
>
> **contact\_id** `string` *required*
>
> Contact ID whose messages to return.
>
> **next\_cursor** `string`
>
> Continuation cursor from a previous response.
>
> **search\_after** `string`
>
> Message ID after which to search.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List WhatsApp Chats
>
> **Slug:** `SEND_PULSE_WHATSAPP_GET_CHATS`
>
> Return one page of chats for a SendPulse WhatsApp bot.
>
> #### Input Parameters
>
> **size** `integer`
>
> Maximum chats to return.
>
> **skip** `integer`
>
> Number of chats to skip.
>
> **bot\_id** `string` *required*
>
> Bot ID whose chats to return.
>
> **next\_cursor** `string`
>
> Continuation cursor from a previous response.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get WhatsApp Contact by ID
>
> **Slug:** `SEND_PULSE_WHATSAPP_GET_CONTACT_BY_ID`
>
> Return SendPulse WhatsApp contact information by contact ID.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Contact ID to look up.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get WhatsApp Contact by Phone
>
> **Slug:** `SEND_PULSE_WHATSAPP_GET_CONTACT_BY_PHONE`
>
> Return SendPulse WhatsApp contact information by phone number and bot ID.
>
> #### Input Parameters
>
> **phone** `string` *required*
>
> Contact phone number in international format.
>
> **bot\_id** `string` *required*
>
> Bot ID to search within.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List WhatsApp Contact Notes
>
> **Slug:** `SEND_PULSE_WHATSAPP_GET_CONTACT_NOTES`
>
> Return operator notes for a SendPulse WhatsApp contact and bot.
>
> #### Input Parameters
>
> **bot\_id** `string` *required*
>
> Bot ID associated with the contact.
>
> **contact\_id** `string` *required*
>
> Contact ID whose operator notes to return.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get WhatsApp Contact Automation Pause
>
> **Slug:** `SEND_PULSE_WHATSAPP_GET_CONTACT_PAUSE_AUTOMATION`
>
> Return the remaining automation pause information for a SendPulse WhatsApp contact.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID whose automation pause to inspect.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List WhatsApp Contacts by Tag
>
> **Slug:** `SEND_PULSE_WHATSAPP_GET_CONTACTS_BY_TAG`
>
> Return one page of SendPulse WhatsApp contacts matching a tag.
>
> #### Input Parameters
>
> **tag** `string` *required*
>
> Contact tag to search for.
>
> **size** `integer`
>
> Maximum contacts to return.
>
> **skip** `integer`
>
> Number of contacts to skip.
>
> **bot\_id** `string` *required*
>
> Bot ID to search within.
>
> **next\_cursor** `string`
>
> Continuation cursor from a previous response.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List WhatsApp Contacts by Variable
>
> **Slug:** `SEND_PULSE_WHATSAPP_GET_CONTACTS_BY_VARIABLE`
>
> Return one page of SendPulse WhatsApp contacts matching a variable value.
>
> #### Input Parameters
>
> **size** `integer`
>
> Maximum contacts to return.
>
> **skip** `integer`
>
> Number of contacts to skip.
>
> **bot\_id** `string`
>
> Bot ID required when searching by variable\_name.
>
> **next\_cursor** `string`
>
> Continuation cursor from a previous response.
>
> **variable\_id** `string`
>
> Variable ID to search by; omit when using variable\_name and bot\_id.
>
> **variable\_name** `string`
>
> Variable name to search by together with bot\_id.
>
> **variable\_value** `string` *required*
>
> Variable value to match.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List WhatsApp Templates
>
> **Slug:** `SEND_PULSE_WHATSAPP_GET_TEMPLATE_LIST`
>
> Return message templates configured for a SendPulse WhatsApp bot.
>
> #### Input Parameters
>
> **bot\_id** `string` *required*
>
> Bot ID whose templates to return.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List WhatsApp Triggers
>
> **Slug:** `SEND_PULSE_WHATSAPP_GET_TRIGGERS`
>
> Return one page of triggers configured for a SendPulse WhatsApp bot.
>
> #### Input Parameters
>
> **size** `integer`
>
> Maximum triggers to return.
>
> **skip** `integer`
>
> Number of triggers to skip.
>
> **bot\_id** `string` *required*
>
> Bot ID whose triggers to return.
>
> **next\_cursor** `string`
>
> Continuation cursor from a previous response.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List WhatsApp Flows
>
> **Slug:** `SEND_PULSE_WHATSAPP_LIST_FLOWS`
>
> Return flows configured for a SendPulse WhatsApp bot.
>
> #### Input Parameters
>
> **size** `integer`
>
> Maximum flows to return.
>
> **skip** `integer`
>
> Number of flows to skip.
>
> **bot\_id** `string` *required*
>
> Bot ID whose flows to return.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List WhatsApp Tags
>
> **Slug:** `SEND_PULSE_WHATSAPP_LIST_TAGS`
>
> Return one page of tags configured for a SendPulse WhatsApp bot.
>
> #### Input Parameters
>
> **size** `integer`
>
> Maximum tags to return.
>
> **skip** `integer`
>
> Number of tags to skip.
>
> **bot\_id** `string` *required*
>
> Bot ID whose tags to return.
>
> **next\_cursor** `string`
>
> Continuation cursor from a previous response.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Mark WhatsApp Contact Chat Unread
>
> **Slug:** `SEND_PULSE_WHATSAPP_MARK_CONTACT_CHAT_UNREAD`
>
> Mark the last message from a SendPulse WhatsApp contact as unread.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> ID of the WhatsApp contact whose last message will be marked unread.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Mark WhatsApp Contact Messages Read
>
> **Slug:** `SEND_PULSE_WHATSAPP_MARK_CONTACT_MESSAGES_AS_READ`
>
> Mark all messages from a SendPulse WhatsApp contact as read.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> ID of the WhatsApp contact whose unread message count will be reset.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Open WhatsApp Contact Chat
>
> **Slug:** `SEND_PULSE_WHATSAPP_OPEN_CONTACT_CHAT`
>
> Mark a WhatsApp contact chat as open to increase its support priority.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID whose chat will be marked open.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] React to WhatsApp Chat Message
>
> **Slug:** `SEND_PULSE_WHATSAPP_REACT_TO_CHAT_MESSAGE`
>
> Apply an emoji reaction to a specific inbound SendPulse WhatsApp message.
>
> #### Input Parameters
>
> **reaction** `string` *required*
>
> Emoji character or Unicode escape sequence to apply to the message.
>
> **message\_id** `string` *required*
>
> ID of the inbound WhatsApp message to react to.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Run WhatsApp Flow
>
> **Slug:** `SEND_PULSE_WHATSAPP_RUN_FLOW`
>
> Launch a SendPulse WhatsApp flow by ID for one contact.
>
> #### Input Parameters
>
> **flow\_id** `string` *required*
>
> Flow ID to launch.
>
> **contact\_id** `string` *required*
>
> Contact ID for which to launch the flow.
>
> **external\_data** `object`
>
> One-time custom values available during this flow run.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Run WhatsApp Flow by Trigger
>
> **Slug:** `SEND_PULSE_WHATSAPP_RUN_FLOW_BY_TRIGGER`
>
> Launch a SendPulse WhatsApp flow for one contact using a trigger keyword.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID for which to launch the flow.
>
> **external\_data** `object`
>
> One-time custom values available during this flow run.
>
> **trigger\_keyword** `string` *required*
>
> Configured keyword that triggers the flow.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Send WhatsApp Chatbot Campaign
>
> **Slug:** `SEND_PULSE_WHATSAPP_SEND_CAMPAIGN`
>
> Send immediately or schedule a campaign to active subscribers of a SendPulse WhatsApp bot.
>
> #### Input Parameters
>
> **title** `string` *required*
>
> Campaign title.
>
> **bot\_id** `string` *required*
>
> Bot ID whose active subscribers will receive the campaign.
>
> **filter** `object`
>
> Optional subscriber targeting filter.
>
> **send\_at** `string`
>
> Scheduled date and time in Y-m-d H:i format; omit to send immediately.
>
> **messages** `array` *required*
>
> Messages to send in the campaign.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Send WhatsApp Contact Message
>
> **Slug:** `SEND_PULSE_WHATSAPP_SEND_CONTACT_MESSAGE`
>
> Send a typed free-form message to a SendPulse WhatsApp contact.
>
> #### Input Parameters
>
> **message** `string` *required*
>
> Typed WhatsApp message to send.
>
> **contact\_id** `string` *required*
>
> Contact ID that will receive the message.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Send WhatsApp Typing Indicator
>
> **Slug:** `SEND_PULSE_WHATSAPP_SEND_CONTACT_TYPING`
>
> Send a typing indicator to a SendPulse WhatsApp contact.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID that will receive the typing indicator.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Send WhatsApp Message by Phone
>
> **Slug:** `SEND_PULSE_WHATSAPP_SEND_MESSAGE_TO_CONTACT_BY_PHONE`
>
> Send a typed free-form WhatsApp message to a contact by phone number.
>
> #### Input Parameters
>
> **phone** `string` *required*
>
> Contact phone number in international format.
>
> **bot\_id** `string` *required*
>
> Bot ID whose audience will receive the message.
>
> **message** `string` *required*
>
> Typed WhatsApp message to send.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Send WhatsApp Template by Phone
>
> **Slug:** `SEND_PULSE_WHATSAPP_SEND_TEMPLATE_BY_PHONE`
>
> Send an approved WhatsApp template message to a contact by phone number.
>
> #### Input Parameters
>
> **phone** `string` *required*
>
> Contact phone number in international format.
>
> **bot\_id** `string` *required*
>
> Bot ID whose audience will receive the template.
>
> **template** `object` *required*
>
> Template content to send.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Send WhatsApp Template Campaign
>
> **Slug:** `SEND_PULSE_WHATSAPP_SEND_TEMPLATE_CAMPAIGN`
>
> Send immediately or schedule an approved template campaign to subscribers of a SendPulse WhatsApp bot.
>
> #### Input Parameters
>
> **title** `string` *required*
>
> Campaign title.
>
> **bot\_id** `string` *required*
>
> Bot ID whose active subscribers will receive the campaign.
>
> **send\_at** `string`
>
> Scheduled date and time in Y-m-d H:i format; omit to send immediately.
>
> **template** `object` *required*
>
> Approved WhatsApp template content.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Send WhatsApp Template to Contact
>
> **Slug:** `SEND_PULSE_WHATSAPP_SEND_TEMPLATE_TO_CONTACT`
>
> Send an approved WhatsApp template message to a SendPulse contact.
>
> #### Input Parameters
>
> **template** `object` *required*
>
> Template content to send.
>
> **contact\_id** `string` *required*
>
> Contact ID that will receive the template.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Set WhatsApp Contact Name
>
> **Slug:** `SEND_PULSE_WHATSAPP_SET_CONTACT_NAME`
>
> Update the display name of a SendPulse WhatsApp contact.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> New display name for the contact.
>
> **contact\_id** `string` *required*
>
> Contact ID to rename.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Assign WhatsApp Contact Tags
>
> **Slug:** `SEND_PULSE_WHATSAPP_SET_CONTACT_TAG`
>
> Assign one or more tags to a SendPulse WhatsApp contact.
>
> #### Input Parameters
>
> **tags** `array` *required*
>
> Tags to assign to the contact.
>
> **contact\_id** `string` *required*
>
> Contact ID to tag.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Set WhatsApp Contact Variables
>
> **Slug:** `SEND_PULSE_WHATSAPP_SET_CONTACT_VARIABLE`
>
> Add or update variable values for a SendPulse WhatsApp contact.
>
> #### Input Parameters
>
> **variables** `array` *required*
>
> Variable values to add or update.
>
> **contact\_id** `string` *required*
>
> Contact ID whose variables will be updated.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Pause WhatsApp Contact Automation
>
> **Slug:** `SEND_PULSE_WHATSAPP_SET_PAUSE_AUTOMATION`
>
> Pause autoflows for a SendPulse WhatsApp contact for a specified duration.
>
> #### Input Parameters
>
> **minutes** `integer` *required*
>
> Number of minutes to pause autoflows.
>
> **contact\_id** `string` *required*
>
> Contact ID whose autoflows will be paused.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Unassign WhatsApp Contact Operators
>
> **Slug:** `SEND_PULSE_WHATSAPP_UN_ASSIGN_CONTACT_OPERATORS`
>
> Remove the responsible operator assignment from a WhatsApp contact chat.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Contact ID whose chat operator will be unassigned.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update WhatsApp Contact Note
>
> **Slug:** `SEND_PULSE_WHATSAPP_UPDATE_CONTACT_NOTE`
>
> Update an existing internal operator note for a WhatsApp contact.
>
> #### Input Parameters
>
> **text** `string` *required*
>
> Replacement note text.
>
> **bot\_id** `string` *required*
>
> Bot ID associated with the contact.
>
> **note\_id** `string` *required*
>
> Existing note ID to update.
>
> **contact\_id** `string` *required*
>
> Contact ID whose note will be updated.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
