Pinpointe makes it easy for you to integrate your applications with our email marketing engine. Because we use both JSON and XML formats to communicate messages between systems, you can use any programming language for your integration. 

Our API includes robust functionality for managing contacts and their associated lists. You have access to each contact record, which can include custom fields, in addition to the ones already provided by Pinpointe's database schema. This allows you to use Pinpointe to store complete user profiles. These profiles, in turn, can be used to determine the type, content and frequency of emails those users receive. The API also includes the ability to send campaigns and check their performance statistics.

Because it is cloud-based, the Pinpointe API makes it possible to programmatically update and use your system without needing to physically access it. Developers commonly use the Pinpointe API to automatically update contact lists, create and send email campaigns, gather statistics --- and perform those operations from within their own applications.

Requirements 

In order to access the API, you will need the API function enabled for your account, and an API token.

Note: You can access your API user information (Token/path/etc.), under: Account Settings => API + Connectors
If the API is not yet enabled, please contact support to have it enabled.

Submitting a Request 

An XML POST request with the appropriate key should be sent to the ‘XML Path’ you will receive when your API is enabled. The XML Path will be the same URL path you use to login, appended with '/apixml.php'. 

For shared-instance professional accounts, the correct URL with endpoint will look similar to the following: 

https://na0x.mypinpointe.com/apixml.php

For JSON POST requests, you will use this URL path:

https://na0x.mypinpointe.com/apijson.php

Please note that Enterprise customers will use their custom URLs instead of "na0x.mypinpointe.com".

In addition, the current GUI shows a tab in account settings labeled "XML API" and shows a path of:

                                https://[your_respective_login_URL]/xml.php

This is a legacy URL with endpoint that will continue to be supported so as not to require legacy users the need to rewrite their existing call scripts. At some future point the application GUI will be modified to show two new tabs for XML and JSON URLs.

Sample API syntax is provided for each of the API calls. The ‘username’ and ‘usertoken’ mentioned will be provided once your API is enabled for your account. There are two levels of API calls. The Enterprise API requires administrative access. The standard API only requires user-level permissions.

Note: You can access your API user information (Token/path/etc.), under: Account Settings => API + Connectors
If the API is not yet enabled, please contact support to have it enabled.

For more information, refer to the appropriate API documentation.