Use WPNewsman API

All requests must be addressed to the script api.php

The script has two required parameters: method and key.

By default all methods respond with appropriate HTTP codes on errors. Sometimes an environment doesn’t allow to properly handle error responses, so you can add a bepositive=1 parameter to your request and the plugin will always respond with the “200 Ok” HTTP code. In this case only the “state: false” property of the response JSON object will indicate an error.

Available methods:

• addEmail adds the subscriber and sets the “Confirmed” status for him. The additional required parameter is email. Other parameters will be added to the JSON object in the database.
• getLists returns the subscribers’ lists
• getListFieldsThis method returns all the available fields for the list.
• downloadList returns the CSV or JSON file with subscribers. The additional required parameter is listId. The additional parameter links can contain the list of links that must be generated for each subscriber. Possible types of links are confirmation-link, resend-confirmation-link and unsubscribe-link. Other two parameters of this method are offset and limit. offset allows skip xx subscribers and return the subscribers starting from the xx number. limit allows limit the number of subscribers to return.
• unsubscribe unsubscribes reciepients from the list

See the requests and responses below.

Method: addEmail

Params:

Request:

api.php?method=addEmail&key=API_KEY&listId=2&first-name=John&last-name=Doe&email=john@doe.com

Response:

{
state: true,
msg: "Subscriber added",
id: 28
}
                

{
state: false,
msg: "The email "john@doe.com" is already subscribed but not yet confirmed.",
status: 0
}

{
state: false,
msg: "The email "john@doe.com" is already subscribed and confirmed.",
status: 1
}

{
state: false,
msg: "The email "john@doe.com" is already already in the database but unsubscribed.",
status: 2
}

Request:

/api.php?method=addEmail&key=API_KEY&listId=2&first-name=John&last-name=Doe&email=john@doe.com&full-cycle=1

Response:

{
state: true,
msg: "Subscriber added",
result: "http://yourdomain.com/subscription/confirmation-required-2/?u=$unique-code"
}									
                

{
state: true,
msg: "The email "john@doe.com" is already subscribed but not yet confirmed.",
result: "http://blog.dev/subscription/email-subscribed-not-confirmed-2/?u=5JFHCK8BPXgo-vZNsq4z83N8loE:mAZaQ6C0XNOFMJLEZLqziA"
}

{
state: true,
msg: "The email "john@doe.com" is already subscribed and confirmed.",
result: "http://blog.dev/subscription/already-subscribed-and-verified-2/?u=5JFHCK8BPXgo-vZNsq4z83N8loE:mAZaQ6C0XNOFMJLEZLqziA"
}

{
state: true,
msg: "The email "john@doe.com" is already subscribed but not yet confirmed.",
result: "http://blog.dev/subscription/email-subscribed-not-confirmed-2/?u=5JFHCK8BPXgo-vZNsq4z83N8loE:mAZaQ6C0XNOFMJLEZLqziA"
}

Request:

/api.php?method=addEmail&key=API_KEY&listId=2&first-name=John&last-name=Doe&email=john@doe.com&&full-cycle=1&use-excerpts=1

Response:

{
state: true,
msg: "Subscriber added",
result: "Please Check Your Email to Confirm Your Subscription!"
}

{
state: true,
msg: "The email "john@doe.com" is already subscribed but not yet confirmed.",
result: "This email address is already in our mailing list, however it has not been confirmed. If you would like your verification email resent, please click here."
}

{
state: true,
msg: "The email "john@doe.com" is already subscribed and confirmed.",
result: "If you are not receiving our newsletter, please check your spam filter settings as the email may have been incorrectly flagged as spam and moved to junk mail folder by your email client."
}

{
state: true,
msg: "The email "john@doe.com" is already subscribed but not yet confirmed.",
result: "Please Check Your Email to Confirm Your Subscription!"
}

Method: getLists

Method has no additional parameters

Request:

api.php?method=getLists&key=API_KEY

Response:

{
    state: true,
    msg: [
        {
            id: 1,
            uid: "qZoKYDA2FmLBdVhFXUqOnyQTQCw",
            name: "default",
            confirmed: 68258,
            unsubscribeURL: "http://yourdomain.com/?newsman=unsubscribe&code=qZoKYDA2FmLBdVhFXUqOnyQTQCw:"
        },
    ...
    ]
}

Method: getListFields

This method returns all the available fields for the list.

Request:

api.php?method=getListFields&listId=2&key=API_KEY

Response:

{
    state: true,
    msg: {
        fields: [
            "id",
            "ts",
            "ip",
            "email",
            "status",
            "ucode",
            "first-name",
            "last-name"
        ]
    }
}

Method: downloadList

This method allows to retrieve portion or entire list in CSV or JSON formats.

Request:

api.php?method=downloadList&type=confirmed&format=json&nofile=1&offset=0&listId=6&key=API_KEY&map=email:Email,first-name:First_Name,last-name:Last_Name&fields=email,first-name,last-name&limit=50'

Response:

CSV file or JSON:
[
   {"Email":"jon@doe.com","First_Name":"Jon","Last_Name":"Doe"},
   {"Email":"Lee@hughes.com","First_Name":"Lee","Last_Name":"Hughes"}
]

Method: unsubscribe

Unsubscribes reciepients from the list

Request:

api.php?method=unsubscribe&listId=1&emails=john@doe.com&key=API_KEY

Response:

{
    state: true,
    msg: "Successfully unsubscribed."
}