Introduction

Overview How to call Authentication Request Response Pagination Filtering Sorting

API Reference

Mailing list

(ms.mailing_lists)

Mailing list API can be used to fetch details of the users subscribed to a newsletter.

Fields
EndPoints

Fields

ValueDescription
name   
Type: string
Required
Name of the user list.
Newsletter
list_name   
Type: string
Required
The name of the list that you want to create in the provider's account.
Newsletter
conditions   
Type: object
Required
Specify the condition to segment the users.
operator
Type: string
Required
value
Type: datetime
Required
user_group
Type: string
Required
provider   
Type: string
Required
List of email providers in the drop-down.

Commands (Endpoints)

POST /api/1/entity/ms.mailing_lists   
Creates a new mailing list
DEL /api/1/entity/ms.mailing_lists/{resource_id}   
Deletes a mailing list
PUT /api/1/entity/ms.mailing_lists/{resource_id}   
Updates an existing mailing list
GET /api/1/entity/ms.mailing_lists/{resource_id}   
Retrieves a single mailing list
GET /api/1/entity/ms.mailing_lists   
Retrieves a list of mailing list