---
canonical_url: "https://docs.composio.dev/toolkits/send_pulse"
markdown_url: "https://docs.composio.dev/toolkits/send_pulse.md"
product: "platform"
version: null
last_updated: null
---

# SendPulse

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

- **Category:** marketing automation
- **Auth:** API_KEY, S2S_OAUTH2
- **Composio-managed OAuth available?** No
- **Tools:** 617
- **Triggers:** 0
- **Slug:** `SEND_PULSE`
- **Version:** 00000000_00

## Tools

### Delete Automation Event Logs

**Slug:** `SEND_PULSE_A360_DELETE_LOGS`

Permanently clear SendPulse Automation 360 event logs.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Action Element Stats

**Slug:** `SEND_PULSE_A360_GET_ACTION_STATS`

Get execution statistics for an Automation 360 action element.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `element_id` | integer | Yes | Action element ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Condition Element Stats

**Slug:** `SEND_PULSE_A360_GET_CONDITION_STATS`

Get branch statistics for an Automation 360 condition element.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `element_id` | integer | Yes | Condition element ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Flow Conversions

**Slug:** `SEND_PULSE_A360_GET_CONVERSIONS`

Get conversion metrics for an Automation 360 flow.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `flow_id` | integer | Yes | Automation flow ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Email Element Stats

**Slug:** `SEND_PULSE_A360_GET_EMAIL_STATS`

Get engagement statistics for an Automation 360 email element.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `element_id` | integer | Yes | Email element ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Filter Element Stats

**Slug:** `SEND_PULSE_A360_GET_FILTER_STATS`

Get branch statistics for an Automation 360 filter element.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `element_id` | integer | Yes | Filter element ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Goal Element Stats

**Slug:** `SEND_PULSE_A360_GET_GOAL_STATS`

Get achievement statistics for an Automation 360 goal element.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `element_id` | integer | Yes | Goal element ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Messenger Element Stats

**Slug:** `SEND_PULSE_A360_GET_MESSENGER_STATS`

Get execution statistics for an Automation 360 messenger element.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `element_id` | integer | Yes | Messenger element ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Push Element Stats

**Slug:** `SEND_PULSE_A360_GET_PUSH_STATS`

Get delivery and engagement statistics for an Automation 360 push element.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `element_id` | integer | Yes | Push element ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get SMS Element Stats

**Slug:** `SEND_PULSE_A360_GET_SMS_STATS`

Get delivery statistics for an Automation 360 SMS element.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `element_id` | integer | Yes | SMS element ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Start Element Stats

**Slug:** `SEND_PULSE_A360_GET_START_STATS`

Get execution statistics for an Automation 360 start element.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `element_id` | integer | Yes | Start element ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Invited Team Members

**Slug:** `SEND_PULSE_ACCOUNT_LIST_INVITED_USERS`

List all team members invited to the connected SendPulse account.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Activate Bulk Email Sender

**Slug:** `SEND_PULSE_BULK_EMAIL_ACTIVATE_SENDER`

Verify and activate a SendPulse sender email address using its code.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | Yes | Verification code sent to the sender email address. |
| `email` | string | Yes | Sender email address to activate. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Bulk Email Sender

**Slug:** `SEND_PULSE_BULK_EMAIL_ADD_SENDER`

Register a new sender email address and begin its verification process.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Sender display name. |
| `email` | string | Yes | Email address to register as a sender. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `emails` | string | Yes | Base64-encoded comma-separated email addresses to blacklist. |
| `comment` | string | No | Optional reason for the suppression. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Campaign ID to stop. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Bulk Email Campaign

**Slug:** `SEND_PULSE_BULK_EMAIL_CREATE_CAMPAIGN`

Create, send, schedule, or save a draft SendPulse email campaign.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a tag

**Slug:** `SEND_PULSE_BULK_EMAIL_CREATE_TAG`

Create a tag using the official SendPulse bulk-email API.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name. |
| `color` | string | Yes | Color. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a template

**Slug:** `SEND_PULSE_BULK_EMAIL_CREATE_TEMPLATE`

Create a template using the official SendPulse bulk-email API.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | string | Yes | HTML encoded in base64 |
| `lang` | string ("en" | "ru" | "ua" | "tr" | "es" | "pt") | No | Lang. |
| `name` | string | No | Name. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Email Globally

**Slug:** `SEND_PULSE_BULK_EMAIL_DELETE_EMAIL_GLOBALLY`

Permanently remove an email address from every Bulk Email mailing list.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | Email address to remove from every mailing list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Bulk Email Sender

**Slug:** `SEND_PULSE_BULK_EMAIL_DELETE_SENDER`

Permanently remove an authorized Bulk Email sender address.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | Authorized sender email address to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Bulk Email Tag

**Slug:** `SEND_PULSE_BULK_EMAIL_DELETE_TAG`

Permanently delete a tag and remove it from assigned contacts.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Tag ID to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Bulk Email Balance

**Slug:** `SEND_PULSE_BULK_EMAIL_GET_BALANCE`

Retrieve the SendPulse account balance and its currency.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `currency` | string | Yes | Three-letter currency code for the requested balance. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Bulk Email Blacklist

**Slug:** `SEND_PULSE_BULK_EMAIL_GET_BLACKLIST`

Retrieve all email addresses on the account-wide Bulk Email blacklist.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Mailing list ID for which to estimate campaign cost. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Campaign ID whose country statistics to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Campaign ID whose link statistics to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Mailing list ID whose campaigns to retrieve. |
| `limit` | integer | No | Number of campaigns requested per page. |
| `next_cursor` | string | No | Continuation cursor returned by a previous call. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Mailing list ID to search. |
| `searchValue` | string | Yes | Variable value to match, formatted for the variable's type. |
| `variableName` | string | Yes | Exact mailing list variable name to match. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Campaign ID to inspect. |
| `email` | string | Yes | Recipient email address to inspect. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | Subscriber email address to analyze. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | Subscriber email address to inspect. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Mailing list ID to search. |
| `email` | string | Yes | Email address to retrieve from the mailing list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | Email address to find across mailing lists. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Mailing list ID whose contact count to retrieve. |
| `active` | boolean | No | Whether to count only active contacts. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Mailing list ID to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Mailing list ID whose variables to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `emails` | array | Yes | Email addresses whose campaign engagement to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `emails` | array | Yes | Email addresses whose account membership to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Bulk Email Senders

**Slug:** `SEND_PULSE_BULK_EMAIL_GET_SENDERS`

List sender identities authorized for SendPulse Bulk Email campaigns.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Bulk Email Tags

**Slug:** `SEND_PULSE_BULK_EMAIL_GET_TAGS`

Retrieve all tags created for the SendPulse account.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lang` | string | No | Optional template language code. |
| `owner` | string ("me" | "sendpulse") | No | Template owner to search. |
| `template_id` | string | Yes | Template ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lang` | string | No | Optional template language code. |
| `owner` | string ("me" | "sendpulse") | No | Template owner to search. |
| `name_slug` | string | Yes | Unique template name slug. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Bulk Email Templates

**Slug:** `SEND_PULSE_BULK_EMAIL_GET_TEMPLATES`

Retrieve one page of SendPulse system or account email templates.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tags` | array | Yes | Tags. |
| `email` | string | Yes | Email. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tags` | array | Yes | Tags. |
| `phone` | string | Yes | Phone. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `emails` | string | Yes | Base64-encoded comma-separated email addresses to remove from the blacklist. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | Unverified sender email address that should receive an activation code. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tags` | array | Yes | Tags. |
| `email` | string | Yes | Email. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tags` | array | Yes | Tags. |
| `phone` | string | Yes | Phone. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Mailing list ID. |
| `emails` | array | Yes | Email addresses to unsubscribe, with at most 100 per request. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Bulk Email Campaign

**Slug:** `SEND_PULSE_BULK_EMAIL_UPDATE_CAMPAIGN`

Update the name or subject of a pending SendPulse email campaign.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Scheduled campaign ID. |
| `name` | string | No | Updated campaign name. |
| `subject` | string | No | Updated email subject. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Id. |
| `email` | string | Yes | Email. |
| `phone` | string | Yes | Phone. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Mailing list ID. |
| `email` | string | Yes | Email address of the contact to update. |
| `variables` | array | Yes | Variables and values to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a tag

**Slug:** `SEND_PULSE_BULK_EMAIL_UPDATE_TAG`

Update a tag using the official SendPulse bulk-email API.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Id. |
| `name` | string | Yes | Name. |
| `color` | string | Yes | Color. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Edit a template

**Slug:** `SEND_PULSE_BULK_EMAIL_UPDATE_TEMPLATE`

Edit a template using the official SendPulse bulk-email API.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Id. |
| `body` | string | Yes | HTML version of the email, encoded in base64 |
| `lang` | string ("en" | "ru" | "ua" | "tr" | "es" | "pt") | No | Lang. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Mailing List

**Slug:** `SEND_PULSE_CREATE_MAILING_LIST`

Create an empty Bulk Email mailing list and return its new ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name for the new mailing list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Contact Attribute Value

**Slug:** `SEND_PULSE_CRM_ADD_CONTACT_ATTRIBUTE_VALUE`

Store a value for an existing SendPulse CRM contact attribute.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `value` | string | Yes | Attribute value, up to 5,500 characters. |
| `contact_id` | integer | Yes | Contact ID. |
| `attribute_id` | integer | Yes | Attribute ID to add. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Contact Comment

**Slug:** `SEND_PULSE_CRM_ADD_CONTACT_COMMENT`

Add a comment to a SendPulse CRM contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `message` | string | Yes | Comment message, up to 65,535 characters. |
| `contact_id` | integer | Yes | Contact ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Contact Company Relation

**Slug:** `SEND_PULSE_CRM_ADD_CONTACT_COMPANY_RELATION`

Associate a SendPulse CRM contact with a company.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `company_id` | integer | Yes | Company ID. |
| `contact_id` | integer | Yes | Contact ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Contact Emails

**Slug:** `SEND_PULSE_CRM_ADD_CONTACT_EMAILS`

Add email addresses to a SendPulse CRM contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `emails` | array | No | Email records to add. |
| `contact_id` | integer | Yes | Contact ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Contact Messenger

**Slug:** `SEND_PULSE_CRM_ADD_CONTACT_MESSENGER`

Add a messenger account to a SendPulse CRM contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `login` | string | Yes | Contact login in the messenger. |
| `type_id` | integer | Yes | Messenger type ID. |
| `contact_id` | integer | Yes | Contact ID. |
| `is_main_chatbot` | boolean | No | Whether this is the main chatbot messenger. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Contact Phone

**Slug:** `SEND_PULSE_CRM_ADD_CONTACT_PHONE`

Add a phone number to a SendPulse CRM contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `phone` | string | Yes | Phone number to add. |
| `contact_id` | integer | Yes | Contact ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dealId` | integer | Yes | Deal ID in which you want to add the contact. It can be obtained with the "Get a list of deals" method |
| `contactId` | integer | Yes | Contact ID you want to add to the deal. It can be obtained with the "Get a list of contacts" method |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Custom Tab Relation

**Slug:** `SEND_PULSE_CRM_ADD_CUSTOM_TAB_RELATION`

Relate a SendPulse CRM custom tab to entities or attributes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `entity_id` | integer | No | Related board or pipeline ID. |
| `entity_ids` | array | No | Related attribute IDs. |
| `entity_type` | integer | No | Entity type code from 0 through 3. |
| `custom_tab_id` | integer | Yes | Custom tab ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Deal Attribute

**Slug:** `SEND_PULSE_CRM_ADD_DEAL_ATTRIBUTE`

Store a value for an existing SendPulse CRM deal attribute.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `value` | string | Yes | Attribute value, up to 5,500 characters. |
| `deal_id` | integer | Yes | Deal ID. |
| `attribute_id` | integer | Yes | Attribute ID to add. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add a note to a deal

**Slug:** `SEND_PULSE_CRM_ADD_DEAL_COMMENT`

Adds a note to the specified deal

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dealId` | integer | Yes | 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 | Yes | Note message. The maximum number of characters is 65,535 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dealId` | number | No | DealId value documented by SendPulse. |
| `quantity` | number | No | Quantity value documented by SendPulse. |
| `productId` | number | No | ProductId value documented by SendPulse. |
| `productPriceISO` | string | No | ProductPriceIso value documented by SendPulse. |
| `productPriceValue` | number | No | ProductPriceValue value documented by SendPulse. |
| `allow_out_of_stock` | boolean | No | When true the product is attached even if stock is zero and inventory is not decremented |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Tag to Contact

**Slug:** `SEND_PULSE_CRM_ADD_TAG_TO_CONTACT`

Add an existing SendPulse CRM tag to a contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag_id` | integer | Yes | Tag ID to add. |
| `contact_id` | integer | Yes | Contact ID that receives the tag. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add comment to task

**Slug:** `SEND_PULSE_CRM_ADD_TASK_COMMENT`

Add an internal comment to a SendPulse CRM task.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `taskId` | integer | Yes | SendPulse taskId parameter. |
| `message` | string | No | Comment message |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Approve manual payment.

**Slug:** `SEND_PULSE_CRM_APPROVE_PAYMENT`

Set approval status for manually created payment

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `paymentId` | integer | Yes | The unique identifier of the manually created payment to approve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Attach Call to Deal

**Slug:** `SEND_PULSE_CRM_ATTACH_CALL_TO_DEAL`

Attach a telephony call to a SendPulse CRM deal.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `call_id` | integer | No | Telephony call ID. |
| `deal_id` | integer | Yes | Deal ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `taskId` | integer | Yes | SendPulse taskId parameter. |
| `connections` | object | No | Connections value documented by SendPulse. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `emails` | array | No | Company emails to create in one request. |
| `companyId` | integer | Yes | Company ID that will receive the emails. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Batch Create Company Messengers

**Slug:** `SEND_PULSE_CRM_BATCH_CREATE_COMPANY_MESSENGERS`

Create multiple messenger records for a SendPulse CRM company.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `company_id` | integer | Yes | Company ID. |
| `messengers` | array | No | Messenger records to create. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Batch Create Company Phones

**Slug:** `SEND_PULSE_CRM_BATCH_CREATE_COMPANY_PHONES`

Create multiple phone records for a SendPulse CRM company.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `phones` | array | No | Phone records to create. |
| `company_id` | integer | Yes | Company ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | integer | Yes | Contact ID. |
| `attributes_values` | array | No | Attribute values to store. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Cancel manual payment

**Slug:** `SEND_PULSE_CRM_CANCEL_PAYMENT`

Set payment status to canceled for manually created payment.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `paymentId` | integer | Yes | The unique identifier of the payment to cancel |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Change Deal Pipeline

**Slug:** `SEND_PULSE_CRM_CHANGE_DEAL_PIPELINE`

Move a SendPulse CRM deal to a pipeline and step.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `deal_id` | integer | Yes | Deal ID. |
| `step_id` | integer | No | Destination pipeline step ID. |
| `pipeline_id` | integer | No | Destination pipeline ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order` | number | Yes | Task order in step |
| `stepId` | integer | Yes | SendPulse stepId parameter. |
| `taskId` | integer | Yes | SendPulse taskId parameter. |
| `newStepId` | number | No | New step ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create CRM Attachment

**Slug:** `SEND_PULSE_CRM_CREATE_ATTACHMENT`

Attach one previously uploaded File Manager file to a CRM entity.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `link` | string | No | File Manager path of the previously uploaded file. |
| `entityId` | number | No | ID of the CRM entity receiving the attachment. |
| `entityType` | string ("task" | "deal" | "contact") | No | Type of CRM entity receiving the attachment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create CRM Attachments Batch

**Slug:** `SEND_PULSE_CRM_CREATE_ATTACHMENTS_BATCH`

Attach a batch of previously uploaded files to CRM entities.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `attachments` | array | No | Attachments to create in one request. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create CRM Board

**Slug:** `SEND_PULSE_CRM_CREATE_BOARD`

Create a CRM task board with optional responsible-user and color settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Board name. |
| `settings` | array | No | Board settings. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create CRM Board Attribute

**Slug:** `SEND_PULSE_CRM_CREATE_BOARD_ATTRIBUTE`

Create a typed custom attribute on a CRM task board.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Attribute name. |
| `type` | number | No | Attribute type: 0 string, 1 number, 2 date, 3 link, 4 list, or 5 multi-list. |
| `boardId` | integer | Yes | Board ID that will own the attribute. |
| `options` | array | No | Options for list and multi-list attributes. |
| `mandatory` | boolean | No | Whether the attribute is required. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create CRM Board Step

**Slug:** `SEND_PULSE_CRM_CREATE_BOARD_STEPS`

Create a workflow step in a CRM task board.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Step name. |
| `color` | string | No | Step color. |
| `boardId` | integer | Yes | Board ID that will own the step. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create CRM Checklist Item

**Slug:** `SEND_PULSE_CRM_CREATE_CHECKLIST_ITEMS`

Create an item in an existing CRM task checklist.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Checklist item name. |
| `isDone` | number | No | Completion state: 0 not done or 1 done. |
| `checklistId` | integer | Yes | Checklist ID that will receive the item. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create CRM Company

**Slug:** `SEND_PULSE_CRM_CREATE_COMPANY`

Create a company record in SendPulse CRM.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `address` | string | No | Company address. |
| `currency` | string | No | Currency required when annualBusinessVolume is provided. |
| `companyName` | string | No | Company name. |
| `responsibleId` | integer | No | Responsible CRM user ID; SendPulse assigns one when omitted. |
| `annualBusinessVolume` | integer | No | Annual business volume. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create CRM Company Attribute

**Slug:** `SEND_PULSE_CRM_CREATE_COMPANY_ATTRIBUTE`

Create a typed custom attribute for CRM company records.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Company attribute name. |
| `type` | integer | No | Attribute type: 0 text, 1 number, 2 date, 3 link, 4 select, or 5 multi-select. |
| `options` | array | No | Options for select and multi-select attributes. |
| `mandatory` | boolean | No | Whether the attribute is mandatory. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create CRM Company Email

**Slug:** `SEND_PULSE_CRM_CREATE_COMPANY_EMAIL`

Add one email address to a CRM company record.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | No | Email values to create. |
| `companyId` | integer | Yes | Company ID that will receive the email. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create CRM Company Messenger

**Slug:** `SEND_PULSE_CRM_CREATE_COMPANY_MESSENGER`

Connect one messenger contact record to a CRM company.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | No | Messenger values to create. |
| `companyId` | integer | Yes | Company ID that will receive the messenger record. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Company Phone

**Slug:** `SEND_PULSE_CRM_CREATE_COMPANY_PHONE`

Create a phone record for a SendPulse CRM company.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | No | Phone record to create. |
| `company_id` | integer | Yes | Company ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Contact

**Slug:** `SEND_PULSE_CRM_CREATE_CONTACT`

Create a SendPulse CRM contact with a responsible team member and basic identity fields.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lastName` | string | No | Contact last name. |
| `firstName` | string | No | Contact first name. |
| `responsibleId` | integer | Yes | Team member ID assigned to the contact. |
| `externalContactId` | string | No | External contact ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Contact Attribute

**Slug:** `SEND_PULSE_CRM_CREATE_CONTACT_ATTRIBUTE`

Create a custom attribute for SendPulse CRM contacts.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Attribute name. |
| `type` | integer | No | Attribute type code from 0 through 5. |
| `options` | array | No | Select options. |
| `mandatory` | boolean | No | Whether the attribute is required. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Contact (Deprecated Endpoint)

**Slug:** `SEND_PULSE_CRM_CREATE_CONTACT_DEPRECATED`

Create a SendPulse CRM contact through the deprecated full-contact endpoint.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tags` | array | No | Tag IDs to add. |
| `emails` | array | No | Email addresses. |
| `phones` | array | No | International phone numbers. |
| `lastName` | string | No | Contact last name. |
| `firstName` | string | No | Contact first name. |
| `attributes` | array | No | Contact attributes to add. |
| `messengers` | array | No | Messenger accounts to add. |
| `attachments` | array | No | Previously uploaded file-manager paths to attach. |
| `responsibleId` | integer | Yes | Team member ID assigned to the contact. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Contact Tag

**Slug:** `SEND_PULSE_CRM_CREATE_CONTACT_TAG`

Create a tag for SendPulse CRM contacts.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Tag name, up to 64 characters. |
| `colorText` | string | No | Text color. |
| `colorBackground` | string | No | Background color. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Custom Tab

**Slug:** `SEND_PULSE_CRM_CREATE_CUSTOM_TAB`

Create a custom tab for a SendPulse CRM entity type.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Custom tab name. |
| `entityId` | integer | No | Related board or pipeline ID. |
| `entityType` | integer | No | Entity type code from 0 through 3. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Deal

**Slug:** `SEND_PULSE_CRM_CREATE_DEAL`

Create a deal in a SendPulse CRM pipeline.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Deal name. |
| `price` | number | No | Deal amount. |
| `stepId` | integer | Yes | Pipeline step ID. |
| `contact` | array | No | Contact IDs associated with the deal. |
| `currency` | string | No | Deal currency such as UAH, USD, or EUR. |
| `sourceId` | integer | No | External source ID. |
| `attributes` | array | No | Deal attribute values. |
| `pipelineId` | integer | Yes | Pipeline ID. |
| `attachments` | array | No | Previously uploaded file-manager paths to attach. |
| `responsibleId` | integer | No | Responsible team member ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create managers from category

**Slug:** `SEND_PULSE_CRM_CREATE_MANAGER_SETTINGS`

Assign CRM managers to a SendPulse manager-settings section.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sectionId` | integer | No | SectionId value documented by SendPulse. |
| `responsibleIds` | array | No | ResponsibleIds value documented by SendPulse. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create  payment

**Slug:** `SEND_PULSE_CRM_CREATE_PAYMENT`

Record a manual payment for a SendPulse CRM contact or deal.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `price` | integer | No | Payment amount |
| `dealId` | integer | No | Deal ID for which you need to create payment. |
| `currency` | string | No | Payment currency |
| `contactId` | integer | No | Contact ID for which you need to create payment. |
| `description` | string | No | Description value documented by SendPulse. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create new pipeline

**Slug:** `SEND_PULSE_CRM_CREATE_PIPELINE`

Create a SendPulse CRM deal pipeline with its initial stages and settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Pipeline name |
| `settings` | array | No | Settings value documented by SendPulse. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a deal attribute

**Slug:** `SEND_PULSE_CRM_CREATE_PIPELINE_ATTRIBUTE`

Create a custom deal attribute in a SendPulse CRM pipeline.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name value documented by SendPulse. |
| `type` | integer | Yes | 0 = Text, 1 = Number, 2 = Date, 3 = Link, 4 = Select, 5 = MultiSelect |
| `options` | array | No | Options value documented by SendPulse. |
| `mandatory` | boolean | No | Mandatory value documented by SendPulse. |
| `pipelineId` | integer | Yes | SendPulse pipelineId parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a new pipeline step

**Slug:** `SEND_PULSE_CRM_CREATE_PIPELINE_STEP`

Create a stage in a specified SendPulse CRM deal pipeline.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Name value documented by SendPulse. |
| `color` | string ("#000000" | "black") | No | Step color |
| `order` | integer | No | Order value documented by SendPulse. |
| `notifyIn` | string ("0" | "15min" | "30min" | "1h" | "2h" | "3h" | "6h" | "12h" | "24h" | "2d" | "3d" | "4d" | "5d" | "6d" | "7d") | No | Time notification |
| `pipelineId` | integer | Yes | SendPulse pipelineId parameter. |
| `addEndHours` | integer ("1" | "2" | "3" | "4" | "5" | "6" | "8" | "9" | "10") | No | Add number of hours or null |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a new product

**Slug:** `SEND_PULSE_CRM_CREATE_PRODUCT`

Create a SendPulse CRM product with pricing, inventory, and category details.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Store users categories

**Slug:** `SEND_PULSE_CRM_CREATE_PRODUCT_CATEGORY`

Create a category for organizing SendPulse CRM products.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Name of the category |
| `parentId` | number | No | ID of parent category. Null for root. |
| `sections` | array | No | Sections belonging to the category |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Product Sections

**Slug:** `SEND_PULSE_CRM_CREATE_PRODUCT_SECTIONS`

Create sections and their attribute values for a SendPulse CRM product.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sections` | array | No | List of sections to update |
| `productId` | integer | Yes | ID of the product to update sections for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create tasks

**Slug:** `SEND_PULSE_CRM_CREATE_TASK`

Create a SendPulse CRM task with ownership, scheduling, and optional recurrence.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Task name |
| `tags` | array | No | IDs of tags |
| `alert` | string ("0" | "15min" | "30min" | "1h" | "2h" | "3h" | "6h" | "12h" | "24h" | "2d" | "3d" | "4d" | "5d" | "6d" | "7d") | No | Notification lead time before task expiry, or 0 for no notification. |
| `repeat` | integer | No | Do you need to repeat the task |
| `stepId` | integer | No | StepId value documented by SendPulse. |
| `boardId` | integer | No | BoardId value documented by SendPulse. |
| `startAt` | string | No | StartAt value documented by SendPulse. |
| `finishAt` | string | No | FinishAt value documented by SendPulse. |
| `parentId` | integer | No | Parent task ID |
| `priority` | integer | No | Priority value documented by SendPulse. |
| `observers` | array | No | Array of users IDs acting as observers |
| `attributes` | array | No | Attributes value documented by SendPulse. |
| `checklists` | array | No | Checklists value documented by SendPulse. |
| `sourceType` | integer | No | SourceType value documented by SendPulse. |
| `attachments` | array | No | First, the file must be uploaded to the file manager, and then the file can be attached. |
| `connections` | object | No | Connections value documented by SendPulse. |
| `description` | string | No | Task description |
| `repeatSetting` | object | No | RepeatSetting value documented by SendPulse. |
| `responsibleId` | integer | No | Responsible user ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create attribute value

**Slug:** `SEND_PULSE_CRM_CREATE_TASK_ATTRIBUTE_VALUE`

Set a custom attribute value on a SendPulse CRM task.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `value` | string | No | Attribute value as a scalar string or array of values |
| `taskId` | integer | Yes | SendPulse taskId parameter. |
| `attributeId` | number | No | ID of attribute |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create checklist without items in task

**Slug:** `SEND_PULSE_CRM_CREATE_TASK_CHECKLIST`

Create one empty checklist on a SendPulse CRM task.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Checklist name |
| `taskId` | integer | Yes | SendPulse taskId parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `taskId` | integer | Yes | SendPulse taskId parameter. |
| `checklists` | array | No | Checklists value documented by SendPulse. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a task tag

**Slug:** `SEND_PULSE_CRM_CREATE_TASK_TAG`

Create a task tag

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Tag name |
| `color` | string | No | Tag color |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete CRM Attachment

**Slug:** `SEND_PULSE_CRM_DELETE_ATTACHMENT`

Permanently detach a file attachment from SendPulse CRM.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `attachment_id` | integer | Yes | ID of the file attachment to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete CRM Task Attribute Value

**Slug:** `SEND_PULSE_CRM_DELETE_ATTRIBUTE_VALUE`

Delete a value from a SendPulse CRM task attribute.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `board_id` | integer | Yes | ID of the task board containing the attribute. |
| `value_id` | integer | Yes | ID of the task attribute value to delete. |
| `attribute_id` | integer | Yes | ID of the task attribute containing the value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete CRM Checklist Item

**Slug:** `SEND_PULSE_CRM_DELETE_CHECKLIST_ITEM`

Permanently delete an item from a SendPulse CRM checklist.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `item_id` | integer | Yes | ID of the checklist item to delete. |
| `checklist_id` | integer | Yes | ID of the checklist containing the item. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete CRM Company

**Slug:** `SEND_PULSE_CRM_DELETE_COMPANY`

Permanently delete a company from SendPulse CRM.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `company_id` | integer | Yes | ID of the company to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete CRM Company Attribute

**Slug:** `SEND_PULSE_CRM_DELETE_COMPANY_ATTRIBUTE`

Permanently delete a company attribute from SendPulse CRM.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `attribute_id` | integer | Yes | ID of the company attribute to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete CRM Company Email

**Slug:** `SEND_PULSE_CRM_DELETE_COMPANY_EMAIL`

Remove an email address from a SendPulse CRM company.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email_id` | integer | Yes | ID of the email address to delete. |
| `company_id` | integer | Yes | ID of the company containing the email address. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete CRM Company Messenger

**Slug:** `SEND_PULSE_CRM_DELETE_COMPANY_MESSENGER`

Remove a messenger from a SendPulse CRM company.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `entity_id` | integer | Yes | ID of the company containing the messenger. |
| `entity_type` | string | No | CRM entity type; the API accepts only company. |
| `messenger_id` | integer | Yes | ID of the messenger to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete CRM Company Phone

**Slug:** `SEND_PULSE_CRM_DELETE_COMPANY_PHONE`

Remove a phone number from a SendPulse CRM company.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `phone_id` | integer | Yes | ID of the phone number to delete. |
| `entity_id` | integer | Yes | ID of the company containing the phone number. |
| `entity_type` | string | No | CRM entity type; the API accepts only company. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete CRM Contact Attribute

**Slug:** `SEND_PULSE_CRM_DELETE_CONTACT_ATTRIBUTE`

Permanently delete a contact attribute from SendPulse CRM.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `attribute_id` | integer | Yes | ID of the contact attribute to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete CRM Contact Attribute Value

**Slug:** `SEND_PULSE_CRM_DELETE_CONTACT_ATTRIBUTE_VALUE`

Remove an attribute value from a SendPulse CRM contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | integer | Yes | ID of the contact containing the attribute value. |
| `attribute_id` | integer | Yes | ID of the attribute value to remove from the contact. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete CRM Contact By ID

**Slug:** `SEND_PULSE_CRM_DELETE_CONTACT_BY_ID`

Permanently remove a SendPulse CRM contact by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | integer | Yes | ID of the contact to remove. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete CRM Contact Comment

**Slug:** `SEND_PULSE_CRM_DELETE_CONTACT_COMMENT`

Remove a note from a SendPulse CRM contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `comment_id` | integer | Yes | ID of the note to remove from the contact. |
| `contact_id` | integer | Yes | ID of the contact containing the note. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `company_id` | integer | Yes | ID of the company to unlink from the contact. |
| `contact_id` | integer | Yes | ID of the contact to remove from the company. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete CRM Contact Email

**Slug:** `SEND_PULSE_CRM_DELETE_CONTACT_EMAIL`

Remove an email address from a SendPulse CRM contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email_id` | integer | Yes | ID of the email address to remove from the contact. |
| `contact_id` | integer | Yes | ID of the contact containing the email address. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete CRM Contact Phone

**Slug:** `SEND_PULSE_CRM_DELETE_CONTACT_PHONE`

Remove a phone number from a SendPulse CRM contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `phone_id` | integer | Yes | ID of the phone number to remove from the contact. |
| `contact_id` | integer | Yes | ID of the contact containing the phone number. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete CRM Contact Tag

**Slug:** `SEND_PULSE_CRM_DELETE_CONTACT_TAG`

Permanently delete a contact tag from SendPulse CRM.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag_id` | integer | Yes | Tag ID returned by the CRM contact-tag list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag_id` | integer | Yes | ID of the tag to remove from the contact. |
| `contact_id` | integer | Yes | ID of the contact from which to remove the tag. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete CRM Custom Tab

**Slug:** `SEND_PULSE_CRM_DELETE_CUSTOM_TAB`

Permanently delete a custom tab from SendPulse CRM.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `entity_id` | integer | No | Related entity ID, used only for pipelines and boards. |
| `entity_type` | integer ("0" | "1" | "2" | "3") | No | Entity type: 0 is contact, 1 is pipeline, 2 is board, and 3 is company. |
| `custom_tab_id` | integer | Yes | Custom tab ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete CRM Custom Tab Relation

**Slug:** `SEND_PULSE_CRM_DELETE_CUSTOM_TAB_RELATION`

Remove attribute relations from a SendPulse CRM custom tab.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `entity_id` | integer | No | Related entity ID, used only for pipelines and boards. |
| `entity_ids` | array | No | IDs of related attributes to unlink. |
| `entity_type` | integer ("0" | "1" | "2" | "3") | No | Entity type: 0 is contact, 1 is pipeline, 2 is board, and 3 is company. |
| `custom_tab_id` | integer | Yes | Custom tab ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete CRM Deal

**Slug:** `SEND_PULSE_CRM_DELETE_DEAL`

Permanently delete a deal from SendPulse CRM.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `deal_id` | integer | Yes | ID of the deal to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete CRM Deal Attribute

**Slug:** `SEND_PULSE_CRM_DELETE_DEAL_ATTRIBUTE`

Remove an attribute from a SendPulse CRM deal.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `deal_id` | integer | Yes | ID of the deal containing the attribute. |
| `attribute_id` | integer | Yes | ID of the attribute to remove from the deal. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete CRM Deal Comment

**Slug:** `SEND_PULSE_CRM_DELETE_DEAL_COMMENT`

Remove a note from a SendPulse CRM deal.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `deal_id` | integer | Yes | ID of the deal containing the note. |
| `comment_id` | integer | Yes | ID of the note to remove from the deal. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `setting_id` | integer | Yes | ID of the manager-settings category. |
| `responsible_ids` | array | No | IDs of responsible managers to remove. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete CRM Pipeline Attribute

**Slug:** `SEND_PULSE_CRM_DELETE_PIPELINE_ATTRIBUTE`

Delete a deal attribute from a SendPulse CRM pipeline.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pipeline_id` | integer | Yes | ID of the pipeline containing the deal attribute. |
| `attribute_id` | integer | Yes | ID of the deal attribute to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete CRM Pipeline Step

**Slug:** `SEND_PULSE_CRM_DELETE_PIPELINE_STEP`

Delete a step from a SendPulse CRM pipeline.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `step_id` | integer | Yes | ID of the pipeline step to delete. |
| `pipeline_id` | integer | Yes | ID of the pipeline containing the step. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete CRM Product

**Slug:** `SEND_PULSE_CRM_DELETE_PRODUCT`

Delete a SendPulse CRM product by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `product_id` | integer | Yes | ID of the product to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete CRM Product Category

**Slug:** `SEND_PULSE_CRM_DELETE_PRODUCT_CATEGORY`

Delete a SendPulse CRM product category by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `category_id` | integer | Yes | ID of the product category to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete CRM Product Section

**Slug:** `SEND_PULSE_CRM_DELETE_PRODUCT_SECTION`

Delete a section from a SendPulse CRM product.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `product_id` | integer | Yes | ID of the product containing the section. |
| `section_id` | integer | Yes | ID of the product section to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete CRM Task

**Slug:** `SEND_PULSE_CRM_DELETE_TASK`

Delete a SendPulse CRM task by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `task_id` | integer | Yes | ID of the task to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete CRM Task Checklist

**Slug:** `SEND_PULSE_CRM_DELETE_TASK_CHECKLIST`

Delete a checklist from a SendPulse CRM task.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `task_id` | integer | Yes | ID of the task containing the checklist. |
| `checklist_id` | integer | Yes | ID of the checklist to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete CRM Task Tag

**Slug:** `SEND_PULSE_CRM_DELETE_TASK_TAG`

Delete a SendPulse CRM task tag by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag_id` | integer | Yes | ID of the task tag to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Detach CRM Contact From Task

**Slug:** `SEND_PULSE_CRM_DETACH_CONTACT_FROM_TASK`

Detach a contact from a SendPulse CRM task.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `task_id` | integer | Yes | ID of the task from which to detach the contact. |
| `contact_id` | integer | Yes | ID of the contact to detach. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Detach CRM Deal From Task

**Slug:** `SEND_PULSE_CRM_DETACH_DEAL_FROM_TASK`

Detach a deal from a SendPulse CRM task.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `deal_id` | integer | Yes | ID of the deal to detach. |
| `task_id` | integer | Yes | ID of the task from which to detach the deal. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Detach CRM Product From Deal

**Slug:** `SEND_PULSE_CRM_DETACH_PRODUCT_FROM_DEAL`

Detach a SendPulse CRM product from a deal.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `head_id` | integer | Yes | ID of the deal from which to detach the product. |
| `product_id` | integer | Yes | ID of the product to detach. |
| `category_id` | integer | Yes | ID of the category containing the product. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Detach CRM Tag From Task

**Slug:** `SEND_PULSE_CRM_DETACH_TAG_FROM_TASK`

Detach a tag from a SendPulse CRM task.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag_id` | integer | Yes | ID of the tag to detach. |
| `task_id` | integer | Yes | ID of the task from which to detach the tag. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Detach CRM Task From Task

**Slug:** `SEND_PULSE_CRM_DETACH_TASK_FROM_TASK`

Detach a child task from another SendPulse CRM task.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `task_id` | integer | Yes | ID of the child task to detach. |
| `task_head_id` | integer | Yes | ID of the parent task. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get All CRM Payments

**Slug:** `SEND_PULSE_CRM_GET_ALL_PAYMENTS`

Retrieve payments belonging to the connected SendPulse account.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get CRM Board Attributes

**Slug:** `SEND_PULSE_CRM_GET_BOARD_ATTRIBUTES`

Get attributes configured for a SendPulse CRM task board.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `board_id` | integer | Yes | ID of the CRM task board whose attributes to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get CRM Board By ID

**Slug:** `SEND_PULSE_CRM_GET_BOARD_BY_ID`

Get one SendPulse CRM task board by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `board_id` | integer | Yes | ID of the CRM task board to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get CRM Boards

**Slug:** `SEND_PULSE_CRM_GET_BOARDS`

Get all SendPulse CRM task boards.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get CRM Category Product

**Slug:** `SEND_PULSE_CRM_GET_CATEGORY_PRODUCT`

Retrieve full CRM product details in a specific category context.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `productId` | integer | Yes | Product ID to retrieve. |
| `categoryId` | integer | Yes | Category ID containing the product. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get CRM Companies List

**Slug:** `SEND_PULSE_CRM_GET_COMPANIES_LIST`

Retrieve CRM companies using structured filters, sorting, limit, and offset.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | No | Company email filter. |
| `limit` | integer | No | Maximum companies to return. |
| `phone` | string | No | Company phone filter. |
| `dateTo` | string | No | End of the company date range. |
| `offset` | integer | No | Number of matching companies to skip. |
| `sortBy` | object | No | Company sorting configuration. |
| `dateFrom` | string | No | Beginning of the company date range. |
| `attributes` | array | No | Custom attribute filters. |
| `companyIds` | array | No | Company IDs to include. |
| `companyName` | string | No | Company name filter. |
| `searchString` | string | No | Global search string; when supplied, SendPulse ignores all other filters. |
| `responsibleId` | array | No | Responsible user IDs to include. |
| `messengerLogin` | string | No | Messenger login filter. |
| `withoutContacts` | boolean | No | Provider company contact-state filter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | No | Company email filter. |
| `limit` | integer | No | Maximum companies to return. |
| `phone` | string | No | Company phone filter. |
| `dateTo` | string | No | End of the company date range. |
| `offset` | integer | No | Number of matching companies to skip. |
| `sortBy` | object | No | Company sorting configuration. |
| `dateFrom` | string | No | Beginning of the company date range. |
| `attributes` | array | No | Custom attribute filters. |
| `companyIds` | array | No | Company IDs to include. |
| `companyName` | string | No | Company name filter. |
| `searchString` | string | No | Global search string; when supplied, SendPulse ignores all other filters. |
| `responsibleId` | array | No | Responsible user IDs to include. |
| `messengerLogin` | string | No | Messenger login filter. |
| `withoutContacts` | boolean | No | Provider company contact-state filter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get CRM Company Attributes

**Slug:** `SEND_PULSE_CRM_GET_COMPANY_ATTRIBUTES`

Get the SendPulse CRM company attribute list.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get CRM Company By ID

**Slug:** `SEND_PULSE_CRM_GET_COMPANY_BY_ID`

Get one SendPulse CRM company by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `company_id` | integer | Yes | ID of the CRM company to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get CRM Company Emails

**Slug:** `SEND_PULSE_CRM_GET_COMPANY_EMAILS`

Get email addresses associated with a SendPulse CRM company.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `company_id` | integer | Yes | ID of the CRM company whose emails to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of history records requested per page. |
| `cursor` | string | No | Continuation cursor returned by a previous call. |
| `offset` | integer | No | Zero-based history record offset for the first page. |
| `date_to` | string | No | End date-time for the history range, for example 2024-11-01 12:12:12+00:00. |
| `date_from` | string | No | Start date-time for the history range, for example 2024-11-01 12:12:12+00:00. |
| `company_id` | integer | Yes | ID of the CRM company whose history to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get CRM Company Messengers

**Slug:** `SEND_PULSE_CRM_GET_COMPANY_MESSENGERS`

Get messenger accounts associated with a SendPulse CRM company.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `company_id` | integer | Yes | ID of the CRM company whose messengers to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get CRM Company Phones

**Slug:** `SEND_PULSE_CRM_GET_COMPANY_PHONES`

Get phone numbers associated with a SendPulse CRM company.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `company_id` | integer | Yes | ID of the CRM company whose phones to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get CRM Contact Attributes

**Slug:** `SEND_PULSE_CRM_GET_CONTACT_ATTRIBUTES`

Get the SendPulse CRM contact attribute list.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get CRM Contact Attribute Values

**Slug:** `SEND_PULSE_CRM_GET_CONTACT_ATTRIBUTE_VALUES`

Retrieve the configured attribute values for a CRM contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contactId` | integer | Yes | Contact ID returned by SendPulse CRM. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `externalContactId` | integer | Yes | External contact ID from another source system. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contactId` | integer | Yes | Contact ID returned by SendPulse CRM. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `messengerContactId` | string | Yes | External contact ID from a connected messenger. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Contact Calls

**Slug:** `SEND_PULSE_CRM_GET_CONTACT_CALLS`

List telephony calls associated with a SendPulse CRM contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `to` | string | No | End date and time. |
| `from_` | string | No | Start date and time. |
| `state` | integer ("1" | "2" | "3") | No | Call state: 1 pending, 2 successful, or 3 failed. |
| `call_type` | integer ("0" | "1") | No | Call type: 0 incoming or 1 outgoing. |
| `contact_id` | integer | Yes | Contact ID. |
| `contact_email` | string | No | Contact email filter. |
| `contact_phone` | string | No | Contact phone filter. |
| `responsible_ids` | array | No | Responsible user IDs. |
| `contact_last_name` | string | No | Contact last-name filter. |
| `contact_first_name` | string | No | Contact first-name filter. |
| `integration_group_id` | integer | No | Integration group ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get CRM Contact Deals

**Slug:** `SEND_PULSE_CRM_GET_CONTACT_DEALS`

Retrieve all CRM deals associated with a contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contactId` | integer | Yes | Contact ID returned by SendPulse CRM. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get CRM Contact EDU Payments

**Slug:** `SEND_PULSE_CRM_GET_CONTACT_EDU_PAYMENTS`

Retrieve EDU course payment history for a CRM contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contactId` | integer | Yes | Contact ID returned by SendPulse CRM. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contactId` | integer | Yes | Contact ID returned by SendPulse CRM. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `to_date` | string | Yes | Inclusive range end as a date-time, for example 2024-12-13 12:12:12+00:00. |
| `from_date` | string | Yes | Inclusive range start as a date-time, for example 2024-12-12 12:12:12+00:00. |
| `contact_id` | integer | Yes | Contact ID returned by SendPulse CRM. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | No | Contact email to search for. |
| `isEmailFullSearch` | boolean | No | Whether the email must match completely. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Contacts List

**Slug:** `SEND_PULSE_CRM_GET_CONTACTS_LIST`

Search and list SendPulse CRM contacts.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `to` | string | No | Creation end date in YYYY-MM-DD. |
| `ids` | array | No | Contact IDs. |
| `email` | string | No | Email filter. |
| `from_` | string | No | Creation start date in YYYY-MM-DD. |
| `limit` | integer | No | Records to return. |
| `phone` | string | No | Phone filter. |
| `offset` | integer | No | Records to skip. |
| `sortBy` | object | No | Sort configuration. |
| `tagIds` | array | No | Contact tag IDs. |
| `lastName` | string | No | Last-name filter. |
| `location` | string | No | Location filter. |
| `updateTo` | string | No | Update end date in YYYY-MM-DD. |
| `firstName` | string | No | First-name filter. |
| `attributes` | array | No | Attribute filters. |
| `sourceType` | array | No | Source type codes. |
| `updateFrom` | string | No | Update start date in YYYY-MM-DD. |
| `messengerLogin` | string | No | Messenger login filter. |
| `responsibleIds` | array | No | Responsible user IDs. |
| `messengerTypeIds` | array | No | Messenger type IDs. |
| `fieldValueConditions` | array | No | Field-value conditions. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get CRM Custom Tabs

**Slug:** `SEND_PULSE_CRM_GET_CUSTOM_TABS`

Retrieve custom CRM tab definitions grouped by entity type.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get CRM Deal

**Slug:** `SEND_PULSE_CRM_GET_DEAL`

Retrieve details for a CRM deal by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dealId` | integer | Yes | Deal ID returned by SendPulse CRM. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get CRM Deal Attribute Values

**Slug:** `SEND_PULSE_CRM_GET_DEAL_ATTRIBUTE_VALUES`

Retrieve configured attribute values for a CRM deal.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dealId` | integer | Yes | Deal ID returned by SendPulse CRM. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get calls by deal

**Slug:** `SEND_PULSE_CRM_GET_DEAL_CALLS`

List telephony calls associated with a SendPulse CRM deal.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dealId` | integer | Yes | SendPulse dealId parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get CRM Deal Notes

**Slug:** `SEND_PULSE_CRM_GET_DEAL_COMMENTS`

Retrieve notes and their attachments for a CRM deal.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dealId` | integer | Yes | Deal ID returned by SendPulse CRM. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get CRM Deal Contacts

**Slug:** `SEND_PULSE_CRM_GET_DEAL_CONTACTS`

Retrieve contacts associated with a CRM deal.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dealId` | integer | Yes | Deal ID returned by SendPulse CRM. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get CRM Deal History

**Slug:** `SEND_PULSE_CRM_GET_DEAL_HISTORY`

Retrieve a CRM deal's history within a required date range.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `deal_id` | integer | Yes | Deal ID returned by SendPulse CRM. |
| `to_date` | string | Yes | Inclusive history range end as a date-time. |
| `from_date` | string | Yes | Inclusive history range start as a date-time. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get CRM Deal Payments

**Slug:** `SEND_PULSE_CRM_GET_DEAL_PAYMENTS`

Retrieve payments associated with a CRM deal.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dealId` | integer | Yes | Deal ID returned by SendPulse CRM. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Deals List

**Slug:** `SEND_PULSE_CRM_GET_DEALS_LIST`

Search and list SendPulse CRM deals.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Deal name filter. |
| `email` | string | No | Associated contact email. |
| `limit` | integer | No | Records to return. |
| `phone` | string | No | Associated contact phone. |
| `filter` | array | No | Deal-field filters. |
| `offset` | integer | No | Records to skip. |
| `sortBy` | object | No | Sort configuration. |
| `lastName` | string | No | Associated contact last name. |
| `firstName` | string | No | Associated contact first name. |
| `unlimited` | boolean | No | Return all active deals without a limit. |
| `attributes` | array | No | Attribute filters. |
| `expiration` | integer | No | Expiration filter code from 1 through 5. |
| `pipelineIds` | array | No | Pipeline IDs. |
| `completionDateTo` | string | No | Completion end date. |
| `completionDateFrom` | string | No | Completion start date. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get CRM Managers by Section

**Slug:** `SEND_PULSE_CRM_GET_MANAGERS_BY_SECTION`

Retrieve managers assigned to a CRM manager settings section.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sectionId` | integer | Yes | CRM manager settings section ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get CRM Manager Settings Managers

**Slug:** `SEND_PULSE_CRM_GET_MANAGER_SETTINGS_MANAGERS`

Retrieve all managers available in CRM manager settings.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get CRM Messenger Types

**Slug:** `SEND_PULSE_CRM_GET_MESSENGER_TYPES`

Retrieve messenger types supported by SendPulse CRM.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get CRM Payments by Contact ID

**Slug:** `SEND_PULSE_CRM_GET_PAYMENTS_BY_CONTACT_ID`

Retrieve payments associated with a CRM contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contactId` | integer | Yes | Contact ID returned by SendPulse CRM. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pipelineId` | integer | Yes | Pipeline ID returned by SendPulse CRM. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get CRM Pipeline Steps

**Slug:** `SEND_PULSE_CRM_GET_PIPELINE_STEPS`

Retrieve steps configured for a CRM pipeline.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pipelineId` | integer | Yes | Pipeline ID returned by SendPulse CRM. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get CRM Product by ID

**Slug:** `SEND_PULSE_CRM_GET_PRODUCT_BY_ID`

Retrieve the complete CRM product record by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `productId` | integer | Yes | Product ID to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get CRM Product Categories

**Slug:** `SEND_PULSE_CRM_GET_PRODUCT_CATEGORIES`

Retrieve the complete hierarchical CRM product category tree.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contactId` | integer | Yes | CRM contact ID whose deal products to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dealId` | integer | Yes | CRM deal ID whose products to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `taskId` | integer | Yes | CRM task ID to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get CRM Task Checklists

**Slug:** `SEND_PULSE_CRM_GET_TASK_CHECKLISTS`

Retrieve all checklists associated with a CRM task.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `taskId` | integer | Yes | CRM task ID whose checklists to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `taskId` | integer | Yes | CRM task ID whose history to retrieve. |
| `toDate` | string | Yes | End of the history window as an ISO 8601 date-time. |
| `fromDate` | string | Yes | Start of the history window as an ISO 8601 date-time. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get CRM Task Repeat Templates

**Slug:** `SEND_PULSE_CRM_GET_TASK_REPEAT_TEMPLATES`

Retrieve predefined templates for recurring CRM tasks.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get CRM Task Tags

**Slug:** `SEND_PULSE_CRM_GET_TASK_TAGS`

Retrieve all tags available for CRM tasks.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get calls

**Slug:** `SEND_PULSE_CRM_GET_TELEPHONY_CALLS`

Search SendPulse CRM telephony calls by date, direction, state, or assignee.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `to` | string | No | End of the call date range in ISO 8601 date-time format. |
| `from_` | string | No | Start of the call date range in ISO 8601 date-time format. |
| `state` | integer | No | Call state: 1 pending, 2 successful, or 3 failed. |
| `callType` | integer | No | Call type: 0 incoming or 1 outgoing. |
| `contactEmail` | string | No | Filter by contact email address. |
| `contactPhone` | string | No | Filter by contact phone number. |
| `responsibleIds` | array | No | CRM user IDs responsible for the calls. |
| `contactLastName` | string | No | Filter by contact last name. |
| `contactFirstName` | string | No | Filter by contact first name. |
| `integrationGroupId` | integer | No | Telephony integration group ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get CRM Users

**Slug:** `SEND_PULSE_CRM_GET_USERS`

Retrieve active confirmed team members available for CRM assignments.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Exact tag name to match. |
| `search` | string | No | Text to find within tag names using a partial match. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pipelineId` | integer | Yes | Pipeline ID returned by SendPulse CRM. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List CRM Manager Settings Sections

**Slug:** `SEND_PULSE_CRM_LIST_MANAGER_SETTINGS_SECTIONS`

Retrieve all sections configured in CRM manager settings.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List CRM Pipeline Attributes

**Slug:** `SEND_PULSE_CRM_LIST_PIPELINE_ATTRIBUTES`

Retrieve deal attribute definitions configured for a CRM pipeline.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pipelineId` | integer | Yes | Pipeline ID returned by SendPulse CRM. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get tasks

**Slug:** `SEND_PULSE_CRM_LIST_TASKS`

Retrieves a list of tasks based on selected filters

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Name value documented by SendPulse. |
| `sort` | object | No | Sort value documented by SendPulse. |
| `tags` | array | No | IDs of tags |
| `type` | integer ("1" | "2" | "3") | No | Type value documented by SendPulse. |
| `status` | integer ("1" | "2") | No | Status value documented by SendPulse. |
| `stepId` | array | No | Array of step IDs |
| `boardId` | integer | No | BoardId value documented by SendPulse. |
| `contacts` | string | No | Contacts value documented by SendPulse. |
| `dealName` | string | No | DealName value documented by SendPulse. |
| `parentId` | array | No | Array of parent task IDs |
| `priority` | integer | No | Priority value documented by SendPulse. |
| `tagMatch` | string ("any" | "all") | No | Filter by tags (all - all tags, any - any tag). Default: any |
| `endedAtTo` | string | No | EndedAtTo value documented by SendPulse. |
| `observers` | array | No | Array of users IDs acting as observers |
| `startAtTo` | string | No | StartAtTo value documented by SendPulse. |
| `attributes` | array | No | Attributes value documented by SendPulse. |
| `finishAtTo` | string | No | FinishAtTo value documented by SendPulse. |
| `createdAtTo` | string | No | CreatedAtTo value documented by SendPulse. |
| `endedAtFrom` | string | No | EndedAtFrom value documented by SendPulse. |
| `startAtFrom` | string | No | StartAtFrom value documented by SendPulse. |
| `updatedAtTo` | string | No | UpdatedAtTo value documented by SendPulse. |
| `finishAtFrom` | string | No | FinishAtFrom value documented by SendPulse. |
| `createdAtFrom` | string | No | CreatedAtFrom value documented by SendPulse. |
| `responsibleId` | array | No | Array of responsible users IDs |
| `updatedAtFrom` | string | No | UpdatedAtFrom value documented by SendPulse. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove CRM Contact Messenger

**Slug:** `SEND_PULSE_CRM_REMOVE_CONTACT_MESSENGER`

Remove a messenger from a SendPulse CRM contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | integer | Yes | ID of the contact containing the messenger. |
| `messenger_id` | integer | Yes | ID of the messenger to remove from the contact. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove CRM Deal Contact

**Slug:** `SEND_PULSE_CRM_REMOVE_DEAL_CONTACT`

Remove a contact association from a SendPulse CRM deal.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `deal_id` | integer | Yes | ID of the deal from which to remove the contact. |
| `contact_id` | integer | Yes | ID of the contact to remove from the deal. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove CRM Deal Expiration

**Slug:** `SEND_PULSE_CRM_REMOVE_DEAL_EXPIRATION`

Remove the expiration setting from a SendPulse CRM deal.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `deal_id` | integer | Yes | Deal ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Reorder CRM Checklist Item

**Slug:** `SEND_PULSE_CRM_REORDER_CHECKLIST_ITEM`

Change the position of an item within a CRM task checklist.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order` | number | No | New item position in the checklist. |
| `itemId` | integer | Yes | Checklist item ID to reorder. |
| `checklistId` | integer | Yes | Checklist ID containing the item. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `taskId` | integer | Yes | SendPulse taskId parameter. |
| `parentId` | number | No | Parent task ID or null |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update file attachment

**Slug:** `SEND_PULSE_CRM_UPDATE_ATTACHMENT`

First, the file must be uploaded to the file manager, and then the file can be attached.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `link` | string | No | Path of a file previously uploaded to the SendPulse file manager. |
| `attachmentId` | integer | Yes | SendPulse attachmentId parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Name value documented by SendPulse. |
| `boardId` | integer | Yes | SendPulse boardId parameter. |
| `settings` | array | No | Settings value documented by SendPulse. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update attribute for board

**Slug:** `SEND_PULSE_CRM_UPDATE_BOARD_ATTRIBUTE`

Update a custom attribute configured on a SendPulse CRM task board.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Attribute name |
| `type` | number | No | Attribute type: 0 -string 1 - number 2 - date 3 - link 4 - list 5 - multiList  |
| `order` | integer | No | Attribute order |
| `status` | integer | No | Status value documented by SendPulse. |
| `boardId` | integer | Yes | SendPulse boardId parameter. |
| `options` | array | No | Attribute options (only for "list" and "multiList" types |
| `mandatory` | boolean | No | Is attribute required |
| `attributeId` | integer | Yes | SendPulse attributeId parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Step name |
| `color` | string | No | Step color |
| `order` | integer | No | Step order |
| `stepId` | integer | Yes | SendPulse stepId parameter. |
| `boardId` | integer | Yes | SendPulse boardId parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update checklist item

**Slug:** `SEND_PULSE_CRM_UPDATE_CHECKLIST_ITEM`

Update the text or completion state of a SendPulse CRM checklist item.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Checklist item name |
| `isDone` | number | No | Is checklist item done (checked). 0 - no, 1 - yes |
| `itemId` | integer | Yes | SendPulse itemId parameter. |
| `checklistId` | integer | Yes | SendPulse checklistId parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update company

**Slug:** `SEND_PULSE_CRM_UPDATE_COMPANY`

Update identity, ownership, contact channels, or attributes for a SendPulse CRM company.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `currency` | string | No | Currency value documented by SendPulse. |
| `companyId` | integer | Yes | SendPulse companyId parameter. |
| `companyName` | string | No | Company name. |
| `responsibleId` | integer | No | ResponsibleId value documented by SendPulse. |
| `annualBusinessVolume` | integer | No | AnnualBusinessVolume value documented by SendPulse. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a company attribute

**Slug:** `SEND_PULSE_CRM_UPDATE_COMPANY_ATTRIBUTE`

Update a company attribute

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name value documented by SendPulse. |
| `type` | integer | No | 0 = Text, 1 = Number, 2 = Date, 3 = Link, 4 = Select, 5 = MultiSelect |
| `order` | integer | Yes | Order value documented by SendPulse. |
| `status` | integer | No | 0 = Inactive, 1 = Active, 2 = Hidden |
| `options` | array | No | Options value documented by SendPulse. |
| `mandatory` | boolean | No | Mandatory value documented by SendPulse. |
| `attributeId` | integer | Yes | Company attribute ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update email

**Slug:** `SEND_PULSE_CRM_UPDATE_COMPANY_EMAIL`

Replace an email address associated with a SendPulse CRM company.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | No | Data value documented by SendPulse. |
| `emailId` | integer | Yes | SendPulse emailId parameter. |
| `companyId` | integer | Yes | SendPulse companyId parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update messenger

**Slug:** `SEND_PULSE_CRM_UPDATE_COMPANY_MESSENGER`

Update a messenger account associated with a SendPulse CRM company.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | No | Data value documented by SendPulse. |
| `entityId` | integer | Yes | Company ID. |
| `entityType` | string | Yes | SendPulse entityType parameter. |
| `messengerId` | integer | Yes | SendPulse messengerId parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update phone

**Slug:** `SEND_PULSE_CRM_UPDATE_COMPANY_PHONE`

Replace a phone number associated with a SendPulse CRM company.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | No | Data value documented by SendPulse. |
| `phoneId` | integer | Yes | SendPulse phoneId parameter. |
| `entityId` | integer | Yes | Company ID. |
| `entityType` | string | Yes | SendPulse entityType parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update information about the contact

**Slug:** `SEND_PULSE_CRM_UPDATE_CONTACT`

Update identity, ownership, channels, tags, or attributes for a SendPulse CRM contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lastName` | string | No | Contact last name |
| `contactId` | integer | Yes | 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 | No | Contact first name |
| `responsibleId` | integer | Yes | Team member ID to assign to a contact. It can be obtained with the "Get a list of team members" method |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a contact attribute

**Slug:** `SEND_PULSE_CRM_UPDATE_CONTACT_ATTRIBUTE`

Update a contact attribute

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name value documented by SendPulse. |
| `type` | integer | No | 0 = Text, 1 = Number, 2 = Date, 3 = Link, 4 = Select, 5 = MultiSelect |
| `order` | integer | Yes | Order value documented by SendPulse. |
| `status` | integer | No | 0 = Inactive, 1 = Active, 2 = Hidden |
| `options` | array | No | Options value documented by SendPulse. |
| `mandatory` | boolean | No | Mandatory value documented by SendPulse. |
| `attributeId` | integer | Yes | SendPulse attributeId parameter. |
| `contactCardShow` | boolean | No | ContactCardShow value documented by SendPulse. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `value` | string | Yes | New attribute value. The maximum number of characters is 5500 |
| `contactId` | integer | Yes | Contact ID for which you want to update the field. It can be obtained with the "Get a list of contacts" method |
| `attributeId` | integer | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `message` | string | Yes | New note message. The maximum number of characters is 65,535 |
| `commentId` | integer | Yes | Note ID you want to update. It can be obtained with the "Get a list of contacts" method |
| `contactId` | integer | Yes | Contact ID contact for which you want to update the note. It can be obtained with the "Get a list of contacts" method |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update the email address of the contact

**Slug:** `SEND_PULSE_CRM_UPDATE_CONTACT_EMAIL`

Updates the email address of the specified contact

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | New email address |
| `emailId` | integer | Yes | Email address ID you want to update. It can be obtained with the "Get a list of contacts" method |
| `contactId` | integer | Yes | Contact ID for which you want to update the email address. It can be obtained with the "Get a list of contacts" method |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `login` | string | Yes | Contacts login in the specified messenger |
| `typeId` | integer | Yes | TypeId value documented by SendPulse. |
| `contactId` | integer | Yes | Contact ID for which you want to update messenger information. It can be obtained with the "Get a list of contacts" method |
| `messengerId` | integer | Yes | Messenger ID you want to update. It can be obtained with the "Get a list of contacts" method |
| `isMainChatbot` | boolean | No | Determine if chatbot messenger is the main one |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `phone` | string | Yes | New phone number in the international format |
| `phoneId` | integer | Yes | The phone number ID you want to update. It can be obtained with the "Get a list of contacts" method |
| `contactId` | integer | Yes | Contact ID for which you want to update the phone number. It can be obtained with the "Get a list of contacts" method |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | New tag name. The maximum number of characters is 255 |
| `tagId` | integer | Yes | Tag ID you want to update. It can be obtained with the "Get a list of contact tags" method |
| `colorText` | string | No | Text color |
| `colorBackground` | string | No | Background color |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update custom tabs

**Slug:** `SEND_PULSE_CRM_UPDATE_CUSTOM_TAB`

Update the name and entity placement of a SendPulse CRM custom tab.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Custom tab name |
| `order` | integer | No | Custom tab order |
| `entityId` | integer | No | Related entity ID. Only for pipelines and boards |
| `isVisible` | boolean | No | Indicates whether the entity is visible to users |
| `entityType` | integer ("0" | "1" | "2" | "3") | No | 0 - contact, 1 - pipeline, 2 - board, 3 - company |
| `customTabId` | integer | Yes | Custom tab ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `value` | string | Yes | New attribute value. The maximum number of characters is 5500 |
| `dealId` | integer | Yes | 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 | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Deal name |
| `order` | integer | No | Field display order. If empty, the deal will be placed at the top of the list. |
| `price` | number | Yes | Deal amount |
| `dealId` | integer | Yes | Deal ID to be updated. You can get it in the "Get a list of deals" method |
| `status` | integer | Yes | Status value documented by SendPulse. |
| `stepId` | integer | Yes | 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 | No | Deal currency. Accepts values in the form of UAH, USD, EUR |
| `sourceId` | integer | No | Custom source ID of the deal from an external source |
| `pipelineId` | integer | Yes | Pipeline ID in which the deal is located. It can be obtained with the method "Get a list of pipelines" |
| `responsibleId` | integer | No | Team member ID to assign to a deal. It can be obtained with the "Get a list of team members" method |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dealId` | integer | Yes | 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 | Yes | New note message. The maximum number of characters is 65,535 |
| `commentId` | integer | Yes | ID of the note to be updated. It can be obtained with the "Get a list of deal notes" method |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update managers from category

**Slug:** `SEND_PULSE_CRM_UPDATE_MANAGER_SETTING`

Replace manager assignments in a SendPulse CRM manager-settings section.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sectionId` | integer | No | SectionId value documented by SendPulse. |
| `settingId` | integer | Yes | SendPulse settingId parameter. |
| `responsibleIds` | array | No | ResponsibleIds value documented by SendPulse. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Pipeline name |
| `order` | integer | No | Field display order |
| `settings` | array | No | Settings value documented by SendPulse. |
| `pipelineId` | integer | Yes | Pipeline ID to be updated. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a deal attribute

**Slug:** `SEND_PULSE_CRM_UPDATE_PIPELINE_ATTRIBUTE`

Update a deal attribute

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name value documented by SendPulse. |
| `type` | integer | No | 0 = Text, 1 = Number, 2 = Date, 3 = Link, 4 = Select, 5 = MultiSelect |
| `order` | integer | Yes | Order value documented by SendPulse. |
| `status` | integer | No | 0 = Inactive, 1 = Active, 2 = Hidden |
| `options` | array | No | Options value documented by SendPulse. |
| `mandatory` | boolean | No | Mandatory value documented by SendPulse. |
| `pipelineId` | integer | Yes | SendPulse pipelineId parameter. |
| `attributeId` | integer | Yes | SendPulse attributeId parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a pipeline step

**Slug:** `SEND_PULSE_CRM_UPDATE_PIPELINE_STEP`

Update a pipeline step

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Name value documented by SendPulse. |
| `color` | string ("#000000" | "black") | No | Step color |
| `order` | integer | No | Order value documented by SendPulse. |
| `stepId` | integer | Yes | SendPulse stepId parameter. |
| `notifyIn` | string ("0" | "15min" | "30min" | "1h" | "2h" | "3h" | "6h" | "12h" | "24h" | "2d" | "3d" | "4d" | "5d" | "6d" | "7d") | No | Time notification |
| `pipelineId` | integer | Yes | SendPulse pipelineId parameter. |
| `addEndHours` | integer ("1" | "2" | "3" | "4" | "5" | "6" | "8" | "9" | "10") | No | Add number of hours or null |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update product by id

**Slug:** `SEND_PULSE_CRM_UPDATE_PRODUCT`

Update details, pricing, stock, or visibility for a SendPulse CRM product.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `seo` | object | No | SEO-related metadata |
| `name` | string | No | Product name |
| `images` | array | No | Array of product image URLs |
| `balance` | object | No | Stock balance information |
| `visible` | number | No | Visibility flag (0 - hidden, 1 - visible) |
| `productId` | integer | Yes | ID of the product to update |
| `categoryId` | number | No | Category ID the product belongs to |
| `vendorCode` | string | No | Vendor or manufacturer code |
| `description` | string | No | Full product description |
| `digitalInfo` | object | No | Digital product details |
| `availability` | number | No | Product availability status |
| `shortDescription` | string | No | Short product summary |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update users category by id

**Slug:** `SEND_PULSE_CRM_UPDATE_PRODUCT_CATEGORY`

Rename or move a SendPulse CRM product category by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Name value documented by SendPulse. |
| `parentId` | number | No | ParentId value documented by SendPulse. |
| `categoryId` | integer | Yes | SendPulse categoryId parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update price in product

**Slug:** `SEND_PULSE_CRM_UPDATE_PRODUCT_PRICES`

Replace the configured prices for a SendPulse CRM product.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `prices` | array | No | List of prices for the product |
| `productId` | integer | Yes | ID of the product to update prices for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sections` | array | No | List of sections to update |
| `productId` | integer | Yes | ID of the product to update sections for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `amount` | integer | No | Product amount in the deal |
| `headId` | integer | Yes | SendPulse headId parameter. |
| `quantity` | integer | No | Product quantity in the deal |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update task attribute value

**Slug:** `SEND_PULSE_CRM_UPDATE_TASK_ATTRIBUTE_VALUE`

Update a custom attribute value on a SendPulse CRM task.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `value` | string | No | Attribute value as a scalar string or array of values |
| `boardId` | integer | Yes | SendPulse boardId path parameter. |
| `valueId` | integer | Yes | SendPulse valueId parameter. |
| `attributeId` | integer | Yes | SendPulse attributeId parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a task by ID

**Slug:** `SEND_PULSE_CRM_UPDATE_TASK_BY_ID`

Update a task by ID

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Task name |
| `tags` | array | No | IDs of tags |
| `repeat` | integer | No | Do you need to repeat the task |
| `stepId` | integer | No | StepId value documented by SendPulse. |
| `taskId` | integer | Yes | SendPulse taskId parameter. |
| `boardId` | integer | No | BoardId value documented by SendPulse. |
| `startAt` | string | No | StartAt value documented by SendPulse. |
| `finishAt` | string | No | FinishAt value documented by SendPulse. |
| `parentId` | integer | No | Parent task ID |
| `priority` | integer | No | Priority value documented by SendPulse. |
| `observers` | array | No | Array of users IDs acting as observers |
| `sourceType` | integer | No | SourceType value documented by SendPulse. |
| `description` | string | No | Task description |
| `responsibleId` | integer | No | Responsible user ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `taskId` | integer | Yes | SendPulse taskId parameter. |
| `checklists` | array | No | Checklists value documented by SendPulse. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Checklist name |
| `taskId` | integer | Yes | SendPulse taskId parameter. |
| `checklistId` | integer | Yes | SendPulse checklistId parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update comment in task

**Slug:** `SEND_PULSE_CRM_UPDATE_TASK_COMMENT`

Edit an existing internal comment on a SendPulse CRM task.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `taskId` | integer | Yes | SendPulse taskId parameter. |
| `message` | string | No | Comment message |
| `commentId` | integer | Yes | SendPulse commentId parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a task tag

**Slug:** `SEND_PULSE_CRM_UPDATE_TASK_TAG`

Update a task tag

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Tag name |
| `color` | string | No | Tag color |
| `tagId` | integer | Yes | SendPulse tagId parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upload files

**Slug:** `SEND_PULSE_CRM_UPLOAD_FILES`

Upload one or more files for later attachment to SendPulse CRM records.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `files` | array | No | Array of file binaries |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date` | string | No | Expiration date |
| `time` | string | No | Expiration time |
| `dealId` | integer | Yes | Deal ID |
| `notifyIn` | string ("0" | "15min" | "30min" | "1h" | "2h" | "3h" | "6h" | "12h" | "24h" | "2d" | "3d" | "4d" | "5d" | "6d" | "7d") | No | Notification lead time before deal expiry, or 0 for no notification. |
| `dealAction` | integer ("1" | "2") | No | Deal event: 1 created or 2 updated. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Files

**Slug:** `SEND_PULSE_DELETE_FILES`

Permanently delete 1-25 File Manager files sequentially and return an ordered outcome for every path. Path-local validation and not-found failures are aggregated; global and upstream failures are raised, and processing stops when a transport failure leaves a deletion uncertain.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file_paths` | array | Yes | Full File Manager paths of 1-25 files to permanently delete with separate sequential requests. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Mailing List

**Slug:** `SEND_PULSE_DELETE_MAILING_LIST`

Permanently delete one Bulk Email mailing list and its membership.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `mailing_list_id` | integer | Yes | ID of the mailing list to permanently delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Education Student

**Slug:** `SEND_PULSE_EDU_CREATE_STUDENT`

Create a SendPulse Education student and optionally enroll them in a course tariff.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | No | Student email address. |
| `tag_ids` | array | No | Tag IDs to assign to the student. |
| `language` | string | No | Preferred language or locale code. |
| `course_id` | integer | No | Course ID for enrollment. |
| `last_name` | string | No | Student last name. |
| `first_name` | string | No | Student first name. |
| `course_tariff_id` | integer | No | Course tariff ID for enrollment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Education Student

**Slug:** `SEND_PULSE_EDU_DELETE_STUDENT`

Permanently delete a student and associated education data from the school.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `student_id` | integer | Yes | Student ID to permanently delete from the school. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Education Courses

**Slug:** `SEND_PULSE_EDU_GET_COURSES`

Get all Education courses associated with the connected account.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Course Tariffs

**Slug:** `SEND_PULSE_EDU_GET_COURSE_TARIFFS`

Get all pricing tariffs available for an Education course.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `course_id` | integer | Yes | Course ID whose tariffs to return. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Education Schools

**Slug:** `SEND_PULSE_EDU_GET_SCHOOLS`

Get the schools registered in the connected SendPulse Education account.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `student_id` | integer | Yes | Student ID whose cross-course progress to return. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Education Student Audience

**Slug:** `SEND_PULSE_EDU_GET_STUDENTS_AUDITORY`

Search and filter the SendPulse Education student audience.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string ("asc" | "desc") | No | Sort direction. |
| `tags` | array | No | Tag IDs assigned to students. |
| `email` | string | No | Student email substring. |
| `limit` | integer | Yes | Maximum matching students to return. |
| `offset` | integer | Yes | Number of matching students to skip. |
| `is_paid` | boolean | No | Whether the student paid for at least one course. |
| `order_by` | string ("firstName" | "studentStatusOnCourse" | "studentTest" | "studentDateRegistrationOnCourse") | No | Field used to sort results. |
| `course_id` | integer | No | Course ID filter. |
| `last_name` | string | No | Student last-name substring. |
| `first_name` | string | No | Student first-name substring. |
| `course_status` | array | No | Student course statuses. |
| `search_string` | string | No | Free-text student search. |
| `promo_code_ids` | array | No | Promo code IDs used by students. |
| `date_last_entry` | object | No | Last login date range. |
| `used_promo_code` | boolean | No | Whether any promo code was used. |
| `paid_courses_value` | integer | No | Paid course count used by the comparison. |
| `course_restrictions` | string ("none" | "open" | "closed") | No | Course access restriction filter. |
| `paid_courses_condition` | string ("=" | ">=" | "<=") | No | Comparison operator for paid course count. |
| `date_registration_on_course` | object | No | Course registration date range. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string ("asc" | "desc") | No | Sort direction. |
| `tags` | array | No | Tag IDs assigned to students. |
| `email` | string | No | Student email substring. |
| `limit` | integer | Yes | Maximum matching students to return. |
| `offset` | integer | Yes | Number of matching students to skip. |
| `is_paid` | boolean | No | Whether the student paid for at least one course. |
| `order_by` | string ("firstName" | "studentStatusOnCourse" | "studentTest" | "studentDateRegistrationOnCourse") | No | Field used to sort results. |
| `progress` | object | No | Lesson, test, and certificate progress filters. |
| `course_id` | integer | Yes | Course ID. |
| `last_name` | string | No | Student last-name substring. |
| `lesson_id` | integer | No | Lesson ID filter. |
| `first_name` | string | No | Student first-name substring. |
| `tariff_ids` | array | No | Assigned tariff IDs. |
| `course_status` | array | No | Student course statuses. |
| `search_string` | string | No | Free-text student search. |
| `promo_code_ids` | array | No | Promo code IDs used by students. |
| `tags_condition` | string ("all" | "any") | No | Require all or any supplied tags. |
| `without_tariff` | boolean | No | Whether students must lack or have a tariff; omit when tariff_ids is set. |
| `date_last_entry` | object | No | Last login date range. |
| `used_promo_code` | boolean | No | Whether any promo code was used. |
| `date_registration_on_course` | object | No | Course registration date range. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Education Tags

**Slug:** `SEND_PULSE_EDU_GET_TAGS`

Get the complete list of tags available in SendPulse Education.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Student Groups By Course

**Slug:** `SEND_PULSE_EDU_LIST_GROUPS_BY_COURSE`

List all student groups associated with an Education course.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `course_id` | integer | Yes | Course ID whose student groups to list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ids` | array | No | Student IDs to mark as paid. |
| `course_id` | integer | Yes | Course ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Student From Course

**Slug:** `SEND_PULSE_EDU_REMOVE_STUDENT_FROM_COURSE`

Permanently remove a student's enrollment from an Education course.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `course_id` | integer | Yes | Course ID from which to remove the student. |
| `student_id` | integer | Yes | Student ID to remove from the course. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Assign Facebook Contact Operator

**Slug:** `SEND_PULSE_FACEBOOK_ASSIGN_CONTACT_OPERATOR`

Assign a responsible operator to a SendPulse Facebook contact chat.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID whose chat to assign. |
| `operator_id` | integer | Yes | Operator ID to make responsible for the chat. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Close Facebook Contact Chat

**Slug:** `SEND_PULSE_FACEBOOK_CLOSE_CONTACT_CHAT`

Close a SendPulse Facebook contact chat and lower its queue priority.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID whose chat to close. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Facebook Contact Note

**Slug:** `SEND_PULSE_FACEBOOK_CREATE_CONTACT_NOTE`

Create an internal operator note for a SendPulse Facebook contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `text` | string | Yes | Operator note text. |
| `bot_id` | string | Yes | Bot ID associated with the contact. |
| `contact_id` | string | Yes | Contact ID to annotate. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Facebook Contact

**Slug:** `SEND_PULSE_FACEBOOK_DELETE_CONTACT`

Permanently remove a contact from a SendPulse Facebook bot audience.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID to permanently remove. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Facebook Contact Note

**Slug:** `SEND_PULSE_FACEBOOK_DELETE_CONTACT_NOTE`

Permanently remove an operator note from a SendPulse Facebook contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `bot_id` | string | Yes | Bot ID associated with the contact. |
| `note_id` | string | Yes | Note ID to permanently remove. |
| `contact_id` | string | Yes | Contact ID associated with the note. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Facebook Contact Tag

**Slug:** `SEND_PULSE_FACEBOOK_DELETE_CONTACT_TAG`

Remove a tag from a SendPulse Facebook contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag` | string | Yes | Tag to remove. |
| `contact_id` | string | Yes | Contact ID from which to remove the tag. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Facebook Contact Variable

**Slug:** `SEND_PULSE_FACEBOOK_DELETE_CONTACT_VARIABLE`

Delete one variable value from a SendPulse Facebook contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID whose variable value to delete. |
| `variable_id` | string | No | Variable ID; provide this or variable_name. |
| `variable_name` | string | No | Variable name; provide this or variable_id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID whose autoflows to resume. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID to disable. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Enable Facebook Contact

**Slug:** `SEND_PULSE_FACEBOOK_ENABLE_CONTACT`

Enable a SendPulse Facebook contact so campaigns and autoflows can resume.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID to enable. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Facebook Get Bot Statistics

**Slug:** `SEND_PULSE_FACEBOOK_GET_BOT_STATISTICS`

Returns general statistics info by bot

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `bot_id` | string | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Facebook Get Chat Messages

**Slug:** `SEND_PULSE_FACEBOOK_GET_CHAT_MESSAGES`

Returns a list of all messages in correspondence with the specified subscriber

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | integer | No | The limit of pagination items, that will be returned |
| `skip` | integer | No | The offset of pagination items, where starts a current items batch |
| `order` | string ("asc" | "desc") | No | Sort order ASC or DESC |
| `cursor` | string | No | Continuation cursor returned by a previous call. |
| `contact_id` | string | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | integer | No | Provider size query parameter. |
| `skip` | integer | No | Provider skip query parameter. |
| `bot_id` | string | Yes | 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 | No | Continuation cursor returned by a previous call. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Facebook Get Contact Notes

**Slug:** `SEND_PULSE_FACEBOOK_GET_CONTACT_NOTES`

Returns a list of existing operator notes by contact

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `bot_id` | string | Yes | 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 | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag` | string | Yes | created contacts tag to search by |
| `size` | integer | No | The limit of pagination items, that will be returned |
| `skip` | integer | No | The offset of pagination items, where starts a current items batch |
| `bot_id` | string | Yes | 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 | No | Continuation cursor returned by a previous call. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Facebook Get Contacts By Variable

**Slug:** `SEND_PULSE_FACEBOOK_GET_CONTACTS_BY_VARIABLE`

Returns a list of contacts by variable identifier or variable name for the specified bot

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | integer | No | The limit of pagination items, that will be returned |
| `skip` | integer | No | The offset of pagination items, where starts a current items batch |
| `bot_id` | string | No | 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 | No | Continuation cursor returned by a previous call. |
| `variable_id` | string | No | Contact's variable ID |
| `variable_name` | string | No | ontact variable name to search by |
| `variable_value` | string | Yes | Contact's variable value |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | integer | No | The limit of pagination items, that will be returned |
| `skip` | integer | No | The offset of pagination items, where starts a current items batch |
| `bot_id` | string | Yes | 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 | No | Continuation cursor returned by a previous call. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | integer | No | The limit of pagination items, that will be returned |
| `skip` | integer | No | The offset of pagination items, where starts a current items batch |
| `bot_id` | string | Yes | 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 | No | Continuation cursor returned by a previous call. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | integer | No | The limit of pagination items, that will be returned |
| `skip` | integer | No | The offset of pagination items, where starts a current items batch |
| `bot_id` | string | Yes | 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 | No | Continuation cursor returned by a previous call. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | integer | No | The limit of pagination items, that will be returned |
| `skip` | integer | No | The offset of pagination items, where starts a current items batch |
| `bot_id` | string | Yes | 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 | No | Continuation cursor returned by a previous call. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID whose unread count will be reset. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Mark Facebook Contact Unread

**Slug:** `SEND_PULSE_FACEBOOK_MARK_CONTACT_UNREAD`

Mark the last message from a SendPulse Facebook contact as unread.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | ID of the Facebook contact whose last message will be marked unread. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID whose chat to open. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `flow_id` | string | Yes | Flow ID to launch. |
| `contact_id` | string | Yes | Contact ID for which to launch the flow. |
| `external_data` | object | No | One-time custom values available to the selected flow. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID for which to launch the flow. |
| `external_data` | object | No | One-time custom values available to the selected flow. |
| `trigger_keyword` | string | Yes | Keyword of the flow trigger to invoke. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Send Facebook Contact Message

**Slug:** `SEND_PULSE_FACEBOOK_SEND_CONTACT_MESSAGE`

Send text, media, or template content to a SendPulse Facebook contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `message` | object | Yes | Message type and content. |
| `contact_id` | string | Yes | Contact ID that will receive the message. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Send Text to Facebook Contact

**Slug:** `SEND_PULSE_FACEBOOK_SEND_TEXT_TO_CONTACT`

Send a text message to a SendPulse Facebook contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `text` | string | Yes | Text message to send; may include emoji. |
| `contact_id` | string | Yes | Contact ID that will receive the message. |
| `message_tag` | string ("HUMAN_AGENT" | "CUSTOMER_FEEDBACK") | Yes | Facebook Messenger policy tag. |
| `message_type` | string ("MESSAGE_TAG" | "RESPONSE") | Yes | Facebook message type. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Send Facebook Typing Indicator

**Slug:** `SEND_PULSE_FACEBOOK_SEND_TYPING_INDICATOR`

Send a transient typing indicator to a SendPulse Facebook contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID that will receive the typing indicator. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `minutes` | integer | Yes | Number of minutes to pause autoflows. |
| `contact_id` | string | Yes | Contact ID whose autoflows should be paused. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set Facebook Contact Tags

**Slug:** `SEND_PULSE_FACEBOOK_SET_CONTACT_TAG`

Assign one or more tags to a SendPulse Facebook contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tags` | array | Yes | Tags to assign to the contact. |
| `contact_id` | string | Yes | Contact ID to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `variables` | array | Yes | Variables identified by name or ID and their new values. |
| `contact_id` | string | Yes | Contact ID to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID whose operator assignment to remove. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Facebook Contact Note

**Slug:** `SEND_PULSE_FACEBOOK_UPDATE_CONTACT_NOTE`

Replace an existing operator note for a SendPulse Facebook contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `text` | string | Yes | Replacement operator note text. |
| `bot_id` | string | Yes | Bot ID associated with the contact. |
| `note_id` | string | Yes | Note ID to update. |
| `contact_id` | string | Yes | Contact ID associated with the note. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Check File Exists

**Slug:** `SEND_PULSE_FILE_MANAGER_CHECK_FILE_EXIST`

Check whether a file exists at a SendPulse File Manager path.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `path` | string | Yes | Absolute path of the file to check. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create File Manager Directory

**Slug:** `SEND_PULSE_FILE_MANAGER_CREATE_DIRECTORY`

Create a directory in SendPulse File Manager.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the directory to create. |
| `path_to_store` | string | Yes | Absolute parent path where the directory will be created. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `path` | string | Yes | Directory path whose files will be filtered. |
| `sort` | string ("asc" | "desc") | No | Sort order for matching files. |
| `to_date` | string | No | Inclusive UTC upper bound in Y-m-d H:i format. |
| `from_date` | string | No | Inclusive UTC lower bound in Y-m-d H:i format. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Directory Contents

**Slug:** `SEND_PULSE_FILE_MANAGER_GET_DIRECTORY_CONTENTS`

Get files and nested folders in a SendPulse File Manager directory.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `directory_path` | string | Yes | Absolute directory path, such as /images or /uploads/2024. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Account Overview

**Slug:** `SEND_PULSE_GET_ACCOUNT_OVERVIEW`

Return the connected SendPulse account identity, balances, enabled product plans, and usage limits.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `flow_id` | integer | Yes | ID of the Automation 360 flow to inspect. |
| `flow_type` | string ("maintrigger" | "email" | "push" | "sms" | "filter" | "action" | "goal" | "trigger" | "viber" | "pause") | No | Optional Automation 360 element type to include in element statistics. |
| `include_deleted` | boolean | No | Whether element statistics should include deleted flow elements. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Email Campaign

**Slug:** `SEND_PULSE_GET_EMAIL_CAMPAIGN`

Return configuration, recipient counts, status, and delivery statistics for one Bulk Email campaign.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `campaign_id` | integer | Yes | ID of the Bulk Email campaign to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page_size` | integer | No | Maximum email-level verification results to return in this page. |
| `next_cursor` | string | No | Opaque continuation cursor from a previous response; omit for the first page. |
| `verification_id` | integer | Yes | ID of the verified mailing list returned by the verification list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID whose chat will be assigned. |
| `operator_id` | integer | Yes | Operator ID to assign as responsible for the chat. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Close Instagram Contact Chat

**Slug:** `SEND_PULSE_INSTAGRAM_CLOSE_CONTACT_CHAT`

Close a SendPulse Instagram contact chat and lower its queue priority.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID whose chat to close. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Instagram Contact Note

**Slug:** `SEND_PULSE_INSTAGRAM_CREATE_CONTACT_NOTE`

Create an internal operator note for a SendPulse Instagram contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `text` | string | Yes | Operator note text, visible only to operators. |
| `bot_id` | string | Yes | Bot ID associated with the contact. |
| `contact_id` | string | Yes | Contact ID to annotate. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Instagram Contact

**Slug:** `SEND_PULSE_INSTAGRAM_DELETE_CONTACT`

Permanently remove a contact and its history from a SendPulse Instagram bot audience.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID to permanently remove. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID whose automation pause to remove. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Instagram Contact Note

**Slug:** `SEND_PULSE_INSTAGRAM_DELETE_CONTACT_NOTE`

Permanently remove an operator note from a SendPulse Instagram contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `bot_id` | string | Yes | Bot ID associated with the contact. |
| `note_id` | string | Yes | Note ID to permanently remove. |
| `contact_id` | string | Yes | Contact ID associated with the note. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Instagram Contact Tag

**Slug:** `SEND_PULSE_INSTAGRAM_DELETE_CONTACT_TAG`

Remove a tag from a SendPulse Instagram chatbot contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag` | string | Yes | Tag to remove from the contact. |
| `contact_id` | string | Yes | Contact ID whose tag will be removed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Instagram Contact Variable

**Slug:** `SEND_PULSE_INSTAGRAM_DELETE_CONTACT_VARIABLE`

Delete a variable value from a SendPulse Instagram chatbot contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID whose variable value will be deleted. |
| `variable_id` | string | No | Variable ID; provide this or variable_name. |
| `variable_name` | string | No | Variable name; provide this or variable_id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Disable Instagram Contact

**Slug:** `SEND_PULSE_INSTAGRAM_DISABLE_CONTACT`

Disable an Instagram chatbot contact so campaigns and autoflows are no longer sent.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID to disable. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Enable Instagram Contact

**Slug:** `SEND_PULSE_INSTAGRAM_ENABLE_CONTACT`

Enable an Instagram chatbot contact to receive campaigns and autoflows.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID to enable. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Instagram Chatbot Account

**Slug:** `SEND_PULSE_INSTAGRAM_GET_ACCOUNT`

Get pricing-plan limits and usage for the Instagram chatbot service.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Instagram Bot Statistics

**Slug:** `SEND_PULSE_INSTAGRAM_GET_BOTS_STATISTICS`

Get aggregate subscriber and outgoing-message statistics for an Instagram bot.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `bot_id` | string | Yes | Bot ID whose aggregate statistics to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Instagram Chat Messages

**Slug:** `SEND_PULSE_INSTAGRAM_GET_CHAT_MESSAGES`

Get one page of messages exchanged with an Instagram chatbot contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | integer | No | Number of messages requested per page. |
| `skip` | integer | No | Zero-based message offset. |
| `order` | string ("asc" | "desc") | No | Message sort order. |
| `cursor` | string | No | Continuation cursor returned by a previous call. |
| `contact_id` | string | Yes | Contact ID whose message history to retrieve. |
| `search_after` | string | No | Message ID after which to search. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Instagram Chats

**Slug:** `SEND_PULSE_INSTAGRAM_GET_CHATS`

Get one page of chats for an Instagram bot.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | integer | No | Number of chats requested per page. |
| `skip` | integer | No | Zero-based chat offset. |
| `bot_id` | string | Yes | Bot ID whose chats to retrieve. |
| `cursor` | string | No | Continuation cursor returned by a previous call. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Instagram Contact

**Slug:** `SEND_PULSE_INSTAGRAM_GET_CONTACT`

Get an Instagram chatbot contact by contact ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Contact ID to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Instagram Contact Notes

**Slug:** `SEND_PULSE_INSTAGRAM_GET_CONTACT_NOTES`

Get internal operator notes for an Instagram chatbot contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `bot_id` | string | Yes | Bot ID associated with the contact. |
| `contact_id` | string | Yes | Contact ID whose operator notes to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID whose automation pause to inspect. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag` | string | Yes | Exact contact tag to match. |
| `size` | integer | No | Number of contacts requested per page. |
| `skip` | integer | No | Zero-based contact offset. |
| `bot_id` | string | Yes | Bot ID whose contacts to search. |
| `cursor` | string | No | Continuation cursor returned by a previous call. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | integer | No | Number of contacts requested per page. |
| `skip` | integer | No | Zero-based contact offset. |
| `bot_id` | string | No | Bot ID required with variable_name. |
| `cursor` | string | No | Continuation cursor returned by a previous call. |
| `variable_id` | string | No | Variable ID to match instead of a variable name and bot ID. |
| `variable_name` | string | No | Variable name to match when bot_id is also provided. |
| `variable_value` | string | Yes | Variable value to match. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Instagram Flows

**Slug:** `SEND_PULSE_INSTAGRAM_GET_FLOWS`

Get one page of automation flows for an Instagram bot.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | integer | No | Number of flows requested per page. |
| `skip` | integer | No | Zero-based flow offset. |
| `bot_id` | string | Yes | Bot ID whose flows to retrieve. |
| `cursor` | string | No | Continuation cursor returned by a previous call. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Instagram Tags

**Slug:** `SEND_PULSE_INSTAGRAM_GET_TAGS`

Get one page of tags for an Instagram bot.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | integer | No | Number of tags requested per page. |
| `skip` | integer | No | Zero-based tag offset. |
| `bot_id` | string | Yes | Bot ID whose tags to retrieve. |
| `cursor` | string | No | Continuation cursor returned by a previous call. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Instagram Bot Variables

**Slug:** `SEND_PULSE_INSTAGRAM_LIST_BOT_VARIABLES`

Get one page of variables defined for an Instagram bot.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | integer | No | Number of variables requested per page. |
| `skip` | integer | No | Zero-based variable offset. |
| `bot_id` | string | Yes | Bot ID whose variables to retrieve. |
| `cursor` | string | No | Continuation cursor returned by a previous call. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Instagram Triggers

**Slug:** `SEND_PULSE_INSTAGRAM_LIST_TRIGGERS`

Get one page of automation triggers for an Instagram bot.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | integer | No | Number of triggers requested per page. |
| `skip` | integer | No | Zero-based trigger offset. |
| `bot_id` | string | Yes | Bot ID whose triggers to retrieve. |
| `cursor` | string | No | Continuation cursor returned by a previous call. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID whose unread count will be reset. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Mark Instagram Contact Unread

**Slug:** `SEND_PULSE_INSTAGRAM_MARK_CONTACT_UNREAD`

Mark the last message from a SendPulse Instagram contact as unread.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID whose last message will be marked unread. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID whose chat will be opened. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `flow_id` | string | Yes | Flow ID to launch. |
| `contact_id` | string | Yes | Contact ID for which to launch the flow. |
| `external_data` | object | No | Optional one-time custom data available to the selected flow. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID for which to launch the flow. |
| `external_data` | object | No | Optional one-time custom data available to the triggered flow. |
| `trigger_keyword` | string | Yes | Trigger keyword that launches the flow. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `title` | string | Yes | Campaign title. |
| `bot_id` | string | Yes | Bot ID whose active subscribers will receive the campaign. |
| `filter` | object | No | Optional subscriber targeting filter. |
| `send_at` | string | No | Scheduled date and time in Y-m-d H:i format; omit to send immediately. |
| `messages` | array | Yes | Campaign messages and their channel-specific content. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `messages` | array | Yes | Messages to send, including each message type and channel-specific content. |
| `contact_id` | string | Yes | Contact ID that will receive the message. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Assign Instagram Contact Tags

**Slug:** `SEND_PULSE_INSTAGRAM_SET_CONTACT_TAG`

Assign one or more tags to a SendPulse Instagram chatbot contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tags` | array | Yes | Tags to assign to the contact. |
| `contact_id` | string | Yes | Contact ID that will receive the tags. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set Instagram Contact Variables

**Slug:** `SEND_PULSE_INSTAGRAM_SET_CONTACT_VARIABLE`

Add or update variable values for a SendPulse Instagram chatbot contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `variables` | array | Yes | Variables and values to add or update. |
| `contact_id` | string | Yes | Contact ID whose variables will be set. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `minutes` | integer | Yes | Number of minutes to pause autoflows. |
| `contact_id` | string | Yes | Contact ID whose autoflows will be paused. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID whose responsible operators will be unassigned. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Instagram Contact Note

**Slug:** `SEND_PULSE_INSTAGRAM_UPDATE_CONTACT_NOTE`

Update an existing operator note for a SendPulse Instagram chatbot contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `text` | string | Yes | Updated note text. |
| `bot_id` | string | Yes | Bot ID associated with the contact. |
| `note_id` | string | Yes | Note ID to update. |
| `contact_id` | string | Yes | Contact ID associated with the note. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page_size` | integer | No | Maximum automation flows to return in this page. |
| `next_cursor` | string | No | Opaque continuation cursor from a previous response; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Campaigns

**Slug:** `SEND_PULSE_LIST_CAMPAIGNS`

List email, SMS, or transactional Viber campaigns using channel-specific filters and pagination.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `channel` | string ("all" | "facebook" | "instagram" | "live_chat" | "telegram" | "tiktok" | "viber" | "whatsapp") | No | 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 | No | Maximum bots to return in a channel-specific page; ignored when channel is all. |
| `next_cursor` | string | No | Opaque continuation cursor for a channel-specific listing; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Chatbot Dialogs

**Slug:** `SEND_PULSE_LIST_CHATBOT_DIALOGS`

Return one page of recent dialogs across connected SendPulse chatbot services.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order` | string ("asc" | "desc") | No | Order dialogs ascending (asc) or descending (desc). |
| `page_size` | integer | No | Maximum dialogs to return in this page. |
| `next_cursor` | string | No | Opaque continuation cursor from a previous response; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List CRM Pipelines

**Slug:** `SEND_PULSE_LIST_CRM_PIPELINES`

Return CRM pipelines, their stages, and settings for account-state discovery and ID lookup.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page_size` | integer | No | Number of mailing lists to return; SendPulse allows 1 to 100 records per page. |
| `next_cursor` | string | No | Opaque continuation cursor from a previous response; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page_size` | integer | No | Maximum verification jobs to return in this page. |
| `next_cursor` | string | No | Opaque continuation cursor from a previous response; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Messaging Senders

**Slug:** `SEND_PULSE_LIST_MESSAGING_SENDERS`

List configured sender identities for either the SMS or transactional Viber service.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `channel` | string ("sms" | "viber") | Yes | Messaging service whose approved or pending sender identities to return. Choose sms or viber. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID whose chat will be assigned. |
| `operator_id` | integer | Yes | Operator ID to assign as responsible for the chat. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID whose chat will be closed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `text` | string | Yes | Operator note text. |
| `bot_id` | string | Yes | Bot ID associated with the contact. |
| `contact_id` | string | Yes | Contact ID that will receive the note. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID to remove from the audience and subscribers list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `bot_id` | string | Yes | Bot ID associated with the contact. |
| `note_id` | string | Yes | Note ID to delete. |
| `contact_id` | string | Yes | Contact ID associated with the note. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Live Chat Contact Tag

**Slug:** `SEND_PULSE_LIVE_CHAT_DELETE_CONTACT_TAG`

Remove a tag from a SendPulse Live Chat contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag` | string | Yes | Tag to remove from the contact. |
| `contact_id` | string | Yes | Contact ID whose tag will be removed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID whose variable value will be deleted. |
| `variable_id` | string | No | Variable ID; provide this or variable_name. |
| `variable_name` | string | No | Variable name; provide this or variable_id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID whose autoflows will be resumed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID to disable. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Enable Live Chat Contact

**Slug:** `SEND_PULSE_LIVE_CHAT_ENABLE_CONTACT`

Enable a Live Chat contact to receive campaigns and autoflows.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID to enable. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `bot_id` | string | Yes | Bot ID whose aggregate statistics to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | integer | No | Number of messages requested per page. |
| `skip` | integer | No | Zero-based message offset. |
| `order` | string ("asc" | "desc") | No | Message sort order. |
| `cursor` | string | No | Continuation cursor returned by a previous call. |
| `contact_id` | string | Yes | Contact ID whose message history to retrieve. |
| `search_after` | string | No | Message ID after which to search. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Live Chat Chats

**Slug:** `SEND_PULSE_LIVE_CHAT_GET_CHATS`

Get one page of chats for a Live Chat bot.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | integer | No | Number of chats requested per page. |
| `skip` | integer | No | Zero-based chat offset. |
| `bot_id` | string | Yes | Bot ID whose chats to retrieve. |
| `cursor` | string | No | Continuation cursor returned by a previous call. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Live Chat Contact

**Slug:** `SEND_PULSE_LIVE_CHAT_GET_CONTACT`

Get a Live Chat chatbot contact by contact ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Contact ID to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `bot_id` | string | Yes | Bot ID associated with the contact. |
| `contact_id` | string | Yes | Contact ID whose operator notes to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID whose automation pause to inspect. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag` | string | Yes | Exact contact tag to match. |
| `size` | integer | No | Number of contacts requested per page. |
| `skip` | integer | No | Zero-based contact offset. |
| `bot_id` | string | Yes | Bot ID whose contacts to search. |
| `cursor` | string | No | Continuation cursor returned by a previous call. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | integer | No | Number of contacts requested per page. |
| `skip` | integer | No | Zero-based contact offset. |
| `bot_id` | string | No | Bot ID required with variable_name. |
| `cursor` | string | No | Continuation cursor returned by a previous call. |
| `variable_id` | string | No | Variable ID to match instead of a variable name and bot ID. |
| `variable_name` | string | No | Variable name to match when bot_id is also provided. |
| `variable_value` | string | Yes | Variable value to match. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Live Chat Flows

**Slug:** `SEND_PULSE_LIVE_CHAT_GET_FLOWS`

Get one page of automation flows for a Live Chat bot.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | integer | No | Number of flows requested per page. |
| `skip` | integer | No | Zero-based flow offset. |
| `bot_id` | string | Yes | Bot ID whose flows to retrieve. |
| `cursor` | string | No | Continuation cursor returned by a previous call. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Live Chat Triggers

**Slug:** `SEND_PULSE_LIVE_CHAT_GET_TRIGGERS`

Get one page of automation triggers for a Live Chat bot.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | integer | No | Number of triggers requested per page. |
| `skip` | integer | No | Zero-based trigger offset. |
| `bot_id` | string | Yes | Bot ID whose triggers to retrieve. |
| `cursor` | string | No | Continuation cursor returned by a previous call. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | integer | No | The limit of pagination items, that will be returned |
| `skip` | integer | No | The offset of pagination items, where starts a current items batch |
| `bot_id` | string | Yes | 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 | No | Continuation cursor returned by a previous call. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Live Chat Tags

**Slug:** `SEND_PULSE_LIVE_CHAT_LIST_TAGS`

Get one page of tags for a Live Chat bot.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | integer | No | Number of tags requested per page. |
| `skip` | integer | No | Zero-based tag offset. |
| `bot_id` | string | Yes | Bot ID whose tags to retrieve. |
| `cursor` | string | No | Continuation cursor returned by a previous call. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID whose unread count will be reset. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID whose last message will be marked unread. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID whose chat will be opened. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Run Live Chat Flow

**Slug:** `SEND_PULSE_LIVE_CHAT_RUN_FLOW`

Launch a SendPulse Live Chat flow by ID for a contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `flow_id` | string | Yes | Flow ID to launch. |
| `contact_id` | string | Yes | Contact ID for which to launch the flow. |
| `external_data` | object | No | Custom variable values available during this flow run. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID for which to launch the flow. |
| `external_data` | object | No | Custom variable values available during this flow run. |
| `trigger_keyword` | string | Yes | Trigger keyword that launches the flow. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `messages` | array | Yes | Messages and channel-specific content to send. |
| `contact_id` | string | Yes | Contact ID that will receive the messages. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | New contact display name. |
| `contact_id` | string | Yes | Contact ID whose display name to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tags` | array | Yes | Tags to assign to the contact. |
| `contact_id` | string | Yes | Contact ID to tag. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `variables` | array | Yes | Variables and values to assign. |
| `contact_id` | string | Yes | Contact ID whose variables to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `minutes` | integer | Yes | Number of minutes to pause autoflows. |
| `contact_id` | string | Yes | Contact ID whose autoflows to pause. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID whose operator assignment to remove. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `text` | string | Yes | Replacement note text. |
| `bot_id` | string | Yes | Bot ID associated with the contact. |
| `note_id` | string | Yes | Note ID to update. |
| `contact_id` | string | Yes | Contact ID associated with the note. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Popup Project

**Slug:** `SEND_PULSE_POPUPS_CREATE_WIDGET`

Create a SendPulse project that can contain popup widgets.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | No | Absolute project website URL. |
| `name` | string | No | Project name. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Popup

**Slug:** `SEND_PULSE_POPUPS_DELETE_POPUP`

Permanently delete a SendPulse popup and its display rules and statistics.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `popup_id` | string | Yes | Popup UUID to permanently delete. |
| `is_enabled` | boolean | No | Optional deletion state flag documented by SendPulse. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | integer | No | Optional end date as a Unix timestamp. |
| `start` | integer | No | Optional start date as a Unix timestamp. |
| `popup_id` | string | Yes | NPS popup UUID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | integer | No | Optional end Unix timestamp. |
| `start` | integer | No | Optional start Unix timestamp. |
| `popup_id` | string | Yes | NPS popup UUID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Popup Conditions

**Slug:** `SEND_PULSE_POPUPS_GET_POPUP_CONDITIONS`

Get all available targeting and display conditions for SendPulse popups.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Popup Statistics

**Slug:** `SEND_PULSE_POPUPS_GET_POPUP_STATISTICS`

Get engagement statistics for a SendPulse popup and optional time range.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | integer | No | Optional end Unix timestamp. |
| `start` | integer | No | Optional start Unix timestamp. |
| `popup_id` | string | Yes | Popup UUID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | integer | No | Optional end Unix timestamp. |
| `start` | integer | No | Optional start Unix timestamp. |
| `project_id` | string | Yes | Popup project UUID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Popup Subscriber

**Slug:** `SEND_PULSE_POPUPS_GET_SUBSCRIBER_BY_ID`

Get detailed information about a SendPulse popup subscriber.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `subscriber_id` | integer | Yes | Subscriber ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Subscribers By Popup

**Slug:** `SEND_PULSE_POPUPS_GET_SUBSCRIBERS_BY_POPUP`

Get subscribers acquired through a specific SendPulse popup.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `popup_id` | string | Yes | Popup UUID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Popup Tariff Limits

**Slug:** `SEND_PULSE_POPUPS_GET_TARIFF_LIMITS`

Get the authenticated account's SendPulse popup plan limits.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `first` | integer | No | Maximum popups to return on this page. |
| `project_id` | string | Yes | Popup project UUID. |
| `next_cursor` | string | No | Opaque cursor from the previous page; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `first` | integer | No | Maximum quiz popups to return on this page. |
| `project_id` | string | Yes | Popup project UUID. |
| `next_cursor` | string | No | Opaque cursor from the previous page; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Subscribers By Popup Project

**Slug:** `SEND_PULSE_POPUPS_LIST_SUBSCRIBERS_BY_PROJECT`

List subscribers associated with a SendPulse popup project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Popup project UUID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Popup Projects

**Slug:** `SEND_PULSE_POPUPS_LIST_WIDGETS`

Get one page of SendPulse popup projects.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `first` | integer | No | Maximum projects to return on this page. |
| `next_cursor` | string | No | Opaque cursor from the previous page; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set Popup State

**Slug:** `SEND_PULSE_POPUPS_SET_POPUP_STATE`

Enable or disable a SendPulse popup on its website.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `popup_id` | string | Yes | Popup UUID. |
| `is_enabled` | boolean | No | True to enable the popup or false to disable it. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `emails` | array | Yes | Email addresses to remove from this mailing list; SendPulse allows at most 100 per request. |
| `mailing_list_id` | integer | Yes | ID of the mailing list from which to remove contacts. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Files

**Slug:** `SEND_PULSE_SEARCH_FILES`

Search recursively for File Manager files by keyword within a directory path.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | Yes | Keyword to match against File Manager files. |
| `directory_path` | string | No | Directory path from which to search recursively. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add SMS Blacklist Entries

**Slug:** `SEND_PULSE_SMS_ADD_SMS_BLACKLIST`

Globally suppress phone numbers from future SendPulse SMS messages.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `phones` | array | Yes | Phone numbers to suppress globally from SMS sending. |
| `description` | string | Yes | Reason for blacklisting the phone numbers. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `phones` | array | Yes | Phones. |
| `address_book_id` | integer | Yes | Mailing list ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `phones` | object | Yes | Phones. |
| `address_book_id` | integer | Yes | Mailing list ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | string | Yes | SMS message text to price. |
| `route` | string | No | Optional route configuration serialized as a JSON object. |
| `phones` | array | No | Phone numbers to price instead of a mailing list. |
| `sender` | string | Yes | SMS sender name used for the estimate. |
| `address_book_id` | integer | No | Mailing-list ID whose phone numbers should be priced. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | string | Yes | Body. |
| `date` | string | No | Date. |
| `route` | object | No | e.g. {'UA':'national'} |
| `sender` | string | Yes | Sender. |
| `emulate` | boolean | No | Emulate. |
| `address_book_id` | integer | Yes | Mailing list ID. |
| `use_dynamic_list` | boolean | No | Use dynamic list. |
| `stat_link_tracking` | boolean | No | Stat link tracking. |
| `stat_link_need_protocol` | boolean | No | Stat link need protocol. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete SMS Campaign

**Slug:** `SEND_PULSE_SMS_DELETE_SMS_CAMPAIGN`

Permanently delete an SMS campaign that has not started.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | SMS campaign ID to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get SMS Blacklist

**Slug:** `SEND_PULSE_SMS_GET_SMS_BLACKLIST`

Get the SendPulse SMS phone-number suppression list.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get SMS Campaign Information

**Slug:** `SEND_PULSE_SMS_GET_SMS_CAMPAIGN_INFO`

Get SendPulse delivery and spend information for an SMS campaign.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | SMS campaign ID to inspect. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `phone_number` | string | Yes | Phone number whose mailing-list profile to retrieve. |
| `address_book_id` | integer | Yes | Mailing-list ID containing the phone number. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Numbers From SMS Blacklist

**Slug:** `SEND_PULSE_SMS_REMOVE_SMS_BLACKLIST`

Remove explicitly re-consented phone numbers from the account-wide SMS blacklist.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `phones` | array | Yes | Phone numbers to remove from the SMS blacklist. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `phones` | array | Yes | Phone numbers to remove from the mailing list. |
| `addressBookId` | integer | Yes | Mailing list ID from which to remove the numbers. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | string | Yes | Body. |
| `date` | string | No | Date. |
| `route` | object | No | Route. |
| `phones` | array | Yes | Phones. |
| `sender` | string | Yes | Sender. |
| `emulate` | boolean | No | Emulate. |
| `stat_link_tracking` | boolean | No | Stat link tracking. |
| `stat_link_need_protocol` | boolean | No | Stat link need protocol. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `phones` | array | Yes | Phones. |
| `variables` | array | Yes | Variables. |
| `address_book_id` | integer | Yes | Mailing list ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Address book ID. |
| `phone` | string | Yes | Phone number of the contact to update. Common formatting is removed before sending. |
| `variables` | array | Yes | Variables and values to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add a domain

**Slug:** `SEND_PULSE_SMTP_ADD_SMTP_DOMAIN`

Add a domain using the official SendPulse smtp API.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `domain` | string | Yes | Domain. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date` | string | No | UTC report date in YYYY-MM-DD format. |
| `limit` | integer | No | Number of bounce records requested per page. |
| `cursor` | string | No | Continuation cursor returned by a previous call. |
| `offset` | integer | No | Zero-based bounce record offset. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | SMTP email ID to inspect. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get SMTP Emails

**Slug:** `SEND_PULSE_SMTP_GET_SMTP_EMAILS`

Get one page of historical SendPulse SMTP delivery records.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `to` | string | No | End date in YYYY-MM-DD format. |
| `limit` | integer | No | Number of SMTP email records requested per page. |
| `cursor` | string | No | Offset cursor returned by a previous call. |
| `offset` | integer | No | Zero-based SMTP email record offset. |
| `sender` | string | No | Sender email address filter. |
| `country` | string | No | Recipient country filter. |
| `date_from` | string | No | Start date in YYYY-MM-DD format. |
| `recipient` | string | No | Recipient email address filter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `emails` | array | Yes | Emails. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get SMTP Email Total

**Slug:** `SEND_PULSE_SMTP_GET_SMTP_EMAILS_TOTAL`

Get the cumulative count of emails sent through SendPulse SMTP.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get SMTP IP Addresses

**Slug:** `SEND_PULSE_SMTP_GET_SMTP_IPS`

List outbound IP addresses used by the SendPulse SMTP relay.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get SMTP Senders

**Slug:** `SEND_PULSE_SMTP_GET_SMTP_SENDERS`

List verified email addresses authorized to send through SendPulse SMTP.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get SMTP Unsubscribed Users

**Slug:** `SEND_PULSE_SMTP_GET_SMTP_UNSUBSCRIBED`

Get one page of email addresses suppressed from SendPulse SMTP delivery.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date` | string | No | Unsubscribe date filter in YYYY-MM-DD format. |
| `limit` | integer | No | Number of unsubscribe records requested per page. |
| `cursor` | string | No | Offset cursor returned by a previous call. |
| `offset` | integer | No | Zero-based unsubscribe record offset. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove SMTP Unsubscribes

**Slug:** `SEND_PULSE_SMTP_REMOVE_SMTP_UNSUBSCRIBE`

Remove explicitly re-consented email addresses from the SMTP unsubscribe list.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `emails` | array | Yes | Email addresses to remove from the SMTP unsubscribe list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Resubscribe a recipient

**Slug:** `SEND_PULSE_SMTP_RESUBSCRIBE_SMTP_RECIPIENT`

Resubscribe a recipient using the official SendPulse smtp API.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lang` | string ("ru" | "en" | "ua" | "tr" | "es" | "pt") | No | Lang. |
| `email` | string | Yes | Email. |
| `sender` | string | Yes | Sender. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search SMTP Unsubscribe Status

**Slug:** `SEND_PULSE_SMTP_SEARCH_SMTP_UNSUBSCRIBE`

Check whether an email address is suppressed from SendPulse SMTP sending.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | Email address whose SMTP suppression status to check. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Send an email

**Slug:** `SEND_PULSE_SMTP_SEND_SMTP_EMAIL`

Send an email using the official SendPulse smtp API.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | object | Yes | Email. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Unsubscribe a recipient

**Slug:** `SEND_PULSE_SMTP_UNSUBSCRIBE_SMTP_RECIPIENTS`

Unsubscribe a recipient using the official SendPulse smtp API.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `recipients` | array | Yes | Recipients to unsubscribe. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Assign Telegram Contact Operator

**Slug:** `SEND_PULSE_TELEGRAM_ASSIGN_CONTACT_OPERATOR`

Assign an operator as responsible for a SendPulse Telegram contact chat.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID whose chat should be assigned. |
| `operator_id` | integer | Yes | Operator ID to assign as responsible for the chat. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Close Telegram Contact Chat

**Slug:** `SEND_PULSE_TELEGRAM_CLOSE_CONTACT_CHAT`

Close a SendPulse Telegram contact chat and lower its priority.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID whose chat should be closed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Telegram Contact Note

**Slug:** `SEND_PULSE_TELEGRAM_CREATE_CONTACT_NOTE`

Create an internal operator note for a SendPulse Telegram contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `text` | string | Yes | Operator note text. |
| `bot_id` | string | Yes | Bot ID associated with the contact. |
| `contact_id` | string | Yes | Contact ID to annotate. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Telegram Contact

**Slug:** `SEND_PULSE_TELEGRAM_DELETE_CONTACT`

Remove a SendPulse Telegram contact from the audience and subscriber list.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID to remove from the audience and subscriber list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Telegram Contact Note

**Slug:** `SEND_PULSE_TELEGRAM_DELETE_CONTACT_NOTE`

Delete an operator note from a SendPulse Telegram contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `bot_id` | string | Yes | Bot ID associated with the contact. |
| `note_id` | string | Yes | Note ID to delete. |
| `contact_id` | string | Yes | Contact ID associated with the note. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Resume Telegram Contact Autoflows

**Slug:** `SEND_PULSE_TELEGRAM_DELETE_CONTACT_PAUSE_AUTOMATION`

Resume paused autoflows for a SendPulse Telegram contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID whose autoflows should resume. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Telegram Contact Tag

**Slug:** `SEND_PULSE_TELEGRAM_DELETE_CONTACT_TAG`

Remove a tag from a SendPulse Telegram contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag` | string | Yes | Tag to remove from the contact. |
| `contact_id` | string | Yes | Contact ID to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID to update. |
| `variable_id` | string | No | ID of the variable to delete. |
| `variable_name` | string | No | Name of the variable to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Disable Telegram Contact

**Slug:** `SEND_PULSE_TELEGRAM_DISABLE_CONTACT`

Disable a SendPulse Telegram contact so campaigns and autoflows are no longer sent.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID to disable. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Enable Telegram Contact

**Slug:** `SEND_PULSE_TELEGRAM_ENABLE_CONTACT`

Enable a SendPulse Telegram contact to receive campaigns and autoflows.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID to enable. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Telegram Get Account

**Slug:** `SEND_PULSE_TELEGRAM_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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Telegram Get Bot Statistics

**Slug:** `SEND_PULSE_TELEGRAM_GET_BOT_STATISTICS`

Returns general statistics info by bot

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `bot_id` | string | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | integer | No | Maximum items to return on this page. |
| `bot_id` | string | Yes | 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 | No | Opaque cursor returned by the previous page; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Telegram Get Chat Messages

**Slug:** `SEND_PULSE_TELEGRAM_GET_CHAT_MESSAGES`

Returns a list of all messages in correspondence with the specified subscriber

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | integer | No | The limit of pagination items, that will be returned |
| `skip` | integer | No | The offset of pagination items, where starts a current items batch |
| `order` | string ("asc" | "desc") | No | Sort order ASC or DESC |
| `cursor` | string | No | Continuation cursor returned by a previous call. |
| `contact_id` | string | Yes | 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 | No | The id of element after which elements will be searched |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Telegram Get Contact By Telegram Id

**Slug:** `SEND_PULSE_TELEGRAM_GET_CONTACT_BY_TELEGRAM_ID`

Returns a bot contact by Telegram ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `bot_id` | string | Yes | Bot identifier |
| `telegram_id` | integer | Yes | Telegram ID of the user or chat |
| `business_connection_id` | string | No | Telegram business connection identifier (optional) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Telegram Get Contact Notes

**Slug:** `SEND_PULSE_TELEGRAM_GET_CONTACT_NOTES`

Returns a list of existing operator notes by contact

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `bot_id` | string | Yes | 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 | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag` | string | Yes | Created contacts tag to search by |
| `size` | integer | No | The limit of pagination items, that will be returned |
| `skip` | integer | No | The offset of pagination items, where starts a current items batch |
| `bot_id` | string | Yes | 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 | No | Continuation cursor returned by a previous call. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Telegram Get Contacts By Variable

**Slug:** `SEND_PULSE_TELEGRAM_GET_CONTACTS_BY_VARIABLE`

Returns contacts by variable identifier or variable name for the specified bot

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | integer | No | The limit of pagination items, that will be returned |
| `skip` | integer | No | The offset of pagination items, where starts a current items batch |
| `bot_id` | string | No | 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 | No | Continuation cursor returned by a previous call. |
| `variable_id` | string | No | Contacts variable ID to search by; required parameter if you do not pass variable_name and bot_id. |
| `variable_name` | string | No | 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 | Yes | Contact's variable value |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | integer | No | The limit of pagination items, that will be returned |
| `skip` | integer | No | The offset of pagination items, where starts a current items batch |
| `bot_id` | string | Yes | 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 | No | Continuation cursor returned by a previous call. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | integer | No | Maximum items to return on this page. |
| `bot_id` | string | Yes | 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 | No | Opaque cursor returned by the previous page; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | integer | No | Maximum items to return on this page. |
| `bot_id` | string | Yes | 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 | No | Opaque cursor returned by the previous page; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | integer | No | Provider size query parameter. |
| `skip` | integer | No | Provider skip query parameter. |
| `bot_id` | string | Yes | 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 | No | Continuation cursor returned by a previous call. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | ID of the Telegram contact whose unread message count will be reset. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Mark Telegram Contact Unread

**Slug:** `SEND_PULSE_TELEGRAM_MARK_CONTACT_UNREAD`

Mark the last message from a SendPulse Telegram contact as unread.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | ID of the Telegram contact whose last message will be marked unread. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Open Telegram Contact Chat

**Slug:** `SEND_PULSE_TELEGRAM_OPEN_CONTACT_CHAT`

Open a SendPulse Telegram contact chat and increase its priority.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID whose chat should be opened. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `minutes` | integer | Yes | Number of minutes to pause autoflows. |
| `contact_id` | string | Yes | Contact ID whose autoflows should be paused. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `reaction` | object | Yes | Reaction details. |
| `contact_id` | string | Yes | Contact ID that owns the message. |
| `message_id` | string | Yes | Message ID to react to. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Run Telegram Flow

**Slug:** `SEND_PULSE_TELEGRAM_RUN_FLOW`

Launch a Telegram chatbot flow by ID for a contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `flow_id` | string | Yes | ID of the flow to launch. |
| `contact_id` | string | Yes | Contact ID for which to launch the flow. |
| `external_data` | object | No | One-time custom values available to the launched flow. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID for which to launch the flow. |
| `external_data` | object | No | One-time custom values available to the launched flow. |
| `trigger_keyword` | string | Yes | Keyword configured to launch the flow. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `title` | string | Yes | Campaign title. |
| `bot_id` | string | Yes | Bot ID whose subscribers will receive the campaign. |
| `send_at` | string | No | Scheduled date and time in Y-m-d H:i format; omit to send now. |
| `messages` | array | Yes | Campaign messages to send. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `message` | object | Yes | Message type and content to send. |
| `contact_id` | string | Yes | Contact ID to message. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `text` | string | Yes | Text message content, up to 1024 Unicode characters. |
| `contact_id` | string | Yes | Contact ID to message. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set Telegram Contact Tags

**Slug:** `SEND_PULSE_TELEGRAM_SET_CONTACT_TAG`

Assign one or more tags to a SendPulse Telegram contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tags` | array | Yes | Tags to assign to the contact. |
| `contact_id` | string | Yes | Contact ID to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `variables` | array | Yes | Variables identified by name or ID and their new values. |
| `contact_id` | string | Yes | Contact ID to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID whose responsible operator should be removed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Telegram Contact Note

**Slug:** `SEND_PULSE_TELEGRAM_UPDATE_CONTACT_NOTE`

Update an existing internal operator note for a Telegram contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `text` | string | Yes | Operator note text. |
| `bot_id` | string | Yes | Bot ID associated with the contact. |
| `note_id` | string | Yes | ID of the operator note to update. |
| `contact_id` | string | Yes | Contact ID associated with the note. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Assign TikTok Contact Operator

**Slug:** `SEND_PULSE_TIKTOK_ASSIGN_CONTACT_OPERATOR`

Assign an operator to a TikTok contact chat.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID whose chat to assign. |
| `operator_id` | integer | Yes | ID of the operator to assign. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Close TikTok Contact Chat

**Slug:** `SEND_PULSE_TIKTOK_CLOSE_CONTACT_CHAT`

Close a TikTok contact chat and lower its queue priority.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create TikTok Contact Note

**Slug:** `SEND_PULSE_TIKTOK_CREATE_CONTACT_NOTE`

Create an internal operator note for a TikTok contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `text` | string | Yes | Operator note text. |
| `bot_id` | string | Yes | Bot ID associated with the contact. |
| `contact_id` | string | Yes | Contact ID to annotate. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete TikTok Contact

**Slug:** `SEND_PULSE_TIKTOK_DELETE_CONTACT`

Permanently remove a contact from a TikTok bot audience.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete TikTok Contact Note

**Slug:** `SEND_PULSE_TIKTOK_DELETE_CONTACT_NOTE`

Permanently delete an internal operator note for a TikTok contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `bot_id` | string | Yes | Bot ID associated with the contact. |
| `note_id` | string | Yes | ID of the operator note to delete. |
| `contact_id` | string | Yes | Contact ID associated with the note. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Resume TikTok Contact Automation

**Slug:** `SEND_PULSE_TIKTOK_DELETE_CONTACT_PAUSE_AUTOMATION`

Remove an automation pause from a TikTok contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove TikTok Contact Tag

**Slug:** `SEND_PULSE_TIKTOK_DELETE_CONTACT_TAG`

Remove a tag from a TikTok contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag` | string | Yes | Tag to remove from the contact. |
| `contact_id` | string | Yes | Contact ID from which to remove the tag. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete TikTok Contact Variable Value

**Slug:** `SEND_PULSE_TIKTOK_DELETE_CONTACT_VARIABLE`

Permanently delete one variable value from a TikTok contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID whose variable value to delete. |
| `variable_id` | string | No | ID of the variable whose value to delete. |
| `variable_name` | string | No | Name of the variable whose value to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Disable TikTok Contact

**Slug:** `SEND_PULSE_TIKTOK_DISABLE_CONTACT`

Disable a TikTok contact without deleting its data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Enable TikTok Contact

**Slug:** `SEND_PULSE_TIKTOK_ENABLE_CONTACT`

Re-enable a TikTok contact for campaigns and autoflows.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get general statistics info by bot

**Slug:** `SEND_PULSE_TIKTOK_GET_BOT_STATISTICS`

Returns general statistics info by bot

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `bot_id` | string | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | integer | No | Maximum items to return on this page. |
| `bot_id` | string | Yes | 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 | No | Opaque cursor returned by the previous page; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a list of messages

**Slug:** `SEND_PULSE_TIKTOK_GET_CHAT_MESSAGES`

Returns a list of all messages in correspondence with the specified subscriber

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | integer | No | Maximum items to return on this page. |
| `order` | string ("asc" | "desc") | No | Sort order ASC or DESC |
| `contact_id` | string | Yes | 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 | No | Opaque cursor returned by the previous page; omit for the first page. |
| `search_after` | string | No | The id of element after which elements will be searched |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `bot_id` | string | Yes | 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 | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag` | string | Yes | Created contact’s tag to search by |
| `size` | integer | No | Maximum items to return on this page. |
| `bot_id` | string | Yes | 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 | No | Opaque cursor returned by the previous page; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get contacts by variable

**Slug:** `SEND_PULSE_TIKTOK_GET_CONTACTS_BY_VARIABLE`

Returns contacts by variable identifier or variable name for the specified bot

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | integer | No | Maximum items to return on this page. |
| `bot_id` | string | No | 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 | No | Opaque cursor returned by the previous page; omit for the first page. |
| `variable_id` | string | No | Contact’s variable ID to search by; required parameter if you do not pass variable_name and bot_id. |
| `variable_name` | string | No | 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 | Yes | Contact's variable value |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | integer | No | Maximum items to return on this page. |
| `bot_id` | string | Yes | 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 | No | Opaque cursor returned by the previous page; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a list of tags

**Slug:** `SEND_PULSE_TIKTOK_GET_TAG_LIST`

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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | integer | No | Maximum items to return on this page. |
| `bot_id` | string | Yes | 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 | No | Opaque cursor returned by the previous page; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a list of triggers

**Slug:** `SEND_PULSE_TIKTOK_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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | integer | No | Maximum items to return on this page. |
| `bot_id` | string | Yes | 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 | No | Opaque cursor returned by the previous page; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a list of variables

**Slug:** `SEND_PULSE_TIKTOK_LIST_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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | integer | No | Maximum items to return on this page. |
| `bot_id` | string | Yes | 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 | No | Opaque cursor returned by the previous page; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | ID of the TikTok contact whose last message will be marked unread. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | ID of the TikTok contact whose unread message count will be reset. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Open TikTok Contact Chat

**Slug:** `SEND_PULSE_TIKTOK_OPEN_CONTACT_CHAT`

Open a TikTok contact chat and increase its queue priority.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Run TikTok Flow

**Slug:** `SEND_PULSE_TIKTOK_RUN_FLOW`

Launch a TikTok chatbot flow by ID for a contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `flow_id` | string | Yes | ID of the flow to launch. |
| `contact_id` | string | Yes | Contact ID for which to launch the flow. |
| `external_data` | object | No | One-time custom values available to the launched flow. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID for which to launch the flow. |
| `external_data` | object | No | One-time custom values available to the launched flow. |
| `trigger_keyword` | string | Yes | Keyword configured to launch the flow. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Send TikTok Chatbot Campaign

**Slug:** `SEND_PULSE_TIKTOK_SEND_CAMPAIGN`

Send immediately or schedule a campaign to a TikTok bot audience.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `title` | string | Yes | Campaign title. |
| `bot_id` | string | Yes | Bot ID whose subscribers will receive the campaign. |
| `filter` | object | No | Optional subscriber targeting filter. |
| `send_at` | string | No | Scheduled date and time in Y-m-d H:i format; omit to send immediately. |
| `messages` | array | Yes | Campaign messages with channel-specific type and content objects. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Send TikTok Contact Message

**Slug:** `SEND_PULSE_TIKTOK_SEND_CONTACT_MESSAGE`

Send one or more messages directly to a TikTok contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `messages` | array | Yes | Messages to send, with channel-specific type and content objects. |
| `contact_id` | string | Yes | Contact ID that will receive the message. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Assign TikTok Contact Tags

**Slug:** `SEND_PULSE_TIKTOK_SET_CONTACT_TAG`

Assign one or more tags to a TikTok contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tags` | array | Yes | Tags to assign to the contact. |
| `contact_id` | string | Yes | Contact ID to tag. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set TikTok Contact Variables

**Slug:** `SEND_PULSE_TIKTOK_SET_CONTACT_VARIABLE`

Assign or update variable values for a TikTok contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `variables` | array | Yes | Variables to assign by name or ID. |
| `contact_id` | string | Yes | Contact ID whose variables to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Pause TikTok Contact Automation

**Slug:** `SEND_PULSE_TIKTOK_SET_PAUSE_AUTOMATION`

Pause all autoflows for a TikTok contact for a specified duration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `minutes` | integer | Yes | Number of minutes to pause autoflows. |
| `contact_id` | string | Yes | Contact ID whose autoflows to pause. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Unassign TikTok Contact Operator

**Slug:** `SEND_PULSE_TIKTOK_UNASSIGN_CONTACT_OPERATOR`

Remove the assigned operator from a TikTok contact chat.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update TikTok Contact Note

**Slug:** `SEND_PULSE_TIKTOK_UPDATE_CONTACT_NOTE`

Update an existing internal operator note for a TikTok contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `text` | string | Yes | Operator note text. |
| `bot_id` | string | Yes | Bot ID associated with the contact. |
| `note_id` | string | Yes | ID of the operator note to update. |
| `contact_id` | string | Yes | Contact ID associated with the note. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Mailing List

**Slug:** `SEND_PULSE_UPDATE_MAILING_LIST`

Rename an existing Bulk Email mailing list.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | New mailing list name. |
| `mailing_list_id` | integer | Yes | ID of the mailing list to rename. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file` | object | Yes | File to upload. |
| `video_width` | integer | No | Optional output width used only for supported video uploads. |
| `video_height` | integer | No | Optional output height used only for supported video uploads. |
| `directory_path` | string | Yes | Absolute path of the existing File Manager destination directory. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Verification Report

**Slug:** `SEND_PULSE_VERIFIER_CREATE_VERIFICATION_REPORT`

Start generating a downloadable SendPulse mailing-list verification report.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Verified mailing list ID. |
| `lang` | string | No | Language code for report headers. |
| `format` | integer ("2" | "3" | "4") | No | Report format: 2 for CSV, 3 for XLS, or 4 for XLSX. |
| `status` | array | No | Status codes to include: 0 unverified, 1 valid, 2 unconfirmed, 3 invalid. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Verified mailing list ID. |
| `format` | integer | No | Report format code used during creation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Single Email Verification Result

**Slug:** `SEND_PULSE_VERIFIER_GET_SINGLE_VERIFICATION_RESULT`

Get SendPulse verification results for one email address.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | Email address whose verification result to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Verification Progress

**Slug:** `SEND_PULSE_VERIFIER_GET_VERIFICATION_PROGRESS`

Get the current progress of a SendPulse mailing-list verification.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Mailing list ID being verified. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Verify Mailing List

**Slug:** `SEND_PULSE_VERIFIER_VERIFY_MAILING_LIST`

Start verification of a SendPulse mailing list.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Mailing list ID to verify. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Verify Single Email

**Slug:** `SEND_PULSE_VERIFIER_VERIFY_SINGLE_EMAIL`

Start a SendPulse verification for one email address.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | Email address to verify. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### View Verification Report

**Slug:** `SEND_PULSE_VERIFIER_VIEW_VERIFICATION_REPORT`

View metadata and a sample from a generated SendPulse verification report.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Verified mailing list ID. |
| `format` | integer | No | Report format code used during creation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `phones` | array | Yes | Phones. |
| `description` | string | No | Description. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID whose chat should be assigned. |
| `operator_id` | integer | Yes | Operator ID to assign to the chat. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Close Viber Contact Chat

**Slug:** `SEND_PULSE_VIBER_CHATBOT_CLOSE_CONTACT_CHAT`

Close a Viber contact chat and lower its queue priority.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `text` | string | Yes | Operator note text. |
| `bot_id` | string | Yes | Bot ID associated with the contact. |
| `contact_id` | string | Yes | Contact ID to annotate. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Viber Chatbot Contact

**Slug:** `SEND_PULSE_VIBER_CHATBOT_DELETE_CONTACT`

Permanently remove a contact from a SendPulse Viber chatbot audience.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID to permanently remove. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID whose automated flows should resume. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `bot_id` | string | Yes | Bot ID associated with the contact. |
| `note_id` | string | Yes | Note ID to permanently remove. |
| `contact_id` | string | Yes | Contact ID associated with the note. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Viber Chatbot Contact Tag

**Slug:** `SEND_PULSE_VIBER_CHATBOT_DELETE_CONTACT_TAG`

Remove a tag from a SendPulse Viber chatbot contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag` | string | Yes | Tag to remove from the contact. |
| `contact_id` | string | Yes | Contact ID whose tag should be removed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Viber Chatbot Contact Variable

**Slug:** `SEND_PULSE_VIBER_CHATBOT_DELETE_CONTACT_VARIABLE`

Delete one variable from a SendPulse Viber chatbot contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID whose variable should be deleted. |
| `variable_id` | string | No | Variable ID; provide this or variable_name. |
| `variable_name` | string | No | Variable name; provide this or variable_id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID to disable. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Enable Viber Chatbot Contact

**Slug:** `SEND_PULSE_VIBER_CHATBOT_ENABLE_CONTACT`

Enable a previously disabled SendPulse Viber chatbot contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID to enable. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get account info

**Slug:** `SEND_PULSE_VIBER_CHATBOT_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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get general statistics info by bot

**Slug:** `SEND_PULSE_VIBER_CHATBOT_GET_BOT_STATISTICS`

Returns general statistics info by bot

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `bot_id` | string | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a list of messages

**Slug:** `SEND_PULSE_VIBER_CHATBOT_GET_CHAT_MESSAGES`

Returns a list of all messages in correspondence with the specified subscriber

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | integer | No | Maximum items to return on this page. |
| `order` | string ("asc" | "desc") | No | Sort order ASC or DESC |
| `contact_id` | string | Yes | 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 | No | Opaque cursor returned by the previous page; omit for the first page. |
| `search_after` | string | No | The id of element after which elements will be searched |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | integer | No | Maximum items to return on this page. |
| `bot_id` | string | Yes | 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 | No | Opaque cursor returned by the previous page; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `bot_id` | string | Yes | 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 | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag` | string | Yes | Created contact’s tag to search by |
| `size` | integer | No | Maximum items to return on this page. |
| `bot_id` | string | Yes | 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 | No | Opaque cursor returned by the previous page; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get contacts by variable

**Slug:** `SEND_PULSE_VIBER_CHATBOT_GET_CONTACTS_BY_VARIABLE`

Returns contacts by variable identifier or variable name for the specified bot

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | integer | No | Maximum items to return on this page. |
| `bot_id` | string | No | 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 | No | Opaque cursor returned by the previous page; omit for the first page. |
| `variable_id` | string | No | Contact’s variable ID to search by; required parameter if you do not pass variable_name and bot_id. |
| `variable_name` | string | No | 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 | Yes | Contact's variable value |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Viber Chatbot Flows

**Slug:** `SEND_PULSE_VIBER_CHATBOT_GET_FLOWS`

Return flows configured for a SendPulse Viber chatbot bot.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | integer | No | Maximum flows to return. |
| `skip` | integer | No | Number of flows to skip. |
| `bot_id` | string | Yes | Bot ID whose flows to return. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | integer | No | Maximum tags to return. |
| `skip` | integer | No | Number of tags to skip. |
| `bot_id` | string | Yes | Bot ID whose tags to return. |
| `next_cursor` | string | No | Continuation cursor from a previous response. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | integer | No | Maximum variables to return. |
| `skip` | integer | No | Number of variables to skip. |
| `bot_id` | string | Yes | Bot ID whose variables to return. |
| `next_cursor` | string | No | Continuation cursor from a previous response. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | integer | No | Maximum triggers to return. |
| `skip` | integer | No | Number of triggers to skip. |
| `bot_id` | string | Yes | Bot ID whose triggers to return. |
| `next_cursor` | string | No | Continuation cursor from a previous response. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | ID of the Viber chatbot contact whose unread message count will be reset. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | ID of the Viber chatbot contact whose last message will be marked unread. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID whose chat should be opened. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Run Viber Chatbot Flow

**Slug:** `SEND_PULSE_VIBER_CHATBOT_RUN_FLOW`

Run a specific SendPulse Viber chatbot flow for a contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `flow_id` | string | Yes | Flow ID to run. |
| `contact_id` | string | Yes | Contact ID for which to run the flow. |
| `external_data` | object | No | One-time custom variables available to the selected flow. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID for which to run the flow. |
| `external_data` | object | No | One-time custom variables available to the triggered flow. |
| `trigger_keyword` | string | Yes | Keyword or command that launches the flow. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Send Viber Chatbot Campaign

**Slug:** `SEND_PULSE_VIBER_CHATBOT_SEND_CAMPAIGN`

Send immediately or schedule a campaign to a Viber bot audience.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `title` | string | Yes | Campaign title. |
| `bot_id` | string | Yes | Bot ID whose subscribers will receive the campaign. |
| `filter` | object | No | Optional subscriber targeting filter. |
| `send_at` | string | No | Scheduled date and time in Y-m-d H:i format; omit to send immediately. |
| `messages` | array | Yes | Campaign messages with channel-specific type and content objects. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `messages` | array | Yes | Messages to send, including each message type and content. |
| `contact_id` | string | Yes | Contact ID that should receive the message. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tags` | array | Yes | Tags to assign to the contact. |
| `contact_id` | string | Yes | Contact ID whose tags should be updated. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `variables` | array | Yes | Variables to assign to the contact. |
| `contact_id` | string | Yes | Contact ID whose variables should be updated. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `minutes` | integer | Yes | Number of minutes to pause automated flows. |
| `contact_id` | string | Yes | Contact ID whose automated flows should be paused. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID whose operators should be unassigned. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `text` | string | Yes | Replacement operator note text. |
| `bot_id` | string | Yes | Bot ID associated with the contact. |
| `note_id` | string | Yes | Note ID to update. |
| `contact_id` | string | Yes | Contact ID associated with the note. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a Viber campaign

**Slug:** `SEND_PULSE_VIBER_CREATE_VIBER_CAMPAIGN`

Create a Viber campaign using the official SendPulse viber API.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `message` | string | No | Message. |
| `send_date` | string | Yes | 'now' or 'YYYY-MM-DD HH:MM:SS' |
| `sender_id` | integer | Yes | Sender id. |
| `task_name` | string | No | Task name. |
| `additional` | object | No | Additional. |
| `recipients` | array | No | Recipients. |
| `address_book` | integer | No | Address book. |
| `message_type` | integer ("2" | "3") | Yes | 2 - promo, 3 - system |
| `stretch_time` | integer | No | Stretch time. |
| `message_live_time` | integer | Yes | Message live time. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Viber Blacklist

**Slug:** `SEND_PULSE_VIBER_GET_VIBER_BLACKLIST`

Retrieve one page of globally blacklisted Viber contacts.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of blacklist records requested per page. |
| `offset` | integer | No | Zero-based blacklist record offset. |
| `next_cursor` | string | No | Continuation cursor returned by a previous call. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Viber Campaign Statistics

**Slug:** `SEND_PULSE_VIBER_GET_VIBER_CAMPAIGN_STATS`

Retrieve delivery and engagement statistics for a Viber campaign.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Viber campaign ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Viber Campaign Recipients

**Slug:** `SEND_PULSE_VIBER_GET_VIBER_RECIPIENTS`

Retrieve recipient-level delivery records for a Viber campaign.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Viber campaign ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Viber Sender Profile

**Slug:** `SEND_PULSE_VIBER_GET_VIBER_SENDER_PROFILE`

Retrieve configuration and verification status for a Viber sender ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Viber sender ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Numbers From Viber Blacklist

**Slug:** `SEND_PULSE_VIBER_REMOVE_VIBER_BLACKLIST`

Remove explicitly re-consented phone numbers from the Viber blacklist.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `phones` | array | Yes | Phone numbers to remove from the Viber blacklist. Common formatting is removed before sending. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Web Push Campaign

**Slug:** `SEND_PULSE_WEB_PUSH_CREATE_WEB_PUSH_CAMPAIGN`

Create and queue a SendPulse browser notification campaign.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ttl` | integer | Yes | Notification lifetime in seconds, up to 86400. |
| `body` | string | Yes | Notification body text. |
| `icon` | string | No | JSON string containing an icon name and Base64 data. |
| `link` | string | No | Destination URL opened from the notification. |
| `image` | string | No | JSON string containing an image name and Base64 data. |
| `title` | string | Yes | Web push campaign title. |
| `filter` | object | No | Custom-variable segmentation filter. |
| `buttons` | string | No | JSON string defining up to two notification buttons. |
| `send_date` | string | No | Scheduled campaign date and time. |
| `filter_url` | string | No | JSON string containing URL filters. |
| `website_id` | integer | Yes | Target SendPulse website ID. |
| `filter_lang` | string | No | Subscriber language filter. |
| `stretch_time` | integer | No | Optional delivery time-stretch setting. |
| `filter_region` | string | No | JSON string containing country-code filters. |
| `filter_browser` | string | No | Subscriber browser filter. |
| `filter_subscription_date_to` | string | No | Latest subscription date to target. |
| `filter_subscription_date_from` | string | No | Earliest subscription date to target. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Web Push Campaigns

**Slug:** `SEND_PULSE_WEB_PUSH_GET_WEB_PUSH_CAMPAIGNS`

Get one page of historical SendPulse web push campaigns.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of web push campaigns requested per page. |
| `cursor` | string | No | Offset cursor returned by a previous call. |
| `offset` | integer | No | Zero-based web push campaign offset. |
| `date_to` | string | No | Campaign end date-time filter in YYYY-MM-DD HH:MM:SS format. |
| `date_from` | string | No | Campaign start date-time filter in YYYY-MM-DD HH:MM:SS format. |
| `website_id` | integer | No | Website ID used to filter campaigns. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Web push campaign ID to inspect. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Web push website ID whose code to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Web push website ID whose subscribers to count. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Web push website ID whose subscribers to list. |
| `limit` | integer | No | Number of subscribers requested per page. |
| `cursor` | string | No | Offset cursor returned by a previous call. |
| `offset` | integer | No | Zero-based subscriber offset. |
| `subscription_date_to` | string | No | Latest subscription date in YYYY-MM-DD format. |
| `subscription_date_from` | string | No | Earliest subscription date in YYYY-MM-DD format. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Web push website ID whose variables to list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Web push website ID to inspect. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of websites requested per page. |
| `cursor` | string | No | Offset cursor returned by a previous call. |
| `offset` | integer | No | Zero-based website offset. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Web push subscriber ID. |
| `state` | integer ("0" | "1") | Yes | Subscriber state: 1 to activate or 0 to deactivate. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Assign WhatsApp Contact Operator

**Slug:** `SEND_PULSE_WHATSAPP_ASSIGN_CONTACT_OPERATOR`

Assign a SendPulse operator as responsible for a WhatsApp contact chat.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID whose chat will be assigned. |
| `operator_id` | integer | Yes | SendPulse operator ID to assign. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Close WhatsApp Contact Chat

**Slug:** `SEND_PULSE_WHATSAPP_CLOSE_CONTACT_CHAT`

Close a SendPulse WhatsApp contact chat and lower its queue priority.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID whose chat should be closed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create WhatsApp Contact

**Slug:** `SEND_PULSE_WHATSAPP_CREATE_CONTACT`

Create a contact in a SendPulse WhatsApp bot audience.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Contact name. |
| `tags` | array | No | Tags to assign to the contact. |
| `phone` | string | Yes | Phone number in international format. |
| `bot_id` | string | Yes | Bot ID to which the contact should be added. |
| `variables` | array | No | Variables to assign to the contact. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create WhatsApp Contact Note

**Slug:** `SEND_PULSE_WHATSAPP_CREATE_CONTACT_NOTE`

Create an internal operator note for a SendPulse WhatsApp contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `text` | string | Yes | Operator note text. |
| `bot_id` | string | Yes | Bot ID associated with the contact. |
| `contact_id` | string | Yes | Contact ID to annotate. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete WhatsApp Contact

**Slug:** `SEND_PULSE_WHATSAPP_DELETE_CONTACT`

Permanently remove a contact from a SendPulse WhatsApp bot audience.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID to permanently remove. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete WhatsApp Contact Note

**Slug:** `SEND_PULSE_WHATSAPP_DELETE_CONTACT_NOTE`

Permanently remove an operator note from a SendPulse WhatsApp contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `bot_id` | string | Yes | Bot ID associated with the contact. |
| `note_id` | string | Yes | Note ID to permanently remove. |
| `contact_id` | string | Yes | Contact ID associated with the note. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove WhatsApp Contact Tag

**Slug:** `SEND_PULSE_WHATSAPP_DELETE_CONTACT_TAG`

Remove one tag from a SendPulse WhatsApp contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag` | string | Yes | Exact case-sensitive tag to remove. |
| `contact_id` | string | Yes | Contact ID from which to remove the tag. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete WhatsApp Contact Variable Value

**Slug:** `SEND_PULSE_WHATSAPP_DELETE_CONTACT_VARIABLE`

Delete one stored variable value from a SendPulse WhatsApp contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID whose variable value will be deleted. |
| `variable_id` | string | No | Variable ID; provide this or variable_name. |
| `variable_name` | string | No | Variable name; provide this or variable_id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Resume WhatsApp Contact Automation

**Slug:** `SEND_PULSE_WHATSAPP_DELETE_PAUSE_AUTOMATION`

Remove an automation pause and resume autoflows for a WhatsApp contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID whose automation pause will be removed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Disable WhatsApp Contact

**Slug:** `SEND_PULSE_WHATSAPP_DISABLE_CONTACT`

Disable a WhatsApp contact from receiving campaigns and autoflows.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID to disable. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Enable WhatsApp Contact

**Slug:** `SEND_PULSE_WHATSAPP_ENABLE_CONTACT`

Enable a WhatsApp contact to receive campaigns and autoflows.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID to enable. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get WhatsApp Chatbot Account

**Slug:** `SEND_PULSE_WHATSAPP_GET_ACCOUNT`

Return the SendPulse WhatsApp chatbot plan, limits, and usage statistics.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `bot_id` | string | Yes | Bot ID whose statistics to return. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List WhatsApp Bot Variables

**Slug:** `SEND_PULSE_WHATSAPP_GET_BOT_VARIABLES`

Return one page of variables configured for a SendPulse WhatsApp bot.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | integer | No | Maximum variables to return. |
| `skip` | integer | No | Number of variables to skip. |
| `bot_id` | string | Yes | Bot ID whose variables to return. |
| `next_cursor` | string | No | Continuation cursor from a previous response. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List WhatsApp Chat Messages

**Slug:** `SEND_PULSE_WHATSAPP_GET_CHAT_MESSAGES`

Return one page of messages exchanged with a SendPulse WhatsApp contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | integer | No | Maximum messages to return. |
| `skip` | integer | No | Number of messages to skip. |
| `order` | string ("asc" | "desc") | No | Message sort order. |
| `contact_id` | string | Yes | Contact ID whose messages to return. |
| `next_cursor` | string | No | Continuation cursor from a previous response. |
| `search_after` | string | No | Message ID after which to search. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List WhatsApp Chats

**Slug:** `SEND_PULSE_WHATSAPP_GET_CHATS`

Return one page of chats for a SendPulse WhatsApp bot.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | integer | No | Maximum chats to return. |
| `skip` | integer | No | Number of chats to skip. |
| `bot_id` | string | Yes | Bot ID whose chats to return. |
| `next_cursor` | string | No | Continuation cursor from a previous response. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get WhatsApp Contact by ID

**Slug:** `SEND_PULSE_WHATSAPP_GET_CONTACT_BY_ID`

Return SendPulse WhatsApp contact information by contact ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Contact ID to look up. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `phone` | string | Yes | Contact phone number in international format. |
| `bot_id` | string | Yes | Bot ID to search within. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List WhatsApp Contact Notes

**Slug:** `SEND_PULSE_WHATSAPP_GET_CONTACT_NOTES`

Return operator notes for a SendPulse WhatsApp contact and bot.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `bot_id` | string | Yes | Bot ID associated with the contact. |
| `contact_id` | string | Yes | Contact ID whose operator notes to return. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID whose automation pause to inspect. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag` | string | Yes | Contact tag to search for. |
| `size` | integer | No | Maximum contacts to return. |
| `skip` | integer | No | Number of contacts to skip. |
| `bot_id` | string | Yes | Bot ID to search within. |
| `next_cursor` | string | No | Continuation cursor from a previous response. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | integer | No | Maximum contacts to return. |
| `skip` | integer | No | Number of contacts to skip. |
| `bot_id` | string | No | Bot ID required when searching by variable_name. |
| `next_cursor` | string | No | Continuation cursor from a previous response. |
| `variable_id` | string | No | Variable ID to search by; omit when using variable_name and bot_id. |
| `variable_name` | string | No | Variable name to search by together with bot_id. |
| `variable_value` | string | Yes | Variable value to match. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List WhatsApp Templates

**Slug:** `SEND_PULSE_WHATSAPP_GET_TEMPLATE_LIST`

Return message templates configured for a SendPulse WhatsApp bot.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `bot_id` | string | Yes | Bot ID whose templates to return. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List WhatsApp Triggers

**Slug:** `SEND_PULSE_WHATSAPP_GET_TRIGGERS`

Return one page of triggers configured for a SendPulse WhatsApp bot.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | integer | No | Maximum triggers to return. |
| `skip` | integer | No | Number of triggers to skip. |
| `bot_id` | string | Yes | Bot ID whose triggers to return. |
| `next_cursor` | string | No | Continuation cursor from a previous response. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List WhatsApp Flows

**Slug:** `SEND_PULSE_WHATSAPP_LIST_FLOWS`

Return flows configured for a SendPulse WhatsApp bot.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | integer | No | Maximum flows to return. |
| `skip` | integer | No | Number of flows to skip. |
| `bot_id` | string | Yes | Bot ID whose flows to return. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List WhatsApp Tags

**Slug:** `SEND_PULSE_WHATSAPP_LIST_TAGS`

Return one page of tags configured for a SendPulse WhatsApp bot.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | integer | No | Maximum tags to return. |
| `skip` | integer | No | Number of tags to skip. |
| `bot_id` | string | Yes | Bot ID whose tags to return. |
| `next_cursor` | string | No | Continuation cursor from a previous response. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | ID of the WhatsApp contact whose last message will be marked unread. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | ID of the WhatsApp contact whose unread message count will be reset. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID whose chat will be marked open. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `reaction` | string | Yes | Emoji character or Unicode escape sequence to apply to the message. |
| `message_id` | string | Yes | ID of the inbound WhatsApp message to react to. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Run WhatsApp Flow

**Slug:** `SEND_PULSE_WHATSAPP_RUN_FLOW`

Launch a SendPulse WhatsApp flow by ID for one contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `flow_id` | string | Yes | Flow ID to launch. |
| `contact_id` | string | Yes | Contact ID for which to launch the flow. |
| `external_data` | object | No | One-time custom values available during this flow run. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID for which to launch the flow. |
| `external_data` | object | No | One-time custom values available during this flow run. |
| `trigger_keyword` | string | Yes | Configured keyword that triggers the flow. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `title` | string | Yes | Campaign title. |
| `bot_id` | string | Yes | Bot ID whose active subscribers will receive the campaign. |
| `filter` | object | No | Optional subscriber targeting filter. |
| `send_at` | string | No | Scheduled date and time in Y-m-d H:i format; omit to send immediately. |
| `messages` | array | Yes | Messages to send in the campaign. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Send WhatsApp Contact Message

**Slug:** `SEND_PULSE_WHATSAPP_SEND_CONTACT_MESSAGE`

Send a typed free-form message to a SendPulse WhatsApp contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `message` | string | Yes | Typed WhatsApp message to send. |
| `contact_id` | string | Yes | Contact ID that will receive the message. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Send WhatsApp Typing Indicator

**Slug:** `SEND_PULSE_WHATSAPP_SEND_CONTACT_TYPING`

Send a typing indicator to a SendPulse WhatsApp contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID that will receive the typing indicator. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `phone` | string | Yes | Contact phone number in international format. |
| `bot_id` | string | Yes | Bot ID whose audience will receive the message. |
| `message` | string | Yes | Typed WhatsApp message to send. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `phone` | string | Yes | Contact phone number in international format. |
| `bot_id` | string | Yes | Bot ID whose audience will receive the template. |
| `template` | object | Yes | Template content to send. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `title` | string | Yes | Campaign title. |
| `bot_id` | string | Yes | Bot ID whose active subscribers will receive the campaign. |
| `send_at` | string | No | Scheduled date and time in Y-m-d H:i format; omit to send immediately. |
| `template` | object | Yes | Approved WhatsApp template content. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `template` | object | Yes | Template content to send. |
| `contact_id` | string | Yes | Contact ID that will receive the template. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set WhatsApp Contact Name

**Slug:** `SEND_PULSE_WHATSAPP_SET_CONTACT_NAME`

Update the display name of a SendPulse WhatsApp contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | New display name for the contact. |
| `contact_id` | string | Yes | Contact ID to rename. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Assign WhatsApp Contact Tags

**Slug:** `SEND_PULSE_WHATSAPP_SET_CONTACT_TAG`

Assign one or more tags to a SendPulse WhatsApp contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tags` | array | Yes | Tags to assign to the contact. |
| `contact_id` | string | Yes | Contact ID to tag. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set WhatsApp Contact Variables

**Slug:** `SEND_PULSE_WHATSAPP_SET_CONTACT_VARIABLE`

Add or update variable values for a SendPulse WhatsApp contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `variables` | array | Yes | Variable values to add or update. |
| `contact_id` | string | Yes | Contact ID whose variables will be updated. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Pause WhatsApp Contact Automation

**Slug:** `SEND_PULSE_WHATSAPP_SET_PAUSE_AUTOMATION`

Pause autoflows for a SendPulse WhatsApp contact for a specified duration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `minutes` | integer | Yes | Number of minutes to pause autoflows. |
| `contact_id` | string | Yes | Contact ID whose autoflows will be paused. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Unassign WhatsApp Contact Operators

**Slug:** `SEND_PULSE_WHATSAPP_UN_ASSIGN_CONTACT_OPERATORS`

Remove the responsible operator assignment from a WhatsApp contact chat.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Contact ID whose chat operator will be unassigned. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update WhatsApp Contact Note

**Slug:** `SEND_PULSE_WHATSAPP_UPDATE_CONTACT_NOTE`

Update an existing internal operator note for a WhatsApp contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `text` | string | Yes | Replacement note text. |
| `bot_id` | string | Yes | Bot ID associated with the contact. |
| `note_id` | string | Yes | Existing note ID to update. |
| `contact_id` | string | Yes | Contact ID whose note will be updated. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |