The section describes the JSON request to update a subscriber
Required to Submit JSON Request
|
Username |
The email that account holder uses to login SMTP PLANS |
|
API Token |
The API token user has generated using API Configuration section |
|
Method |
POST |
|
Path |
https://portal.smtp-plans.com/API/updateSubscriber |
Throughout this API document, required fields are mentioned as required under priority column of the Field Details Table. While for the non-required fields, priority column remains empty. The second column of the table "Variables" shows the variables that you will use in an API request to parse the values of the respective fields.
Field Details
|
Label/Variable |
Priority |
Description |
|
subscriber_id |
Required |
Subscriber ID of the subscriber you want to update |
|
list_id |
Required |
ID of the list where subscriber is located |
|
|
Optional |
Email of the subscriber is required to update its information |
|
title |
Optional |
Professional title, designation of the subscriber such as COO, CIO, CMO etc |
|
first_name |
Optional |
First Name of the Subscriber you want to add to the list |
|
last_name |
Optional |
Last Name of the Subscriber you want to add to the list |
|
unsubscribed |
Optional |
Had the subscriber been marked as “Unsubscribed”? If yes then set this field with “1” while sending API request for adding subscriber information to a list. Otherwise, proceed with “0” which sets this subscriber status as default “Subscribed” within the list. |
|
bounced |
Optional |
Had the subscriber been marked as “Bounced”? If yes then set this field with “1” while sending API request for adding subscriber information to a list. Otherwise, proceed with “0” which sets this subscriber status as default “Not Bounced” within the list. |
|
create_date |
Optional |
|
|
format |
Optional |
What essential email format subscriber prefers to receive, HTML/ Text (h for HTML and t for Text emails) |
|
confirmation_status |
Optional |
Indicates the confirmation status of the subscriber, confirmed or not. Set this field with “1” to mark the subscriber status as “Confirmed” or proceed with “0” in case subscriber has not been confirmed yet. |
|
city |
Optional |
Which city subscriber belongs to, update accordingly. |
|
country |
Optional |
Which country subscriber belongs to |
|
company |
Optional |
Update the company information of the subscriber |
|
post_code |
Optional |
Update post code information of the subscriber’s current location |
|
state |
Optional |
Which state subscriber belongs to |
|
mobile |
Optional |
Update the mobile phone number of the subscriber |
|
phone |
Optional |
Update the phone number of the subscriber |
|
fax |
Optional |
Information of the subscriber to update into the Fax field. |