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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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