Skip to main content
Postalytics logo
  • Category: marketing automation
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 24
  • Triggers: 0
  • Slug: POSTALYTICS
  • Version: 20261101_00

Tools

Slug: POSTALYTICS_ADD_ACCOUNTCreate a new Postalytics sub-account associated with the requester as parent. The response may include the account ID, API key, and creation date.

Input Parameters

string
The phone number associated with the account
string
The company name associated with the account
string
required
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
string
required
The username associated with the account - must be unique
string
required
The last name of the account holder
string
required
The first name of the account holder
string
The zip code associated with the account’s address
string
The city associated with the account’s address
string
The state associated with the account’s address
string
The email address associated with the account
string
The street address associated with the account

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTALYTICS_ADD_CONTACTTool 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

string
Phone number of the contact.
string
Company name of the contact.
string
Website URL of the contact.
string
Last name of the contact.
integer
The unique id of the contact. Required for updating but not required for inserting.
string
First name of the contact.
string
Occupation of the contact.
string
Zip/postal code for the contact address.
string
Custom variable field 1 for additional data.
string
Custom variable field 2 for additional data.
string
Custom variable field 3 for additional data.
string
Custom variable field 4 for additional data.
string
Custom variable field 5 for additional data.
string
Custom variable field 6 for additional data.
string
Custom variable field 7 for additional data.
string
Custom variable field 8 for additional data.
string
Custom variable field 9 for additional data.
string
City for the contact address.
string
The date and time when the contact was created (ISO 8601 format).
string
Mobile phone number of the contact.
string
Custom variable field 10 for additional data.
string
Custom variable field 11 for additional data.
string
Custom variable field 12 for additional data.
string
Custom variable field 13 for additional data.
string
Custom variable field 14 for additional data.
string
Custom variable field 15 for additional data.
string
Custom variable field 16 for additional data.
string
Custom variable field 17 for additional data.
string
Custom variable field 18 for additional data.
string
Custom variable field 19 for additional data.
string
Custom variable field 20 for additional data.
string
Custom variable field 21 for additional data.
string
Custom variable field 22 for additional data.
string
Custom variable field 23 for additional data.
string
Custom variable field 24 for additional data.
string
Custom variable field 25 for additional data.
string
Custom variable field 26 for additional data.
string
Custom variable field 27 for additional data.
string
Custom variable field 28 for additional data.
string
Custom variable field 29 for additional data.
string
Custom variable field 30 for additional data.
string
Custom variable field 31 for additional data.
string
Custom variable field 32 for additional data.
string
Custom variable field 33 for additional data.
string
Custom variable field 34 for additional data.
string
Custom variable field 35 for additional data.
string
State for the contact address.
string
Email address of the contact.
string
Street address for the contact.
string
Second line of street address for the contact.
integer
required
The id of the contact list to add this contact to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTALYTICS_CREATE_NEW_CAMPAIGNTool 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

string
required
The sender’s postal code.
string
required
The sender’s city.
string
required
The name of the campaign sender.
integer
required
Postage type for the campaign. 0 for first class, 1 for standard mail.
string
required
The sender’s state abbreviation (e.g., NY, CA).
integer
required
Identifies media type. Valid values are 21-34, including postcards, letters, and bifolds in first class or standard mail.
string
The sender’s country code. Defaults to ‘US’ if not specified.
string
required
The name of the direct mail campaign.
string
required
The sender’s primary street address.
string
The sender’s secondary address line (e.g., apartment, suite number).
integer
required
The ID of the template to use for the front of this campaign. Template must be created and proofed before campaign creation.
integer
Custom envelope ID for letter campaigns. Optional parameter only applicable to letter-type campaigns.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTALYTICS_CREATE_SUPPRESSION_LISTTool 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

string
The name of the suppression list.
string
The country associated with the suppression list (e.g., ‘US’, ‘CA’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTALYTICS_CREATE_SUPPRESSION_LIST_CONTACTTool 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

string
Zip/postal code.
string
City.
string
Email address of the contact.
string
Phone number.
string
State.
string
Mobile phone number.
string
Primary address line.
string
Company name.
string
Country.
string
Website URL.
integer
required
The id of the suppression list to add the contact to.
string
Secondary address line.
string
Last name of the contact.
string
First name of the contact.
string
Custom variable field 1.
string
Custom variable field 2.
string
Custom variable field 3.
string
Custom variable field 4.
string
Custom variable field 5.
string
Custom variable field 6.
string
Custom variable field 7.
string
Custom variable field 8.
string
Custom variable field 9.
string
Occupation.
string
Custom variable field 10.
string
Custom variable field 11.
string
Custom variable field 12.
string
Custom variable field 13.
string
Custom variable field 14.
string
Custom variable field 15.
string
Custom variable field 16.
string
Custom variable field 17.
string
Custom variable field 18.
string
Custom variable field 19.
string
Custom variable field 20.
string
Custom variable field 21.
string
Custom variable field 22.
string
Custom variable field 23.
string
Custom variable field 24.
string
Custom variable field 25.
string
Custom variable field 26.
string
Custom variable field 27.
string
Custom variable field 28.
string
Custom variable field 29.
string
Custom variable field 30.
string
Custom variable field 31.
string
Custom variable field 32.
string
Custom variable field 33.
string
Custom variable field 34.
string
Custom variable field 35.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTALYTICS_CREATE_TEMPLATECreate a mail template for postcards, letters, or bifolds using HTML, with optional front and back image URLs.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTALYTICS_CREATE_WEBHOOKTool 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

string
required
The destination URL that will receive webhook event notifications.
string
required
Human-readable name for the webhook to help identify it.
array
required
List of campaign event types to subscribe to. Common events include ‘sent’, ‘delivered’, ‘opened’, ‘clicked’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTALYTICS_DELETE_ACCOUNTTool 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

integer
required
The unique identifier of the account to delete. Only sub accounts and sub user accounts can be deleted. Cannot delete parent accounts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTALYTICS_DELETE_CAMPAIGNTool to delete a campaign from the system. Use when you need to remove a campaign that is no longer needed.

Input Parameters

integer
required
Integer contains the Id of the campaign to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTALYTICS_DELETE_SUPPRESSION_LISTTool to delete a specified suppression list. Use when you need to remove a suppression list that is no longer needed.

Input Parameters

integer
required
The ID of the suppression list to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTALYTICS_DELETE_SUPPRESSION_LIST_CONTACTTool 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

integer
required
The ID of the suppression list
integer
required
The ID of the contact to be deleted from the list

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTALYTICS_GET_ALL_CONTACT_LISTSTool 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTALYTICS_GET_ALL_CONTACTS_ON_A_LISTRetrieve contacts from a specified contact list with optional start offset and limit pagination. A 400 response containing “No contacts received” is returned as an empty contacts list.

Input Parameters

integer
Maximum number of contacts to return per page. Controls pagination page size.
integer
Pagination offset for retrieving contacts. Use 0 for the first page.
integer
required
The unique identifier of the contact list to retrieve contacts from.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTALYTICS_GET_ALL_DRIP_CAMPAIGNSList triggered drip campaigns for the authenticated Postalytics account, including their names and endpoint IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTALYTICS_GET_ALL_FLOWSTool to retrieve all flows for the requester’s account. Use when you need to list or browse available flows.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTALYTICS_GET_ALL_WEBHOOKSTool to retrieve all webhooks configured for the authenticated account. Use when you need to view webhook configurations for campaigns.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTALYTICS_GET_INTEGRATIONSRetrieve Connect integrations configured for the authenticated account, including CRM or data source connections. A 404 response is returned as an empty integrations list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTALYTICS_GET_MY_ACCOUNTTool 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTALYTICS_GET_SUPPRESSION_LISTTool 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

integer
required
The id of the suppression list to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTALYTICS_GET_SUPPRESSION_LIST_CONTACTTool 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

integer
Offset for pagination
integer
required
The ID of the suppression list
integer
required
The ID of the suppression list contact

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTALYTICS_GET_SUPPRESSION_LIST_CONTACTSRetrieve contacts on a specified suppression list, with an optional offset for paging.

Input Parameters

integer
required
The listId of the suppression list to get contacts for.
integer
Offset count for paging through results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTALYTICS_GET_SUPPRESSION_LISTSTool 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

integer
The identifier of a specific suppression list to retrieve. If not provided, all suppression lists will be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTALYTICS_UPDATE_ACCOUNTTool 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

string
The phone number associated with the account
string
The company name associated with the account
string
required
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
string
required
The username associated with the account - must be unique
string
required
The last name of the account holder
integer
required
The unique identifier of the account to update
string
required
The first name of the account holder
string
The zip code associated with the account’s address
string
The city associated with the account’s address
string
The state associated with the account’s address
string
The email address associated with the account
string
The street address associated with the account

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTALYTICS_UPDATE_SUPPRESSION_LIST_CONTACTTool 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

string
Postal/ZIP code
string
City name
string
Email address
string
Phone number
string
State/Province
string
Mobile phone number
string
Street address
string
Company name
string
Country
string
Website URL
integer
required
The id of the suppression list the contact is on
string
Additional address line
string
Last name
string
First name
string
Custom variable field 1
string
Custom variable field 2
string
Custom variable field 3
string
Custom variable field 4
string
Custom variable field 5
string
Custom variable field 6
string
Custom variable field 7
string
Custom variable field 8
string
Custom variable field 9
string
Occupation
string
Custom variable field 10
string
Custom variable field 11
string
Custom variable field 12
string
Custom variable field 13
string
Custom variable field 14
string
Custom variable field 15
string
Custom variable field 16
string
Custom variable field 17
string
Custom variable field 18
string
Custom variable field 19
string
Custom variable field 20
string
Custom variable field 21
string
Custom variable field 22
string
Custom variable field 23
string
Custom variable field 24
string
Custom variable field 25
string
Custom variable field 26
string
Custom variable field 27
string
Custom variable field 28
string
Custom variable field 29
string
Custom variable field 30
string
Custom variable field 31
string
Custom variable field 32
string
Custom variable field 33
string
Custom variable field 34
string
Custom variable field 35
integer
required
The id of the contact to be updated

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not