Appearance
API Mailing List
Compatibility
- EE2
Installation
- Copy the files to the
system/expressionengine/third_party dir
- Enable the API from within the Webservice Module
Methods
create_mailinglist
Short name | Description | |
---|---|---|
list_name | The short name | Required |
list_title | The title | Required |
Request
Array
(
[list_name] => test_mailinglist
[list_title] => Test Mailinglist
)
read_mailinglist
Short name | Description | |
---|---|---|
list_id | The list id | Required |
Request
Array
(
[list_id] => 2
)
update_mailinglist
Short name | Description | |
---|---|---|
list_id | The id of the mailinglist | Required |
list_name | The short name | Optional |
list_title | The title of the list | Optional |
list_template | The template of the list | Optional |
Request
Array
(
[list_id] => 14
[list_name] => test_group
)
delete_mailinglist
Short name | Description | |
---|---|---|
list_id | The id of the mailinglist | Required |
Request
Array
(
[list_id] => 14
)
create_subscription
Short name | Description | |
---|---|---|
list_id | The id of the mailinglist | Required |
The email | Required |
Request
Array
(
[list_id] => 14
[email] => test@example.com
)
delete_subscription
Short name | Description | |
---|---|---|
list_id | The id of the mailinglist | Required |
The email | Required |
Request
Array
(
[list_id] => 14
[email] => test@example.com
)
Hooks
webservice_create_mailinglist_start
(added in v1.0)
$post_data = ee()->extensions->call('webservice_create_mailinglist_start', $post_data);
webservice_create_mailinglist_end
(added in v1.0)
ee()->extensions->call('webservice_create_mailinglist_end', $list_id);
webservice_read_mailinglist_start
(added in v1.0)
$post_data = ee()->extensions->call('webservice_read_mailinglist_start', $post_data);
webservice_read_mailinglist_end
(added in v1.0)
ee()->extensions->call('webservice_delete_category_group_end', $list_id);
webservice_update_mailinglist_start
(added in v1.0)
$post_data = ee()->extensions->call('webservice_update_mailinglist_start', $post_data);
webservice_update_mailinglist_end
(added in v1.0)
ee()->extensions->call('webservice_update_mailinglist_end', $list_id);
webservice_delete_mailinglist_start
(added in v1.0)
$post_data = ee()->extensions->call('webservice_delete_mailinglist_start', $post_data);
webservice_delete_mailinglist_end
(added in v1.0)
ee()->extensions->call('webservice_delete_mailinglist_end', $list_id);
webservice_create_subscription_start
(added in v1.0)
$post_data = ee()->extensions->call('webservice_create_subscription_end', $post_data);
webservice_create_subscription_end
(added in v1.0)
ee()->extensions->call('webservice_create_subscription_end', $list_id);
webservice_delete_subscription_start
(added in v1.0)
$post_data = ee()->extensions->call('webservice_delete_subscription_start', $post_data);
webservice_delete_subscription_end
(added in v1.0)
ee()->extensions->call('webservice_delete_subscription_end');