FORMAT: 0.1
SOAP API for phpList accounts hosted on phpList.com. See README for setup and requirements. This file borrows conventions from api blueprint.
Check that a connection can be established with a successful response and return API and phpList version.
-
Request
(no arguments)
-
Response
string("Hi there, from phpList Hosted, API version 0.1 - rev $Rev: 2788 $ managing phpList version 3.3.1-hosted")
-
Request
$message_id
-
Response
Array ( [processed] => 55 [viewed] => 26 [urls] => Array ( ) ) // success
Create a new HTML campaign.
-
Request
$subject $content $from_field $footer $list_id
-
Response
int(21) // success bool(false) // failure
Update an existing campaign.
-
Request
$message_id $subject $content $from_field $footer $list_id
-
Response
int(21) // success bool(false) // failure
Add an existing campaign to the message queue for sending (actual send date depends on campaign scheduling).
[FIXME] Always returns string(1), regardless of campaign ID or outcome.
-
Request
$messageid
-
Response
string(1) // success / failure
Get the list ID for a given list name.
[FIXME] Always returns int(-1) regardless of input
-
Request
$list_name
-
Response
int(3) // success int(-1) // failure
Create a new subscriber list.
-
Request
$name $description
-
Response
int(11) // success
Add an existing list to a list category.
[NOTE] Specified category will be created if it doesn't exist.
-
Request
$list_id $category_name
-
Response
string(10) "category 1" // success bool(false) // failure
Check if a given subscriber is a member of a given list.
-
Request
$email $list_id
-
Response
string(1) // true string(0) // false
Add a subscriber to a given list.
[NOTE] If the subscriber does not exist it will be created
-
Request
$email $list
-
Response
Array ( [0] => [email protected] ) // success bool(false) // failure
-
Request
$list_id $emails
-
Response
Array ( [0] => [email protected] [1] => [email protected] ) // success Array ( ) // false bool(false) // failure