Loading...
Cross shared collection | Cenit Admin

Basic info

Title
ONTRAPORT API 1.2.1
Image
Thumb ontraport api 1 2 1 logo
Name
ontraport_api_1_2_1
Summary

Enter your App ID and API Key above. If you do not have an App ID or API Key login to your ONTRAPORT account and navigate here. Authentication parameters must be sent in the request header as Api-Appid and Api-Key. Each ONTRAPORT account is allowed up to 180 requests per minute.

Readme

These collection have been automatically generated from a swagger specification

API specs supplied by Image title

Authors
Name
Cenit Team
1 Cross collection authors
Pull count
0
Id
57b1ee93ad9815587a0004e2
Created at
August 15, 2016 16:32
Updated at
October 27, 2016 16:51

Compute

Snippets
NamespaceNameTypeDescriptionUpdated at
ONTRAPORT API 1.2.1Address.jsonAuto detect - -
ONTRAPORT API 1.2.1Criteria.jsonAuto detect - -
ONTRAPORT API 1.2.1Notification.jsonAuto detect - -
ONTRAPORT API 1.2.1Offer.jsonAuto detect - -
ONTRAPORT API 1.2.1Order.jsonAuto detect - -
ONTRAPORT API 1.2.1Payer.jsonAuto detect - -
ONTRAPORT API 1.2.1Price.jsonAuto detect - -
ONTRAPORT API 1.2.1Product.jsonAuto detect - -
ONTRAPORT API 1.2.1Response.jsonAuto detect - -
ONTRAPORT API 1.2.1Shipping.jsonAuto detect - -
ONTRAPORT API 1.2.1TaskCompleteParams.jsonAuto detect - -
ONTRAPORT API 1.2.1TaskData.jsonAuto detect - -
ONTRAPORT API 1.2.1TaskFollowup.jsonAuto detect - -
ONTRAPORT API 1.2.1Tax.jsonAuto detect - -
ONTRAPORT API 1.2.1Transaction.jsonAuto detect - -
ONTRAPORT API 1.2.1Update.jsonAuto detect - -
ONTRAPORT API 1.2.1addListParamFormData.jsonAuto detect - -
ONTRAPORT API 1.2.1bmasksParam.jsonAuto detect - -
ONTRAPORT API 1.2.1bmasksParamFormData.jsonAuto detect - -
ONTRAPORT API 1.2.1conditionParam.jsonAuto detect - -
ONTRAPORT API 1.2.1conditionParamFormData.jsonAuto detect - -
ONTRAPORT API 1.2.1date_rangeParam.jsonAuto detect - -
ONTRAPORT API 1.2.1date_rangeParamFormData.jsonAuto detect - -
ONTRAPORT API 1.2.1dupeParam.jsonAuto detect - -
ONTRAPORT API 1.2.1dupeParamFormData.jsonAuto detect - -
ONTRAPORT API 1.2.1externsParam.jsonAuto detect - -
ONTRAPORT API 1.2.1externsParamFormData.jsonAuto detect - -
ONTRAPORT API 1.2.1group_idsParam.jsonAuto detect - -
ONTRAPORT API 1.2.1group_idsParamFormData.jsonAuto detect - -
ONTRAPORT API 1.2.1idParam.jsonAuto detect - -
ONTRAPORT API 1.2.1idParamFormData.jsonAuto detect - -
ONTRAPORT API 1.2.1idsParam.jsonAuto detect - -
ONTRAPORT API 1.2.1idsParamFormData.jsonAuto detect - -
ONTRAPORT API 1.2.1listFieldsParam.jsonAuto detect - -
ONTRAPORT API 1.2.1listFieldsParamFormData.jsonAuto detect - -
58 Snippets (showing 35)

Connectors

Connections
NamespaceNameUrlKeyTokenAuthorizationUpdated at
ONTRAPORT API 1.2.1Connectionhttps://api.ontraport.com/1 -
1 Connections
Webhooks
NamespaceNamePathMethodDescriptionAuthorizationUpdated at
ONTRAPORT API 1.2.1GET Form/formgetThis will fetch a Form's HTML for a given ID.
Note: HTML is returned in the data member of the JSON response. As a result, the HTML is escaped and you will have to unescape the HTML before using it.
-
ONTRAPORT API 1.2.1GET Landingpage Gethostedurl/landingPage/getHostedURLgetThis will grab the permanent URL for a given Landing Page. -
ONTRAPORT API 1.2.1GET Message/messagegetThis will fetch data from an existing Message. -
ONTRAPORT API 1.2.1POST Message/messagepost - -
ONTRAPORT API 1.2.1PUT Message/messageput - -
ONTRAPORT API 1.2.1DELETE Object/objectdeleteThis will delete an Object with the given Object type and ID. -
ONTRAPORT API 1.2.1GET Object/objectgetThis will fetch data for a given Object type and ID. -
ONTRAPORT API 1.2.1DELETE Objects/objectsdelete - -
ONTRAPORT API 1.2.1GET Objects/objectsget - -
ONTRAPORT API 1.2.1POST Objects/objectspostThis will create an Object with the given data. Object type is a required parameters, but other parameters are optional and dependent upon the object type. We have provided optional parameters as examples for updating a Contact. When using this in your application, all invalid parameters will be ignored. -
ONTRAPORT API 1.2.1PUT Objects/objectsputThis will update an Object's data. The Object type and ID and required parameters, but other parameters are dependent upon the object type. We have provided optional parameters as examples for updating a Contact. When using this in your application, all invalid parameters will be ignored. -
ONTRAPORT API 1.2.1GET Objects Getinfo/objects/getInfogetGet information about an Objects Collection, such as the number of Objects that match the given criteria. -
ONTRAPORT API 1.2.1GET Objects Meta/objects/metagetThis will get a list of existing Object types and their corresponding field names. Use the objectID parameter to This will get a single Object type. -
ONTRAPORT API 1.2.1POST Objects Saveorupdate/objects/saveorupdatepostThis will create an Object with the given data or will merge with an Object in the database if the unique field matches another Object’s. Object type is a required parameter, but other parameters are optional and depend on the Object type. We have provided optional parameters as examples for updating a Contact. When using this in your application, all invalid parameters will be ignored. -
ONTRAPORT API 1.2.1DELETE Objects Tag/objects/tagdeleteThis will remove a Tag from an Object using a Tag ID. When adding or removing Tags, either ids or group_ids must be given. -
ONTRAPORT API 1.2.1PUT Objects Tag/objects/tagputThis will add a Tag to an Object. when adding or removing Tags, either ids or group_ids must be given. -
ONTRAPORT API 1.2.1POST Task Cancel/task/cancelpostTo affect a single Task or list of specific Tasks, use the ids array in the criteria parameter. Otherwise, you should use performAll and other criteria to select a Group of Tasks to cancel. -
ONTRAPORT API 1.2.1POST Task Complete/task/completepostThis will mark one or many Tasks as complete. As an option, you can assign a new Task for further follow-up. To affect a single Task or list of specific Tasks, use the ids array in the criteria parameter. Otherwise, you should use performAll and other criteria to select a Group of Tasks to complete. -
ONTRAPORT API 1.2.1PUT Transaction Converttocollections/transaction/convertToCollectionsput - -
ONTRAPORT API 1.2.1PUT Transaction Converttodecline/transaction/convertToDeclineput - -
ONTRAPORT API 1.2.1PUT Transaction Markpaid/transaction/markPaidput - -
ONTRAPORT API 1.2.1GET Transaction Order/transaction/orderget - -
ONTRAPORT API 1.2.1PUT Transaction Order/transaction/orderputUpdate information about an Order. Please note that if offer data is omitted, this Order will be deleted. -
ONTRAPORT API 1.2.1POST Transaction Processmanual/transaction/processManualpostThis will create a Transaction for a Contact. Please note that this request requires valid parameters for all associated members of the Transaction or the request will fail. If you have doubled-checked all parameters and the request is still failing, check that the payload JSON format is correct by using JSONLint. If credit card and billing information already exist for this contact, you may omit billing_address and payer from the request. Note that trans_date is given in milliseconds elapsed since midnight on 1/1/1970. -
ONTRAPORT API 1.2.1PUT Transaction Refund/transaction/refundput - -
ONTRAPORT API 1.2.1POST Transaction Rerun/transaction/rerunpostRe-run a single Transaction or a Group of Transactions that are currently in Collections. -
ONTRAPORT API 1.2.1PUT Transaction Reruncommission/transaction/rerunCommissionput - -
ONTRAPORT API 1.2.1POST Transaction Resendinvoice/transaction/resendInvoicepost - -
ONTRAPORT API 1.2.1PUT Transaction Void/transaction/voidput - -
ONTRAPORT API 1.2.1PUT Transaction Voidpurchase/transaction/voidPurchaseput - -
ONTRAPORT API 1.2.1PUT Transaction Writeoff/transaction/writeOffput - -
31 Webhooks
Connection Roles
NamespaceNameWebhooksConnectionsUpdated at
ONTRAPORT API 1.2.1HTTPS Connections -
1 Connection Roles

Data

Data Types
NamespaceNameSlugTypeStorage sizeUpdated at
ONTRAPORT API 1.2.1AddressaddressJson Data Type0 Bytes -
ONTRAPORT API 1.2.1CriteriacriteriaJson Data Type0 Bytes -
ONTRAPORT API 1.2.1NotificationnotificationJson Data Type0 Bytes -
ONTRAPORT API 1.2.1OfferofferJson Data Type0 Bytes -
ONTRAPORT API 1.2.1OrderorderJson Data Type0 Bytes -
ONTRAPORT API 1.2.1PayerpayerJson Data Type0 Bytes -
ONTRAPORT API 1.2.1PricepriceJson Data Type0 Bytes -
ONTRAPORT API 1.2.1ProductproductJson Data Type0 Bytes -
ONTRAPORT API 1.2.1ResponseresponseJson Data Type0 Bytes -
ONTRAPORT API 1.2.1ShippingshippingJson Data Type0 Bytes -
ONTRAPORT API 1.2.1TaskCompleteParamstask_complete_paramsJson Data Type0 Bytes -
ONTRAPORT API 1.2.1TaskDatataskdataJson Data Type0 Bytes -
ONTRAPORT API 1.2.1TaskFollowuptask_followupJson Data Type0 Bytes -
ONTRAPORT API 1.2.1TaxtaxJson Data Type0 Bytes -
ONTRAPORT API 1.2.1TransactiontransactionJson Data Type0 Bytes -
ONTRAPORT API 1.2.1UpdateupdateJson Data Type0 Bytes -
ONTRAPORT API 1.2.1addListParamFormDataparam_add_list_param_form_dataJson Data Type0 Bytes -
ONTRAPORT API 1.2.1bmasksParamparam_bmasks_paramJson Data Type0 Bytes -
ONTRAPORT API 1.2.1bmasksParamFormDataparam_bmasks_param_form_dataJson Data Type0 Bytes -
ONTRAPORT API 1.2.1conditionParamparam_condition_paramJson Data Type0 Bytes -
ONTRAPORT API 1.2.1conditionParamFormDataparam_condition_param_form_dataJson Data Type0 Bytes -
ONTRAPORT API 1.2.1date_rangeParamparam_date_rangeparamJson Data Type0 Bytes -
ONTRAPORT API 1.2.1date_rangeParamFormDataparam_date_range_param_form_dataJson Data Type0 Bytes -
ONTRAPORT API 1.2.1dupeParamparam_dupeparamJson Data Type0 Bytes -
ONTRAPORT API 1.2.1dupeParamFormDataparam_dupe_param_form_dataJson Data Type0 Bytes -
ONTRAPORT API 1.2.1externsParamparam_externs_paramJson Data Type0 Bytes -
ONTRAPORT API 1.2.1externsParamFormDataparam_externs_param_form_dataJson Data Type0 Bytes -
ONTRAPORT API 1.2.1group_idsParamparam_group_idsparamJson Data Type0 Bytes -
ONTRAPORT API 1.2.1group_idsParamFormDataparam_group_ids_param_form_dataJson Data Type0 Bytes -
ONTRAPORT API 1.2.1idParamparam_idparamJson Data Type0 Bytes -
ONTRAPORT API 1.2.1idParamFormDataparam_id_param_form_dataJson Data Type0 Bytes -
ONTRAPORT API 1.2.1idsParamparam_idsparamJson Data Type0 Bytes -
ONTRAPORT API 1.2.1idsParamFormDataparam_ids_param_form_dataJson Data Type0 Bytes -
ONTRAPORT API 1.2.1listFieldsParamparam_list_fields_paramJson Data Type0 Bytes -
ONTRAPORT API 1.2.1listFieldsParamFormDataparam_list_fields_param_form_dataJson Data Type0 Bytes -
58 Data Types (showing 35)

Config

Namespaces
NameSlugUpdated at
ONTRAPORT API 1.2.1ontraport_api_1_2_1 -
1 Namespaces

Metadata