Postalytics

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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

Untrusted display-only summary

Tool to retrieve all webhooks configured for the authenticated account. Use when you need to view webhook configurations for campaigns.

Untrusted display-only summary

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

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary