-
API
For API support, please contact:
support@ONTRAPORT.com
PRODUCTS API
The Products API allows for adding and updating products and purchase logs within your account.
Authentication Requests Overview Request Types- Sale - log a sale
- Refund - mark an existing sale as refunded
- Delete - delete a sale
- Add - add a new product
- Update - update an existing product
- Fetch - fetch a list of products in the account
- Key - request a template of a product
- Search - search for a product
- Search Purchase - search for a purchase
- Purchase History - request purchase history for a contact
FORMS API
The forms API currently returns the hybrid (HTML/JavaScript) version of a smart form. If no smartform ID is passed in the request, a list of all smartforms with their corresponding form IDs will be returned.
Authentication Requests Overview Request Types- Fetch - Pull hybrid code for a smart form
CONTACTS API
The contacts API allows for adding, deleting and modifying contacts within the Ontraport account. In order to use the Contacts API, you must submit a standard HTTP (Hypertext Transfer Protocol) POST request to the Ontraport contacts API server.
Authentication Requests Overview Request Types- Add - Add a contact
- Update - Update a contact
- Fetch - Pull contact record for a specific contact
- Delete - Delete a contact
- Key - View a template of a contact record
- Add Section - Add a new field section
- Edit Section - Edit an existing field section
- Remove Section - Remove a field section
- Remove Field - Remove a single field
- Add Dropdown - Add a dropdown field
- Remove Dropdown - Remove a dropdown field
- Search - Search for contacts matching a given criteria
- Pull Tag - Pull a list of tags with corresponding IDs
- Fetch Tag - Pull a list of tags
- Fetch Sequences - Pulls a list of sequences with corresponding IDs
- Add Notes - Add notes to a contact(s)
- Add Tag - Add a tag(s) to a contact(s)
- Remove Tag - Remove a tag(s) from a contact(s)
- Get Deleted Contacts - Pull list of deleted contacts within a given timeframe
PAYMENTS API
The Payments API allows for charging payments via your ONTRAPORT account and a connected gateway. In order to use the Payments API, you must submit a standard HTTP (Hypertext Transfer Protocol) POST request to the ONTRAPORT Payments API server.
Authentication Requests Overview Request Types Frequently Asked Questions- Sale - Charge a transaction
- List Gateways - List gateways in account
- List Invoices - List invoice templates in account
Partners










