phpList REST API Plugin v1

The following methods are called by Body Param [cmd] to the plugin URL via an HTTP POST request.

Required body parameter
Optional body parameter
Datatype

login

Function to call for login.

Parameters:
login string loginname as an admin to phpList
password string the password


listsGet

Gets all lists in phpList as an array.

Parameters:
(none)

Returns:
Array of lists. Limited to 50.


listGet

Gets one (1) list.

Parameters:
id integer the ID of the list.

Returns:
One list.


listAdd

Add a new list.

Parameters:
name string the name of the list.
description string adds a description to the list.
listorder integer an expression to sortorder, eg 100.
active integer if list should be active set this one to 1, otherwise it will be disabled.

Returns:
The list added.


listUpdate

Update existing List.

Parameters:
id integer the ID of the list.
name string the name of the list.
description string adds a description to the list.
listorder integer an expression to sortorder, eg 100.
active integer if list should be active set this one to 1, otherwise it will be disabled.

Returns:
The list updated.


listDelete

Delete a List.

Parameters:
id integer the ID of the list.

Returns:
System message of action.


listsSubscriber

Get Lists a Subscriber is Member of.

Parameters:
subscriber_id integer the Subscriber-ID.

Returns:
Array of lists where the subscriber is assigned to.


listSubscriberAdd

Add a subscriber to a list.

The subscriber then subscribes to the list.

Parameters:
list_id integer the ID of the list.
subscriber_id integer the ID of the subscriber.

Returns:
Array of lists where the subscriber is assigned to.


listSubscriberDelete

Remove a subscriber from a list.

Parameters:
list_id integer the ID of the list.
subscriber_id integer the ID of the subscriber.

Returns:
System message of action.


listCampaignAdd

Assigns a list to a campaign.

Parameters:
list_id integer the ID of the list.
campaign_id integer the ID of the campaign.

Returns:
The list assigned.


listCampaignDelete

Unassigns a list from a campaign.

Parameters:
list_id integer the ID of the list.
campaign_id integer the ID of the campaign.

Returns:
System message of action.


subscribersGet

Get all the Subscribers in the system.

Parameters:
order_by string name of column to sort, default "id".
order string sort order asc or desc, default: asc.
limit integer limit the result, default 100 (max 100)
offset integer offset of the result, default 0.

Returns:
List of Subscribers.


subscribersCount

Get the total of Subscribers in the system.

Parameters:
none

Returns:
Number of subscribers.


subscriberGet

Get one Subscriber by ID.

Parameters:
id integer the ID of the Subscriber.

Returns:
One Subscriber only.


subscriberGetByEmail

Get one Subscriber by email address.

Parameters:
email string the email address of the Subscriber.

Returns:
One Subscriber only.


subscriberGetByForeignkey

Get one Subscriber by foreign key.

Parameters:
foreignkey string the foreign key of the Subscriber.

Returns:
One Subscriber only.


subscriberAdd

Add one Subscriber.

Parameters:
email string the email address of the Subscriber.
confirmed integer 1=confirmed, 0=unconfirmed.
htmlemail integer 1=html emails, 0=no html emails.
foreignkey string Foreign key.
subscribepage integer subscribe page to sign up to.
password string The password for this Subscriber.
disabled integer 1=disabled, 0=enabled

Returns:
The added Subscriber.


subscribe

Add a Subscriber with lists.

Parameters:
email string the email address of the Subscriber.
foreignkey string Foreign key.
htmlemail integer 1=html emails, 0=no html emails.
subscribepage integer subscribepage to sign up to.
lists string comma-separated list IDs.

Returns:
The added Subscriber.


subscriberUpdate

Update one Subscriber.

Parameters:
id integer the ID of the Subscriber.
email string the email address of the Subscriber.
confirmed integer 1=confirmed, 0=unconfirmed.
htmlemail integer 1=html emails, 0=no html emails.
rssfrequency integer
password string The password to this Subscriber.
disabled integer 1=disabled, 0=enabled

Returns:
The updated Subscriber.


subscriberDelete

Delete a Subscriber.

Parameters:
id integer the ID of the Subscriber.

Returns:
The deleted Subscriber ID.


templatesGet


templateGet


templateGetByTitle


templateAdd

Add a new template.

Parameters:
title string the name of the list.
template string adds a description to the list.

Returns:
The template added.


templateUpdate


templateDelete


campaignGet


campaignsCount


campaignsGet

Get all the Campaigns in the system.

Parameters:
order_by string name of column to sort, default "id".
order string sort order asc or desc, default: asc.
limit integer limit the result, default 10 (max 10)
offset integer offset of the result, default 0.

Returns:
List of Campaigns.


campaignAdd

Add a new campaign.

Parameters:
subject string
fromfield string
replyto string
message string
textmessage string
footer string
status string
sendformat string
template string
embargo string
rsstemplate string
owner string
htmlformatted string

Returns:
The message added.


campaignUpdate

Update existing campaign.

Parameters:
id integer
subject string
fromfield string
replyto string
message string
textmessage string
footer string
status string
sendformat string
template string
embargo string
rsstemplate string
owner string
htmlformatted string

Returns:
The message added.