The most useful API calls you’ll actually use!

Our API offers a lot of flexibility and power - but with a long list of available endpoints, it can be hard to know where to begin. If you’ve ever opened up the full documentation and felt a little overwhelmed, you’re not alone.

To help you get started faster, we’ve pulled together a short list of the most commonly used API calls. These endpoints cover the majority of real-world use cases and are perfect for integrating data from your own systems into UbiQuity.

Contact Management

Managing contacts is often the first step in any integration. Whether you're syncing data from a CRM, capturing leads, or updating customer records, these endpoints are your go-to tools:

Look Up Contact

Retrieve an existing contact using a unique identifier - like an email address or contact ID. This is often used to check whether someone already exists before updating or adding new data.

👉 See API reference to look up contact

Add Contact

Add a new contact to your database. Perfect for capturing leads, sign-ups, or new users from your external systems.

👉 See API reference to add contact

Edit Contact

Update an existing contact’s details (e.g. name, email, tags, or custom fields) without creating duplicates.

👉 See API reference to edit contact

Delete Contact

Remove a contact from your database. Useful for managing cleanups, or fulfilling data deletion requests.

👉 See API reference to delete contact

Transaction Management

If you're tracking purchases, donations, sign-ups, or other forms of engagement, these transaction endpoints let you record and retrieve that information with ease:

Look Up Transaction

Search for past transactions using filters like date, contact ID, or transaction type. Useful for reporting, auditing, or triggering follow-ups based on activity.

👉 See API reference to look up transaction

Add Transaction

Record a new transaction against a contact. This could represent anything from a purchase to new membership.

👉 See API reference to add transaction

Edit Transaction

Make updates to an existing transaction - such as correcting the amount or reclassifying the activity.

👉 See API reference to edit transaction

Delete Transaction

Remove a transaction record. Handy for correcting errors, cleaning up test data, or honoring user data removal requests.

👉 See API reference to delete transaction

Send communications

Once you’ve added or updated the data in UbiQuity, you can then trigger communications to your contact(s). This could be a purchase or booking summary, a request for callback or even the start of a welcome and onboarding journey.

Submit Form

Submit data into a predefined form that can then trigger an email to a customer. This can also merge in data that has was updated in UbiQuity, including purchase date, product, price, booking details, or even a redemption voucher. You can also trigger an email to your internal teams for action.

👉 See API reference to submit form

Run an automated mailout

Send a predefined mailout to contacts that meet specific criteria. These can normally run on a schedule but can also be activated via  API if you want to send at different times during the day.

👉 See API reference to run an automated mailout

Why These?

 These calls follow the 80/20 rule: a small set of endpoints that power the majority of real-world integrations. Whether you're syncing customer data, tracking activity, or triggering follow-up emails, this core group will take you a long way.

 When you're ready to go deeper, our full API documentation has all the advanced features and edge cases. 

But if you're just getting started, this is where the real value lies.

For further information reach out to your UbiQuity Marketing Automation Consultant.