Postalytics
With the Postalytics modules in Boost.space Integrator, you can:
-
create, retrieve, and delete accounts
-
watch, create, update, list, and delete contacts
-
create, retrieve, list, and delete templates
-
watch, retrieve, list, search, and delete campaigns
-
send mailpiece
-
call APIs
To get started with Postalytics, create an account at postalytics.com.
Connect Postalytics to Boost.space Integrator
To connect to the Postalytics app, you need to obtain API Key from your account.
-
Log in to your Postalytics account.
-
Click your profile icon > Connect > API Keys.
-
Copy the API Key to your clipboard.
-
Log in to your Boost.space Integrator account and add a module from the Postalytics app into scenario.
-
In the Connection name field, enter a name for the connection.
-
In the API Key field, enter the API key copied in step 3.
-
Optional: Toggl Show Advance Settings, and select your Postalytics environment.
-
Click Save.
You have successfully connected the Postalytics app and can now build scenarios.
Accounts
You can create, retrieve, and delete accounts using the following modules.
Create an Account
Creates an account.
Connection
Establish a connection to your Postalytics account.
For field descriptions, see add account API reference.
Get an Account
Returns information about an account.
Connection
Establish a connection to your Postalytics account.
Account ID
Enter the Account ID whose details you want to retrieve.
Delete an Account
Deletes an account.
Connection
Establish a connection to your Postalytics account.
Account ID
Enter the Account ID you want to delete
Contacts
You can create, update, list, and delete contacts using the following modules.
Create a Contact
Creates a contact.
Connection
Establish a connection to your Postalytics account.
For field descriptions, see add contact API reference.
Update a Contact
Updates a contact. The module doesn’t support partial updates. If the field is not set, the value will be updated to null.
Connection
Establish a connection to your Postalytics account.
Contact List ID
Select or map the Contact List ID whose contact details you want to update.
Contact ID
Select or map the Contact ID whose details you want to update.
For field descriptions, see add contact API reference.
List Contacts
Lists contacts.
Connection
Establish a connection to your Postalytics account.
Contact List ID
Select or map the Contact List ID whose contacts you want to list.
Limit
Set the maximum number of contacts Boost.space Integrator will return during one execution cycle.
Delete a Contact
Deletes a contact.
Connection
Establish a connection to your Postalytics account.
Contact List ID
Select or map the Contact List ID whose contact you want to delete.
Contact ID
Select or map the Contact ID you want to delete.
Templates
You can create, retrieve, list, and delete templates using the following modules.
Create a Template
Creates a template.
Connection
Establish a connection to your Postalytics account.
Name
Enter the template name.
HTML
Enter the full HTML of the front and back of your creative.
Size
Select or map the size of the template. For example, the size of the postcard.
Get a Template
Returns information about a template.
Connection
Establish a connection to your Postalytics account.
Template ID
Select or map the Template ID whose details you want to retrieve.
List Templates
Lists templates.
Connection
Establish a connection to your Postalytics account.
Limit
Set the maximum number of templates Boost.space Integrator will return during one execution cycle.
Delete a Template
Deletes a template.
Connection
Establish a connection to your Postalytics account.
Template ID
Select or map the Template ID you want to delete.
Send
You can send a mailpiece using the following module.
Send a Mailpiece
Sends a mailpiece.
Connection
Establish a connection to your Postalytics account.
For field descriptions, see send API reference.
Campaigns
You can watch, retrieve, list, search, and delete campaigns, and toggle campaign mail status.
Watch Campaign Events
Triggers when a new campaign event occurs.
Make automatically creates a webhook in Postalytics once you add an instant trigger to your scenario.
Webhook Name
Enter a name for the webhook.
Connection
Establish a connection to your Postalytics account.
Campaign ID
Select or map the Campaign ID whose events you want to watch.
Get a Campaign
Returns information about a campaign.
Connection
Establish a connection to your Postalytics account.
Campaign Drop ID
Select or map the Campaign Drop ID whose details you want to retrieve.
List Campaigns
Lists campaigns.
Connection
Establish a connection to your Postalytics account.
Limit
Set the maximum number of campaigns Boost.space Integrator will return during one execution cycle.
Search Events
Searches for events.
Connection
Establish a connection to your Postalytics account.
Campaign ID
Select or map the Campaign ID whose events you want to search.
Contact ID
Select or map the Contact ID whose events you want to search.
Limit
Set the maximum number of events Boost.space Integrator will return during one execution cycle.
Delete a Campaign
Deletes a campaign.
Connection
Establish a connection to your Postalytics account.
Campaign ID
Select or map the Campaign ID you want to delete.
Toggle Campaign Mail Status
Changes mail status in a campaign from test to live and vice versa.
Connection
Establish a connection to your Postalytics account.
Campaign ID
Select or map the Campaign ID to retrieve its mail status.
Other
You can call APIs using the following module.
Make an API Call
Performs an arbitrary authorized API call.
For the list of available endpoints, refer to the Postalytics API documentation.
Connection
Establish a connection to your Postalytics account.
URL
Enter a path relative to https://api.postalytics.com/api. For example, /v1/templates.
Method
GET
to retrieve information for an entry.
POST
to create a new entry.
PUT
to update/replace an existing entry.
PATCH
to make a partial entry update.
DELETE
to delete an entry
Headers
Enter the desired request headers. You don’t have to add authorization headers; we already did that for you.
Query String
Enter the request query string.
Body
Enter the body content for your API call.
Example of use – List Templates
The following API call returns the templates from your Postalytics account.
URL: /v1/templates
Method: GET
Matches of the search can be found in the module’s Output under Bundle > Body.
Our example returned 3 templates:
Legacy article, imported from the original Boost.space knowledge base (/knowledge-base/applications/marketing/postalytics/).
