HTTP method |
Endpoint |
Function |
POST
|
/api/v1/lists
|
New list
|
|
Parameters
- $name
- List's name
- $from_email
- Default From email address
- $from_name
- Default From name
- divider
- Contact information
- $contact[company]
- Name
- $contact[state]
- State / Province / Region
- $contact[address_1]
- Address 1
- $contact[address_2]
- Address 2
- $contact[city]
- City
- $contact[zip]
- Zip / Postal code
- $contact[phone]
- Phone
- $contact[country_id]
- Country id
- $contact[email]
- Email
- $contact[url]
optional
- Home page
- $subscribe_confirmation
- Send subscription confirmation email (Double Opt-In)
- $send_welcome_email
- Send a final welcome email
- $unsubscribe_notification
- Send unsubscribe notification to subscribers
- $send_welcome_email
- Send a final welcome email
Returns
Creation messages in json
|
Example:
curl -X POST -H "accept:application/json" -G \
https://app.sendimpactt.com/api/v1/lists \
-d api_token=YOUR_API_TOKEN\
-d name=List+1 \
-d from_email=admin@abccorp.org \
-d from_name=ABC+Corp. \
-d contact[company]=ABC+Corp. \
-d contact[state]=Armagh \
-d contact[address_1]=14+Tottenham+Court+Road+London+England \
-d contact[address_2]=44-46+Morningside+Road+Edinburgh+Scotland+EH10+4BF \
-d contact[city]=Noname \
-d contact[zip]=80000 \
-d contact[phone]=123+456+889 \
-d contact[country_id]=1 \
-d contact[email]=info@abccorp.org \
-d contact[url]=http://www.abccorp.org \
-d subscribe_confirmation=1 \
-d send_welcome_email=1 \
-d unsubscribe_notification=1
|
GET
|
/api/v1/lists
|
Get information about all lists
|
|
Returns
List of all user's mail lists in json
|
Example:
curl -X GET -H "accept:application/json" -G \
https://app.sendimpactt.com/api/v1/lists \
-d api_token=YOUR_API_TOKEN
|
GET
|
/api/v1/lists/{uid}
|
Get information about a specific list
|
|
Returns
All list informations in json
|
Example:
curl -X GET -H "accept:application/json" -G \
https://app.sendimpactt.com/api/v1/lists/{uid} \
-d api_token=YOUR_API_TOKEN
|
POST
|
/api/v1/lists/{uid}/add-field
|
Add custom field to list
|
|
Parameters
- $type
- Choose one of these types: text, number, datetime.
- $label
- Field' label
- $tag
- The tag name may have alpha-numeric characters, as well as dashes and underscores.
- $default_value
optional
- Default value of the field
Returns
Creation messages in json
|
Example:
curl -X POST -H "accept:application/json" -G \
https://app.sendimpactt.com/api/v1/lists/{uid}/add-field \
-d api_token=YOUR_API_TOKEN \
-d type=text \
-d label=Custom \
-d tag=CUSTOM_FIELD_1 \
-d default_value=test
|
DELETE
|
/api/v1/lists/{uid}
|
Delete a list
|
|
Parameters
Returns
Result messages in json
|
Example:
curl -X DELETE -H "accept:application/json" -G \
https://app.sendimpactt.com/api/v1/lists/{uid} \
-d api_token=YOUR_API_TOKEN
|
HTTP method |
Endpoint |
Function |
GET
|
/api/v1/campaigns
|
Get information about all campaigns
|
|
Returns
List of all user's campaigns in json
|
Example:
curl -X GET -H "accept:application/json" -G \
https://app.sendimpactt.com/api/v1/campaigns \
-d api_token=YOUR_API_TOKEN
|
GET
|
/api/v1/campaigns/{uid}
|
Get information about a specific campaign
|
|
Returns
Campaign's information in json
|
Example:
curl -X GET -H "accept:application/json" -G \
https://app.sendimpactt.com/api/v1/campaigns/{uid} \
-d api_token=YOUR_API_TOKEN
|
POST
|
/api/v1/campaigns/{uid}/pause
|
Pause a specific campaign
|
|
Returns
Action messages in json
|
Example:
curl -X POST -H "accept:application/json" -G \
https://app.sendimpactt.com/api/v1/campaigns/{uid}/pause \
-d api_token=YOUR_API_TOKEN
|
HTTP method |
Endpoint |
Function |
GET
|
/api/v1/subscribers
|
Display list's subscribers
|
|
Parameters
- $list_uid
- List's uid
- $open
optional
- default: all
- yes - opened some campaigns
no - not opened any campaign
- $click
optional
- default: all
- yes - clicked some campaigns
no - not clicked any campaign
- $per_page
optional
- default: 25
- Number of subscribers per page
- $page
- Page number
Returns
List of all list's subscribers in json
|
Example:
curl -X GET -H "accept:application/json" -G \
https://app.sendimpactt.com/api/v1/subscribers \
-d api_token=YOUR_API_TOKEN'
-d list_uid={list_uid} \
-d per_page=20 \
-d page=1
|
POST
|
/api/v1/subscribers
|
Create subscriber for a mail list
|
|
Parameters
- $list_uid
- List's uid
- $EMAIL
- Subscriber's email
- $tag
optional
- Subscriber's tags, seperated by a comma (,).
- $[OTHER_FIELDS...]
optional
- All subscriber's other fields: FIRST_NAME (?), LAST_NAME (?),... (depending on the list fields configuration)
Returns
Creation messages in json
|
Example:
curl -X POST -H "accept:application/json" -G \
https://app.sendimpactt.com/api/v1/subscribers \
-d api_token=YOUR_API_TOKEN'
-d list_uid={list_uid} \
-d EMAIL=test@gmail.com \
-d tag=foo,bar,tag+with+space, \
-d FIRST_NAME=Marine \
-d LAST_NAME=Joze
|
GET
|
/api/v1/subscribers/{uid}
|
Get information about a specific subscriber
|
|
Parameters
- $uid
- Subsciber's uid or email
Returns
All subscriber information in json
|
Example:
curl -X GET -H "accept:application/json" -G \
https://app.sendimpactt.com/api/v1/subscribers/{uid} \
-d api_token=YOUR_API_TOKEN
|
PATCH
|
/api/v1/subscribers/{uid}
|
Update subscriber for a mail list
|
|
Parameters
- $uid
- Subscriber's uid
- $EMAIL
- Subscriber's email
- $tag
optional
- Subscriber's tags, seperated by a comma (,).
- $[OTHER_FIELDS...]
optional
- All subscriber's other fields: FIRST_NAME (?), LAST_NAME (?),... (depending on the list fields configuration)
Returns
Update messages in json
|
Example:
curl -X PATCH -H "accept:application/json" -G \
https://app.sendimpactt.com/api/v1/subscribers/{uid} \
-d api_token=YOUR_API_TOKEN'
-d EMAIL=test@gmail.com \
-d tag=foo,bar,tag+with+space, \
-d FIRST_NAME=Marine \
-d LAST_NAME=Joze
|
POST
|
/api/v1/subscribers/{uid}/add-tag
|
Add tag(s) to subscriber
|
|
Parameters
- $tag
optional
- Subscriber's tags, seperated by a comma (,).
Returns
Creation messages in json
|
Example:
curl -X POST -H "accept:application/json" -G \
https://app.sendimpactt.com/api/v1/subscribers/{uid}/add-tag \
-d api_token=YOUR_API_TOKEN'
-d tag=foo,bar,tag+with+space
|
GET
|
/api/v1/subscribers/email/{email}
|
Find subscribers with email
|
|
Parameters
Returns
All subscribers with the email
|
Example:
curl -X GET -H "accept:application/json" -G \
https://app.sendimpactt.com/api/v1/subscribers/email/{email} \
-d api_token=YOUR_API_TOKEN
|
PATCH
|
/api/v1/lists/{list_uid}/subscribers/{uid}/subscribe
|
Subscribe a subscriber
|
|
Parameters
- $list_uid
- List's uid
- $uid
- Subsciber's uid
Returns
Result messages in json
|
Example:
curl -X PATCH -H "accept:application/json" -G \
https://app.sendimpactt.com/api/v1/lists/{list_uid}/subscribers/{uid}/subscribe \
-d api_token=YOUR_API_TOKEN
|
PATCH
|
/api/v1/lists/{list_uid}/subscribers/{uid}/unsubscribe
|
Unsubscribe a subscriber
|
|
Parameters
- $list_uid
- List's uid
- $uid
- Subsciber's uid
Returns
Result messages in json
|
Example:
curl -X PATCH -H "accept:application/json" -G \
https://app.sendimpactt.com/api/v1/lists/{list_uid}/subscribers/{uid}/unsubscribe \
-d api_token=YOUR_API_TOKEN
|
DELETE
|
/api/v1/subscribers/{uid}
|
Delete a subscriber
|
|
Parameters
- $list_uid
- List's uid
- $uid
- Subsciber's uid
Returns
Result messages in json
|
Example:
curl -X DELETE -H "accept:application/json" -G \
https://app.sendimpactt.com/api/v1/subscribers/{uid} \
-d api_token=YOUR_API_TOKEN
|
HTTP method |
Endpoint |
Function |
GET
|
/api/v1/plans
|
Get information about all plans
|
|
Returns
List of all plans in json
|
Example:
curl -X GET -H "accept:application/json" -G \
https://app.sendimpactt.com/api/v1/plans \
-d api_token=YOUR_API_TOKEN
|
POST
|
/api/v1/plans
|
Add new plan
|
|
Parameters
- $name
- Plan's name
- $currency_id
- Currency's id
- $frequency_amount
- Billing recurs every this amount of time
- $frequency_unit
- Time unit for billing recurs (day, week, month, year, unlimited)
- $price
- Plan's price
- $color
- Plan's color (red, blue, #008c6e, #917319,...)
- $options[...]
optional
- Plan's options...
- email_max: Email sending credits (number, -1 for unlimited)
- list_max: Max lists (number, -1 for unlimited)
- subscriber_max: Max subscribers (number, -1 for unlimited)
- subscriber_per_list_max: Max subscribers per list (number, -1 for unlimited)
- segment_per_list_max: Max segments per list (number, -1 for unlimited)
- campaign_max: Max campaigns (number, -1 for unlimited)
- automation_max: Max automations (number, -1 for unlimited)
- sending_quota: Sending credits (number, -1 for unlimited)
- sending_quota_time: Time value (number, -1 for unlimited)
- sending_quota_time_unit: Time unit (day|hour|minute)
- max_process: Max number of processes (number)
- all_sending_servers: Use all sending servers (yes|no)
- max_size_upload_total: Maximum size of all files (MB) (number)
- max_file_size_upload: Maximum upload size per file (MB) (number)
- unsubscribe_url_required: {UNSUBSCRIBE_URL} tag is required (yes|no)
- access_when_offline: Access when site is offline (yes|no)
- create_sending_domains: Allows customer to add sending domains (yes|no)
- sending_servers_max: Max sending servers per customer (number, -1 for unlimited)
- sending_domains_max: Max sending domains per customer (number, -1 for unlimited)
- all_email_verification_servers: Use all email verification servers (yes|no)
- create_email_verification_servers: Allows customer to add email verification servers (yes|no)
- email_verification_servers_max: Verification credits limit per billing cycle (number, -1 for unlimited)
- list_import: Customer can import list (yes|no)
- list_export: Customer can export list (yes|no)
- all_sending_server_types: Allow customer to add any sending server type (yes|no)
- sending_server_types: (array)
- sending_server_option: (system|own|subaccount)
- sending_server_subaccount_uid
Returns
Creation messages in json
|
Example:
curl -X POST -H "accept:application/json" -G \
https://app.sendimpactt.com/api/v1/plans \
-d api_token=YOUR_API_TOKEN'
-d name=Advanced \
-d currency_id=1 \
-d frequency_amount=1 \
-d frequency_unit=month \
-d price=20 \
-d color=red \
-d options[sending_server_option]=own \
-d options[email_max]=10000
|
HTTP method |
Endpoint |
Function |
POST
|
/api/v1/customers
|
Add new customer
|
|
Returns
Creation messages in json
|
Example:
curl -X POST -H "accept:application/json" -G \
https://app.sendimpactt.com/api/v1/customers \
-d api_token=YOUR_API_TOKEN'
-d email=user_name@gmail.com \
-d first_name=Luan \
-d last_name=Pham \
-d timezone=America/Godthab \
-d language_id=1 \
-d password=123456
|
GET
|
/api/v1/customers/{uid}
|
Get information about a specific customer
|
|
Parameters
Returns
Customer information in json (profile, contact, sunscriptions,... )
|
Example:
curl -X GET -H "accept:application/json" -G \
https://app.sendimpactt.com/api/v1/customers/{uid} \
-d api_token=YOUR_API_TOKEN
|
PATCH
|
/api/v1/customers
|
Update customer
|
|
Parameters
Returns
Creation messages in json
|
Example:
curl -X PATCH -H "accept:application/json" -G \
https://app.sendimpactt.com/api/v1/customers/{uid} \
-d api_token=YOUR_API_TOKEN \
-d email=user_name@gmail.com \
-d first_name=Luan \
-d last_name=Pham \
-d timezone=America/Godthab \
-d language_id=1 \
-d password=123456
|
PATCH
|
/api/v1/customers/{uid}/enable
|
Enable customer
|
|
Parameters
Returns
Action messages in json
|
Example:
curl -X PATCH -H "accept:application/json" -G \
https://app.sendimpactt.com/api/v1/customers/{uid}/enable \
-d api_token=YOUR_API_TOKEN
|
PATCH
|
/api/v1/customers/{uid}/disable
|
Disable customer
|
|
Parameters
Returns
Action messages in json
|
Example:
curl -X PATCH -H "accept:application/json" -G \
https://app.sendimpactt.com/api/v1/customers/{uid}/disable \
-d api_token=YOUR_API_TOKEN
|
POST
|
/api/v1/customers/{uid}/assign-plan/{plan_uid}
|
Assign Plan to Customer
|
|
Parameters
- $uid
- Customer's uid
- $plan_uid
- Plan's uid
- $disable_billing
- Activate the subscription without checking out. Default: false
Returns
Action messages in json
|
Example:
curl -X POST -H "accept:application/json" -G \
https://app.sendimpactt.com/api/v1/customers/{uid}/assign-plan/{plan_uid} \
-d api_token=YOUR_API_TOKEN
|