At a high level, the Push API provides a programmatic mechanism for pushing data from one or more sources to be integrated into one of the three Higher Logic platforms:

• Higher Logic Thrive Marketing Professional
• Higher Logic Thrive Community

For Higher Logic Community Essentials, not all objects in the API are supported. Community Essentials does not require or support pushing:

• Meetings, Products, or Orders
• Lists
• Communities and Groups
• Custom Demographics
• Contact Job History or Education

Form an API call

All calls to the Push API are an HTTP POST that will only allow a Content-Type of application/json or text/json in the request body. Additionally, you will need an API Key, which should be generated by Higher Logic when the push API is initially configured for a tenant for use.

With the exception of the /list endpoint, each object in the array should contain the full data of the record. For example, by not adding contact groups, a contact should remain in for /contactinfo, with the expectation being that they will be removed from the groups that weren't included in the last request. That also goes for fields (i.e., OrganizationName wasn't included on the latest API call, thus removing it from that contact record). With the /list endpoint, you can mimic this behavior using the "Replace" mode every time. The "Add" and "Remove" modes allow for partial data to be sent as long as the required fields are correctly filled out (e.g., "adding" a few contacts to a list does not require the entire list of ContactIds for that list).

Endpoints

• Base URL: https://datapushapi.higherlogic.com/v2
• Base URL (customers in Canada): https://datapushapi.onlinecommunity.ca/v2
• Example API endpoint URL: https://datapushapi.higherlogic.com/v2/contactinfo

NOTE: In the tables in this article, required fields are indicated in bold text.

Notes

IsDeleted

Reference objects (ContactDetails, Meeting, and Product) each have an IsDeleted property. When you request that one of these objects be deleted, the only required field is the corresponding unique ID (ContactId, MeetingId, and ProductId).

DateTime data type

When using the DateTime data type, the value must be in either of these ISO 8601 formats:

• UTC - .NET Format "yyyy-MM-ddTHH:mm:ss.fffZ"
• Time Offset from UTC - .NET Format "yyyy-MM-ddTHH:mm:ss.fffzzz"

ContactInfo

This endpoint defines all information related to a contact. The following tables display the fields that are available for each object in a ContactInfo push.

ContactDetails

ContactGroup

This object defines information relevant to a contact's relationship to a Community Group or Security Group.

• For Community Essentials, all groups will be configured as Security Groups. Community Groups are not pushed as part of Community Essentials.

ContactAddress

This object defines a single address entry for a contact.

ContactPhone

This object defines a single phone number entry for a contact.

POST /list

Request headers

• Key = ApiKey
• Value = API Key for the tenant.

Request body

[
  {
      "ContactIds": ["aafdd36c-b35c-ee5c-5892-9098a09f2a81"],
      "ListId": "LIST1",
      "ListName": "Test List 1",
      "ListType": "Awesome List",
      "Mode": "Append"
  },
  {
      "ContactIds": ["aafdd36c-b35c-ee5c-5892-9098a09f2a81","74cec42c-5e4d-e3bd-91ec-917d40a4c9dc"],
      "ListId": "LIST2",
      "ListName": "Test List 2",
      "Mode": "Replace"
  }
]

Error codes