This documentation will explain how to interact with the TopicaPlus API. All calls use this basic structure:

  {
     "topicaAction" : {
        "account" : "your_user",
        "password" : "your_pass",
        "API_CALL_NAME" : [
           {
              API JSON CALL BODY
           }
        ]
     }
  }

Below you will find details of each API call and the JSON fields needed to make the call. All calls should be a POST to the URL:

http://app.topicaplus.com/api/Dispatcher/

System Health

Echo Test

This API call allows you to check and see if the server is up.

Field Value
serverPing empty

List Management

listCreate

This API call allows you to create a new mailing list

Field Value
account Your Username
password Your Password
display 0
list Desired name of your mailing list

listRemove

This API call allows you to create a mailing list

Field Value
account Your Username
password Your Password
list Mailing list that you would like to delete

listDetail

This API call allows you to create a mailing list

Field Value
account Your Username
password Your Password
list Mailing list that you would like to get details of

Subscriber Management

subscriberAdd

This API call allows you to add a new subscriber, email address only

Field Value
account Your Username
password Your Password
display 0
list Mailing list you would like to add this these subcribers to
content Email addresses that you would like to add seperated by commas

subscriberRemove

This API call allows you to create a mailing list

Field Value
account Your Username
password Your Password
list Mailing list that you would like to remove the subscribers from
addresses Email addresses that you would like to remove

subscriberBlock

This API call allows you to create a mailing list

Field Value
account Your Username
password Your Password
list Mailing list that you would like to get details of
addresses Email addresses that you would like to block

subscriberStatus

This API call allows you to check the status of a subscriber.

Field Value
account Your Username
password Your Password
addresses Email addresses that you would like to check the statuses of

subscriberCount

This API call allows you to check the total number of subscribers you have.

Field Value
account Your Username
password Your Password

subscriberImport

This API call allows you to bulk import subscribers with demographic details.

Field Value
account Your Username
password Your Password
column-delimiter ,
value-delimeter ;
first-row header or data
send-confirmations true or false
mapping Import file column mapping to user fields.
data Submission data.

Example



Response

subscriberExport

This API call allows you to bulk export data.

Field Value
account Your Username
password Your Password
list The Mailing you want to export subscribers from.