# Postalytics

Direct Mail Automation software in the cloud with deep integration to CRM and workflows, making direct mail look, act and feel like a digital marketing channel

- **Category:** marketing automation
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 24
- **Triggers:** 0
- **Slug:** `POSTALYTICS`
- **Version:** 00000000_00

## Tools

### Add Account

**Slug:** `POSTALYTICS_ADD_ACCOUNT`

Tool to create a new sub-account in the Postalytics system. Use when you need to create a new account with a unique ID associated with the requester's user ID as parent. The response includes the API key and user ID for the new account, which should be stored for future API calls.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `phone` | string | No | The phone number associated with the account |
| `company` | string | No | The company name associated with the account |
| `password` | string | Yes | The password associated with the account. Must follow password guidelines - minimum 8 characters including 1 uppercase letter, 1 lowercase letter, 1 number, and 1 special character |
| `username` | string | Yes | The username associated with the account - must be unique |
| `last_name` | string | Yes | The last name of the account holder |
| `first_name` | string | Yes | The first name of the account holder |
| `address_zip` | string | No | The zip code associated with the account's address |
| `address_city` | string | No | The city associated with the account's address |
| `address_state` | string | No | The state associated with the account's address |
| `email_address` | string | No | The email address associated with the account |
| `address_street` | string | No | The street address associated with the 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 Contact

**Slug:** `POSTALYTICS_ADD_CONTACT`

Tool to add a contact to a specified contact list with their information. Use when you need to create a new contact or update an existing one on a contact list.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `phone` | string | No | Phone number of the contact. |
| `company` | string | No | Company name of the contact. |
| `website` | string | No | Website URL of the contact. |
| `last_name` | string | No | Last name of the contact. |
| `contact_id` | integer | No | The unique id of the contact. Required for updating but not required for inserting. |
| `first_name` | string | No | First name of the contact. |
| `occupation` | string | No | Occupation of the contact. |
| `address_zip` | string | No | Zip/postal code for the contact address. |
| `var_field_1` | string | No | Custom variable field 1 for additional data. |
| `var_field_2` | string | No | Custom variable field 2 for additional data. |
| `var_field_3` | string | No | Custom variable field 3 for additional data. |
| `var_field_4` | string | No | Custom variable field 4 for additional data. |
| `var_field_5` | string | No | Custom variable field 5 for additional data. |
| `var_field_6` | string | No | Custom variable field 6 for additional data. |
| `var_field_7` | string | No | Custom variable field 7 for additional data. |
| `var_field_8` | string | No | Custom variable field 8 for additional data. |
| `var_field_9` | string | No | Custom variable field 9 for additional data. |
| `address_city` | string | No | City for the contact address. |
| `created_date` | string | No | The date and time when the contact was created (ISO 8601 format). |
| `mobile_phone` | string | No | Mobile phone number of the contact. |
| `var_field_10` | string | No | Custom variable field 10 for additional data. |
| `var_field_11` | string | No | Custom variable field 11 for additional data. |
| `var_field_12` | string | No | Custom variable field 12 for additional data. |
| `var_field_13` | string | No | Custom variable field 13 for additional data. |
| `var_field_14` | string | No | Custom variable field 14 for additional data. |
| `var_field_15` | string | No | Custom variable field 15 for additional data. |
| `var_field_16` | string | No | Custom variable field 16 for additional data. |
| `var_field_17` | string | No | Custom variable field 17 for additional data. |
| `var_field_18` | string | No | Custom variable field 18 for additional data. |
| `var_field_19` | string | No | Custom variable field 19 for additional data. |
| `var_field_20` | string | No | Custom variable field 20 for additional data. |
| `var_field_21` | string | No | Custom variable field 21 for additional data. |
| `var_field_22` | string | No | Custom variable field 22 for additional data. |
| `var_field_23` | string | No | Custom variable field 23 for additional data. |
| `var_field_24` | string | No | Custom variable field 24 for additional data. |
| `var_field_25` | string | No | Custom variable field 25 for additional data. |
| `var_field_26` | string | No | Custom variable field 26 for additional data. |
| `var_field_27` | string | No | Custom variable field 27 for additional data. |
| `var_field_28` | string | No | Custom variable field 28 for additional data. |
| `var_field_29` | string | No | Custom variable field 29 for additional data. |
| `var_field_30` | string | No | Custom variable field 30 for additional data. |
| `var_field_31` | string | No | Custom variable field 31 for additional data. |
| `var_field_32` | string | No | Custom variable field 32 for additional data. |
| `var_field_33` | string | No | Custom variable field 33 for additional data. |
| `var_field_34` | string | No | Custom variable field 34 for additional data. |
| `var_field_35` | string | No | Custom variable field 35 for additional data. |
| `address_state` | string | No | State for the contact address. |
| `email_address` | string | No | Email address of the contact. |
| `address_street` | string | No | Street address for the contact. |
| `address_street2` | string | No | Second line of street address for the contact. |
| `contact_list_id` | integer | Yes | The id of the contact list to add this contact 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 |

### Create New Campaign

**Slug:** `POSTALYTICS_CREATE_NEW_CAMPAIGN`

Tool to create a new direct mail campaign in Postalytics. Use when you need to start a new campaign with specified sender details and template. Important: A template must be created and proofed before creating the campaign.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `SenderZip` | string | Yes | The sender's postal code. |
| `SenderCity` | string | Yes | The sender's city. |
| `SenderName` | string | Yes | The name of the campaign sender. |
| `PostageType` | integer | Yes | Postage type for the campaign. 0 for first class, 1 for standard mail. |
| `SenderState` | string | Yes | The sender's state abbreviation (e.g., NY, CA). |
| `CreditTypeId` | integer | Yes | Identifies media type. Valid values are 21-34, including postcards, letters, and bifolds in first class or standard mail. |
| `SenderCountry` | string | No | The sender's country code. Defaults to 'US' if not specified. |
| `DirectMailName` | string | Yes | The name of the direct mail campaign. |
| `SenderAddress1` | string | Yes | The sender's primary street address. |
| `SenderAddress2` | string | No | The sender's secondary address line (e.g., apartment, suite number). |
| `TemplateFrontId` | integer | Yes | The ID of the template to use for the front of this campaign. Template must be created and proofed before campaign creation. |
| `TemplateEnvelopeId` | integer | No | Custom envelope ID for letter campaigns. Optional parameter only applicable to letter-type 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 |

### Create Suppression List

**Slug:** `POSTALYTICS_CREATE_SUPPRESSION_LIST`

Tool to create a new suppression list that can be used in campaigns to suppress contacts from being sent mail. Use when you need to create an empty suppression list. Note that contacts must be added separately using the SuppressionListContact API after the list is created.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `Name` | string | No | The name of the suppression list. |
| `Country` | string | No | The country associated with the suppression list (e.g., 'US', 'CA'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | 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 Suppression List Contact

**Slug:** `POSTALYTICS_CREATE_SUPPRESSION_LIST_CONTACT`

Tool to create a new suppression contact on a specified suppression list. Use when you need to add a contact to a suppression list to prevent them from receiving mailings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `Zip` | string | No | Zip/postal code. |
| `City` | string | No | City. |
| `Email` | string | No | Email address of the contact. |
| `Phone` | string | No | Phone number. |
| `State` | string | No | State. |
| `Mobile` | string | No | Mobile phone number. |
| `Address` | string | No | Primary address line. |
| `Company` | string | No | Company name. |
| `Country` | string | No | Country. |
| `Website` | string | No | Website URL. |
| `list_id` | integer | Yes | The id of the suppression list to add the contact to. |
| `Address2` | string | No | Secondary address line. |
| `LastName` | string | No | Last name of the contact. |
| `FirstName` | string | No | First name of the contact. |
| `VarField1` | string | No | Custom variable field 1. |
| `VarField2` | string | No | Custom variable field 2. |
| `VarField3` | string | No | Custom variable field 3. |
| `VarField4` | string | No | Custom variable field 4. |
| `VarField5` | string | No | Custom variable field 5. |
| `VarField6` | string | No | Custom variable field 6. |
| `VarField7` | string | No | Custom variable field 7. |
| `VarField8` | string | No | Custom variable field 8. |
| `VarField9` | string | No | Custom variable field 9. |
| `Occupation` | string | No | Occupation. |
| `VarField10` | string | No | Custom variable field 10. |
| `VarField11` | string | No | Custom variable field 11. |
| `VarField12` | string | No | Custom variable field 12. |
| `VarField13` | string | No | Custom variable field 13. |
| `VarField14` | string | No | Custom variable field 14. |
| `VarField15` | string | No | Custom variable field 15. |
| `VarField16` | string | No | Custom variable field 16. |
| `VarField17` | string | No | Custom variable field 17. |
| `VarField18` | string | No | Custom variable field 18. |
| `VarField19` | string | No | Custom variable field 19. |
| `VarField20` | string | No | Custom variable field 20. |
| `VarField21` | string | No | Custom variable field 21. |
| `VarField22` | string | No | Custom variable field 22. |
| `VarField23` | string | No | Custom variable field 23. |
| `VarField24` | string | No | Custom variable field 24. |
| `VarField25` | string | No | Custom variable field 25. |
| `VarField26` | string | No | Custom variable field 26. |
| `VarField27` | string | No | Custom variable field 27. |
| `VarField28` | string | No | Custom variable field 28. |
| `VarField29` | string | No | Custom variable field 29. |
| `VarField30` | string | No | Custom variable field 30. |
| `VarField31` | string | No | Custom variable field 31. |
| `VarField32` | string | No | Custom variable field 32. |
| `VarField33` | string | No | Custom variable field 33. |
| `VarField34` | string | No | Custom variable field 34. |
| `VarField35` | string | No | Custom variable field 35. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | 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 Template

**Slug:** `POSTALYTICS_CREATE_TEMPLATE`

Tool to create a new template with full HTML for postcard or letter. Use when you need to create a template by providing complete HTML markup or image URLs for front/back. The template can be used for various mail types including postcards, letters, and bifolds.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `back` | string | No | URL for full-sized back image or letter content. Used when is_full_html is false. |
| `html` | string | Yes | Complete HTML markup for the template following Postalytics formatting standards. |
| `name` | string | Yes | Template identifier name (e.g., 'The Architect', 'Welcome Postcard'). |
| `size` | string | Yes | Template dimensions: '0'=letter, '1'=4x6 postcard, '2'=6x9 postcard, '3'=6x11 postcard, '6'=12x9 bifold, '7'=6x18 bifold. |
| `count` | integer | No | Page count for letter templates. Default: 0. |
| `front` | string | No | URL for full-sized front image or letter content. Used when is_full_html is false. |
| `is_proofed` | boolean | No | Indicates proofing status; bypasses web app safeguards when true. Default: false. |
| `font_family` | string | No | CSS font family designation (e.g., 'sans-serif', 'Arial'). |
| `is_full_html` | boolean | No | Determines whether HTML is sent as complete markup (true) or as separate front/back images (false). Default: true. |
| `is_double_sided` | boolean | No | Specifies double-sided letter configuration. Default: false. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | 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 Webhook

**Slug:** `POSTALYTICS_CREATE_WEBHOOK`

Tool to create a new webhook to receive campaign event notifications from Postalytics. Use when you need to set up a webhook endpoint that will be notified about campaign events like sent, delivered, opened, or clicked.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | The destination URL that will receive webhook event notifications. |
| `name` | string | Yes | Human-readable name for the webhook to help identify it. |
| `events` | array | Yes | List of campaign event types to subscribe to. Common events include 'sent', 'delivered', 'opened', 'clicked'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | 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 Account

**Slug:** `POSTALYTICS_DELETE_ACCOUNT`

Tool to delete a Postalytics account and all associated campaigns, templates, and lists. Use when you need to permanently remove a sub account or sub user account. Cannot delete parent accounts.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | integer | Yes | The unique identifier of the account to delete. Only sub accounts and sub user accounts can be deleted. Cannot delete parent accounts. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | 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 Campaign

**Slug:** `POSTALYTICS_DELETE_CAMPAIGN`

Tool to delete a campaign from the system. Use when you need to remove a campaign that is no longer needed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Integer contains the Id of the campaign 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 Suppression List

**Slug:** `POSTALYTICS_DELETE_SUPPRESSION_LIST`

Tool to delete a specified suppression list. Use when you need to remove a suppression list that is no longer needed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The ID of the suppression list 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 Suppression List Contact

**Slug:** `POSTALYTICS_DELETE_SUPPRESSION_LIST_CONTACT`

Tool to delete a specific contact from a suppression list. Use when you need to remove a contact from a suppression list in Postalytics.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_id` | integer | Yes | The ID of the suppression list |
| `contact_id` | integer | Yes | The ID of the contact to be deleted from the 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 All Contact Lists

**Slug:** `POSTALYTICS_GET_ALL_CONTACT_LISTS`

Tool to retrieve all contact lists for an account. Use when you need to get a complete list of contact lists including their IDs, names, item counts, and creation dates.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | 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 Contacts on a List

**Slug:** `POSTALYTICS_GET_ALL_CONTACTS_ON_A_LIST`

Tool to retrieve all contacts from a specified contact list with pagination support. Use when you need to get contacts from a list, with optional pagination using start offset and limit parameters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of contacts to return per page. Controls pagination page size. |
| `start` | integer | No | Pagination offset for retrieving contacts. Use 0 for the first page. |
| `list_id` | integer | Yes | The unique identifier of the contact list to retrieve contacts from. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | 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 Drip Campaigns

**Slug:** `POSTALYTICS_GET_ALL_DRIP_CAMPAIGNS`

Tool to retrieve all triggered drip campaign names and endpoint IDs in the account. Use when you need to list all available drip campaigns for the authenticated user.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | 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 Flows

**Slug:** `POSTALYTICS_GET_ALL_FLOWS`

Tool to retrieve all flows for the requester's account. Use when you need to list or browse available flows.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | 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 Webhooks

**Slug:** `POSTALYTICS_GET_ALL_WEBHOOKS`

Tool to retrieve all webhooks configured for the authenticated account. Use when you need to view webhook configurations for 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 Integrations

**Slug:** `POSTALYTICS_GET_INTEGRATIONS`

Tool to retrieve all Connect integrations configured for the authenticated user's account. Use when you need to view CRM or data source integrations.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | 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 My Account

**Slug:** `POSTALYTICS_GET_MY_ACCOUNT`

Tool to retrieve basic account information for the authenticated user. Use when you need to get account details such as contact information, address, or API key.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | 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 Suppression List

**Slug:** `POSTALYTICS_GET_SUPPRESSION_LIST`

Tool to get the details of a suppression list based on the id supplied. Use when you need to retrieve information about a specific suppression list.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The id of the suppression list 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 Suppression List Contact

**Slug:** `POSTALYTICS_GET_SUPPRESSION_LIST_CONTACT`

Tool to retrieve a specific contact from a suppression list. Use when you need to get details about a contact on a specific suppression list by their list ID and contact ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `offset` | integer | No | Offset for pagination |
| `list_id` | integer | Yes | The ID of the suppression list |
| `contact_id` | integer | Yes | The ID of the suppression list 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 Suppression List Contacts

**Slug:** `POSTALYTICS_GET_SUPPRESSION_LIST_CONTACTS`

Tool to get all contacts on a specified suppression list. Use when you need to retrieve contacts that are suppressed for a particular list.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `listId` | integer | Yes | The listId of the suppression list to get contacts for. |
| `offset` | integer | No | Offset count for paging through results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | 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 Suppression Lists

**Slug:** `POSTALYTICS_GET_SUPPRESSION_LISTS`

Tool to retrieve all suppression lists for the authenticated user. Use when you need to view or manage suppression lists. Returns all lists or a specific list when ID is provided.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | No | The identifier of a specific suppression list to retrieve. If not provided, all suppression lists will be returned. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | 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 Account

**Slug:** `POSTALYTICS_UPDATE_ACCOUNT`

Tool to update an existing account in the Postalytics system. Use when you need to modify account information such as contact details, address, or credentials for an existing account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `phone` | string | No | The phone number associated with the account |
| `company` | string | No | The company name associated with the account |
| `password` | string | Yes | The password associated with the account. Must follow password guidelines - minimum 8 characters including 1 uppercase letter, 1 lowercase letter, 1 number, and 1 special character |
| `username` | string | Yes | The username associated with the account - must be unique |
| `last_name` | string | Yes | The last name of the account holder |
| `account_id` | integer | Yes | The unique identifier of the account to update |
| `first_name` | string | Yes | The first name of the account holder |
| `address_zip` | string | No | The zip code associated with the account's address |
| `address_city` | string | No | The city associated with the account's address |
| `address_state` | string | No | The state associated with the account's address |
| `email_address` | string | No | The email address associated with the account |
| `address_street` | string | No | The street address associated with the 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 |

### Update Suppression List Contact

**Slug:** `POSTALYTICS_UPDATE_SUPPRESSION_LIST_CONTACT`

Tool to update a suppression contact on the specified suppression list. Use when you need to modify contact information for a specific contact on a suppression list.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `Zip` | string | No | Postal/ZIP code |
| `City` | string | No | City name |
| `Email` | string | No | Email address |
| `Phone` | string | No | Phone number |
| `State` | string | No | State/Province |
| `Mobile` | string | No | Mobile phone number |
| `Address` | string | No | Street address |
| `Company` | string | No | Company name |
| `Country` | string | No | Country |
| `Website` | string | No | Website URL |
| `list_id` | integer | Yes | The id of the suppression list the contact is on |
| `Address2` | string | No | Additional address line |
| `LastName` | string | No | Last name |
| `FirstName` | string | No | First name |
| `VarField1` | string | No | Custom variable field 1 |
| `VarField2` | string | No | Custom variable field 2 |
| `VarField3` | string | No | Custom variable field 3 |
| `VarField4` | string | No | Custom variable field 4 |
| `VarField5` | string | No | Custom variable field 5 |
| `VarField6` | string | No | Custom variable field 6 |
| `VarField7` | string | No | Custom variable field 7 |
| `VarField8` | string | No | Custom variable field 8 |
| `VarField9` | string | No | Custom variable field 9 |
| `Occupation` | string | No | Occupation |
| `VarField10` | string | No | Custom variable field 10 |
| `VarField11` | string | No | Custom variable field 11 |
| `VarField12` | string | No | Custom variable field 12 |
| `VarField13` | string | No | Custom variable field 13 |
| `VarField14` | string | No | Custom variable field 14 |
| `VarField15` | string | No | Custom variable field 15 |
| `VarField16` | string | No | Custom variable field 16 |
| `VarField17` | string | No | Custom variable field 17 |
| `VarField18` | string | No | Custom variable field 18 |
| `VarField19` | string | No | Custom variable field 19 |
| `VarField20` | string | No | Custom variable field 20 |
| `VarField21` | string | No | Custom variable field 21 |
| `VarField22` | string | No | Custom variable field 22 |
| `VarField23` | string | No | Custom variable field 23 |
| `VarField24` | string | No | Custom variable field 24 |
| `VarField25` | string | No | Custom variable field 25 |
| `VarField26` | string | No | Custom variable field 26 |
| `VarField27` | string | No | Custom variable field 27 |
| `VarField28` | string | No | Custom variable field 28 |
| `VarField29` | string | No | Custom variable field 29 |
| `VarField30` | string | No | Custom variable field 30 |
| `VarField31` | string | No | Custom variable field 31 |
| `VarField32` | string | No | Custom variable field 32 |
| `VarField33` | string | No | Custom variable field 33 |
| `VarField34` | string | No | Custom variable field 34 |
| `VarField35` | string | No | Custom variable field 35 |
| `contact_id` | integer | Yes | The id of the contact 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 |
