API Documentation

You need to add parameter api_token=YOUR_API_TOKEN to each request to the API system
Example: https://app.sendimpactt.com/api/v1/lists?api_token=YOUR_API_TOKEN

Authentication

HTTP method Endpoint Function
POST /api/v1/login-token Generate one time login token

LISTS

HTTP method Endpoint Function
POST /api/v1/lists New list
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 Get information about all campaigns
GET /api/v1/campaigns/{uid} Get information about a specific campaign
POST /api/v1/campaigns/{uid}/pause Pause a specific 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/{uid} Get information about a specific subscriber
PATCH /api/v1/subscribers/{uid} Update subscriber for a mail list
POST /api/v1/subscribers/{uid}/add-tag Add tag(s) to subscriber
GET /api/v1/subscribers/email/{email} Find subscribers with email
PATCH /api/v1/lists/{list_uid}/subscribers/{uid}/subscribe Subscribe a subscriber
PATCH /api/v1/lists/{list_uid}/subscribers/{uid}/unsubscribe Unsubscribe a subscriber
DELETE /api/v1/subscribers/{uid} Delete a subscriber

Authentication

HTTP method Endpoint Function
POST /api/v1/login-token Generate one time login token

Plan

HTTP method Endpoint Function
GET /api/v1/plans Get information about all plans
POST /api/v1/plans Add new plan

SENDING SERVER

HTTP method Endpoint Function
GET /api/v1/sending_servers Get information about all sending servers

Customer

HTTP method Endpoint Function
POST /api/v1/customers Add new customer
GET /api/v1/customers/{uid} Get information about a specific customer
PATCH /api/v1/customers Update customer
PATCH /api/v1/customers/{uid}/enable Enable customer
PATCH /api/v1/customers/{uid}/disable Disable customer
POST /api/v1/customers/{uid}/assign-plan/{plan_uid} Assign Plan to Customer

Subscription

HTTP method Endpoint Function
GET /api/v1/subscriptions Get information about all subscriptions
POST /api/v1/customers/{uid}/assign-plan/{plan_uid} Assign Plan to Customer

Notification

HTTP method Endpoint Function
POST /api/v1/notification Send a delivery or abuse report to the application. It could be a success / bounce / feedback or abuse report

Notification

HTTP method Endpoint Function
POST /api/v1/notification Send a delivery 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