Welcome to MindFireInc REST API Documentation Web Site
This site describes all the services and methods available in our REST API. By clicking on each service link, you will see the details information about that specific service.
| Service |
Description |
| Account Service |
To manage MFI Studio accounts. This includes creating or updating an account, getting an account data or account list and much more. |
|
| Configuration Service |
To configure MFI Studio. This includes managing domains, goals, service packages, service provisions and tier pricing. All the activities under this service will affect all the programs and campaigns. |
|
| Contact Service |
To manage MFI Studio contacts. This means you can manage contacts and custom fields or get contact lists and activities. |
|
| Program Service |
To manage MFI Studio programs. This includes publishing and checking in/out a program, getting programs and program lists, managing programs/elements permissions, getting outbound schedules, system variables and time zone and much more. |
|
| Report Service |
To get contacts, event history, form data report, pivot report and report on change. |
|
| User Service |
To manage MFI Studio users. You can add/update/remove users and roles, change their passwords, register/activate/inactivate them and get different lists such as inactive users and permissions. |
Notes:
- All the parameters that need to be passed to all methods in our REST API Services are mandatory and required.
- The request objects that are passed to all methods can either be in JSON or XML format. The response object will be in the same format as the request. For instance, if you pass JSON, the method will also return JSON. If you pass in XML format, you'll also get the result back in XML format.