Class SubscriberController
/api/v1/lists/{list_id}/subscribers - API controller for managing list's subscribers.
-
Acelle\Http\Controllers\Controller
-
Acelle\Http\Controllers\Api\SubscriberController
Methods summary
public
Illuminate\Http\Response
|
#
index( Illuminate\Http\Request $request, string $list_id )
Display all list's subscribers.
Display all list's subscribers.
GET /api/v1/lists/{list_id}/subscribers
Parameters
- $request
- $list_id
- List's id
Returns
Illuminate\Http\Response
|
public
Illuminate\Http\Response
|
#
store( Illuminate\Http\Request $request, string $list_id )
Create subscriber for a mail list.
Create subscriber for a mail list.
GET /api/v1/lists/{list_id}/subscribers/store
Parameters
- $request
- All subscriber information: EMAIL (required), FIRST_NAME (?), LAST_NAME (?),... (depending on the list fields configuration)
- $list_id
- List's id
Returns
Illuminate\Http\Response
|
public
Illuminate\Http\Response
|
#
show( string $list_id, string $id )
Display the specified subscriber information.
Display the specified subscriber information.
GET /api/v1/lists/{list_id}/subscribers/{id}
Parameters
- $list_id
- List's id
- $id
- Subsciber's id
Returns
Illuminate\Http\Response
|
public
Illuminate\Http\Response
|
#
subscribe( string $list_id, string $id )
Subscribe a subscriber.
GET /api/v1/lists/{list_id}/subscribers/{id}/subscribe
Parameters
- $list_id
- List's id
- $id
- Subsciber's id
Returns
Illuminate\Http\Response
|
public
Illuminate\Http\Response
|
#
unsubscribe( string $list_id, string $id )
Unsubscribe a subscriber.
Unsubscribe a subscriber.
GET /api/v1/lists/{list_id}/subscribers/{id}/unsubscribe
Parameters
- $list_id
- List's id
- $id
- Subsciber's id
Returns
Illuminate\Http\Response
|
public
Illuminate\Http\Response
|
#
delete( string $list_id, string $id )
Delete a subscriber.
DELETE /api/v1/lists/{list_id}/subscribers/{id}/delete
Parameters
- $list_id
- List's id
- $id
- Subsciber's id
Returns
Illuminate\Http\Response
|