API Documentation
Stephen Afije
Last Update setahun yang lepas
You need to add parameter api_token=YOUR_API_TOKEN to each request to the API system
Example: https://app.mailracle.com/api/v1/lists?api_token=YOUR_API_TOKEN
Authentication
| HTTP method | Endpoint | Function |
|---|---|---|
| POST | /api/v1/user/login | Get API token using email and password |
| POST | /api/v1/login-token | Generate one time login token |
Lists
| HTTP method | Endpoint | Function |
|---|---|---|
| POST | /api/v1/lists | |
| GET | /api/v1/lists | Get information about all lists |
| GET | /api/v1/lists/{uid} | Get information about a specific list |
| POST | /api/v1/lists/{uid}/add-field | Add custom field to list |
| DELETE | /api/v1/lists/{uid} | Delete a list |
Campaigns
| HTTP method | Endpoint | Function |
|---|---|---|
| GET | /api/v1/campaigns | |
| POST | /api/v1/campaigns | Add new campaign |
| GET | /api/v1/campaigns/{uid} | Get information about a specific campaign |
| PATCH | /api/v1/campaigns/{uid} | Update campaign |
| POST | /api/v1/campaigns/{uid}/run | Run a specific campaign Post |
| POST | /api/v1/campaigns/{uid}/pause | Pause a specific campaign Post |
| POST | /api/v1/campaigns/{uid}/resume | Resume a specific campaign |
| DELETE | /api/v1/campaigns/{uid} | Delete a campaign |
Subscribers
| HTTP method | Endpoint | Function |
|---|---|---|
| GET | /api/v1/subscribers | Display list's subscribers |
| POST | /api/v1/subscribers | Create subscriber for a mail list |
| GET | /api/v1/subscribers/{id} | Get information about a specific subscriber |
| PATCH | /api/v1/subscribers/{id} | Update subscriber for a mail list |
| POST | /api/v1/subscribers/{id}/add-tag | Add tag(s) to subscriber |
| POST | /api/v1/subscribers/{id}/remove-tag | Remove tag(s) to subscriber |
| GET | /api/v1/subscribers/email/{email} | Find subscribers with email |
| PATCH | /api/v1/lists/{list_uid}/subscribers/{id}/subscribe | Subscribe a subscriber |
| PATCH | /api/v1/lists/{list_uid}/subscribers/{id}/unsubscribe | Unsubscribe a subscriber |
| PATCH | /api/v1/lists/{list_uid}/subscribers/email/{email}/unsubscribe | Unsubscribe a subscriber by email |
| DELETE | /api/v1/subscribers/{id} | Delete a subscriber |
Notification
| HTTP method | Endpoint | Function |
|---|---|---|
| POST | /api/v1/notification/bounce | Send a HARD bounce to the application. Notice that it is not needed to inform the application of SOFT bounces |
Feedback Loop
| HTTP method | Endpoint | Function |
|---|---|---|
| POST | /api/v1/notification/feedback | Send a bounce or abuse report to the application. It could be a success / bounce / feedback or abuse report |
File
| HTTP Method | Endpoint | Function |
|---|---|---|
| POST | /api/v1/file/upload | Upload file(s) to customer's storage |