Common API calls

A practical reference to the API calls used most often when integrating with UbiQuity.

Overview

This page covers the most commonly used API calls for integrating external systems with UbiQuity. Whether you're syncing contact data, recording transactions, or triggering communications, these endpoints cover the majority of real-world integration needs.

For the full list of available endpoints, see the API reference.

---

Contact management

Managing contacts is typically the starting point for any integration. Use these endpoints to look up, create, update, and remove contacts in your UbiQuity database.

Look up a contact Retrieve an existing contact using a unique identifier such as an email address or contact ID. Useful for checking whether a contact already exists before making changes. 👉 API reference — look up contact

Add a contact Create a new contact in your database. Use this when capturing leads, sign-ups, or new customer records from an external system. 👉 API reference — add contact

Edit a contact Update an existing contact's details, such as their name, email address, tags, or custom fields, without creating a duplicate record. 👉 API reference — edit contact

Delete a contact Remove a contact from your database. Useful for routine data cleanups or fulfilling data deletion requests. 👉 API reference — delete contact

---

Transaction management

Use these endpoints to record and manage transactional activity against your contacts, such as purchases, donations, bookings, or memberships.

Look up a transaction Search for existing transactions using filters such as date, contact ID, or transaction type. Useful for reporting, auditing, or triggering follow-up activity. 👉 API reference — look up transaction

Add a transaction Record a new transaction against a contact. This can represent any type of activity — a purchase, a new membership, a booking, and so on. 👉 API reference — add transaction

Edit a transaction Update an existing transaction record, such as correcting an amount or reclassifying the activity type. 👉 API reference — edit transaction

Delete a transaction Remove a transaction record. Use this to correct errors, remove test data, or fulfil data removal requests. 👉 API reference — delete transaction

---

Send communications

Once contact or transaction data has been added or updated, you can use the API to trigger communications. This could be a confirmation email, a booking summary, a voucher, or the start of an automated journey.

Submit a form Submit data into a predefined UbiQuity form to trigger an email to a contact. The email can include data merged from UbiQuity, such as purchase details, booking information, or a redemption voucher. You can also use this to notify internal teams for follow-up. 👉 API reference — submit form

Run an automated mailout Trigger a predefined automated mailout via API rather than on its usual schedule. Useful when you need to send at a specific time based on activity in an external system. 👉 API reference — run automated mailout

---

If you need guidance on which approach is right for your integration, contact your UbiQuity consultant or reach out to the support team.