PostUp’s REST API allows you to integrate external systems with the platform for subscriber management, subscription updates, messaging workflows, and reporting.

Visit our https://apidocs.postup.com to see our full API documentation.  

Depending on your use case, the API can be used to:

• create and update subscriber profiles

• manage newsletter subscriptions and preferences

• synchronize data between PostUp and external systems

• trigger messages based on application or user activity

• send campaigns to audiences stored in PostUp

• retrieve engagement data for reporting and analytics

The sections below outline common REST API use cases.

Subscriber and Profile Management

Use the REST API to create subscribers, update profile fields, and maintain customer data in PostUp from external systems.

Common examples include:

• syncing subscribers from a CRM

• updating profile attributes from a website or application

• maintaining customer records from a registration system

Subscription and Preference Management

Use the REST API to manage newsletter subscriptions and subscriber preferences in real time.

Common examples include:

• newsletter signup forms

• preference centers

• account management pages

• unsubscribe and resubscribe workflows

Batch Data Synchronization

Use the REST API to send periodic batches of subscriber or behavioral data into PostUp when real-time updates are not required.

Common examples include:

• nightly profile refreshes

• periodic purchase history updates

• scheduled engagement data synchronization

This approach is commonly used when large volumes of data need to be synchronized between systems.

Triggered Messaging

Use the REST API to trigger messages from external systems based on user activity or business events.

Common examples include:

• welcome emails

• password reset messages

• order confirmations

• account alerts

Messaging External Audiences

Use the REST API when an audience is identified outside of PostUp and needs to be messaged based on external system logic.

Common examples include:

• blog follower notifications

• application activity notifications

• event-based communications generated by external systems

In this workflow, the audience is passed to PostUp at send time rather than being stored as a list.

Campaign and Mailing Workflows

Use the REST API to create or send campaigns to audiences that already exist in PostUp.

Common examples include:

• scheduled newsletters

• promotional mailings

• API-driven campaign workflows

Reporting and Data Retrieval

Use the REST API to retrieve engagement and campaign data for reporting, analytics, or synchronization with other systems.

Common examples include:

• exporting engagement data to a BI platform

• retrieving subscriber activity

• synchronizing campaign results to another database