Getting and Creating List

From Enterprise Help
This is the approved revision of this page, as well as being the most recent.
Jump to: navigation, search

A List is a specific communication type to which Members can subscribe and from which they can unsubscribe. In order for members to receive mailings from a specific list, they must be subscribed to the list.

Getting Member Lists

A site may have one or more lists associated with it. To get all lists associated with a Site-ID (get a SiteID) , send a GET request to the Lists endpoint.

Sample Request (Using 1234567890 as the SiteID):

GET https://services.fishbowl.com/api/odata/v1/1234567890/Lists HTTP/1.1
Accept: application/json
Authorization: Bearer u7kBYz1UhHkoRSc7V4gruBs-4sEpIkFV-F4LGiFMwfGwJNnT_JzNft
g6_Zm0yWi8P m60iPlmCCHUSwCX5Uru-OJq2jzhbT-E6nAc1OwzghTCmeoo0K69ubDBMFX5hyKlc
AjA9H3Vs-ZNjNYKarpSO5rA5ubG5-Va5Aigm9mp-Pre-EaGAY_HBdxZi-LBMSQ_mSjyIDPBpLFYP
BNzK3cu0xGobGsFLxPtDG3urs_4abXZtvxN8wm9rpsgr


Sample Response:

  {
 "odata.metadata":"http://services.fishbowl.com/API/odata/v1/1234567890/$metadata#Lists",
 "value":[
    {
       "ListID":"1122334455",
       "SiteID":"1234567890",
       "Name":"General Mailings",
       "Description":"General Mailings",
       "DefaultFromName":"Fishbowl",
       "DefaultFromAddress":"Mailing@fishbowl.com",
       "DefaultReplyTo":"someemail@domain.com",
       "DefaultSubject":"",
       "DisplayName":false,
       "LockDefaultFromName":false,
       "LockDefaultFromAddress":false,
       "LockDefaultReplyTo":true,
       "LockDefaultSubject":false,
       "SubscribedByDefault":true,
       "Active":true,
       "DisplayDescription":false,
       "CreatedUtc":"2015-11-23T12:33:51.87Z"
    },
    {
       "ListID":"2233445566",
       "SiteID":"1234567890",
       "Name":"VIP List",
       "Description":"",
       "DefaultFromName":"",
       "DefaultFromAddress":"",
       "DefaultReplyTo":"",
       "DefaultSubject":"",
       "DisplayName":true,
       "LockDefaultFromName":false,
       "LockDefaultFromAddress":false,
       "LockDefaultReplyTo":false,
       "LockDefaultSubject":false,
       "SubscribedByDefault":false,
       "Active":true,
       "DisplayDescription":true,
       "CreatedUtc":"2014-11-10T15:31:33.55Z"
    }
 ]
}


Create A New List


To create a new list, send a POST request to the Lists endpoint.


Sample Request (Using 1234567890 as the SiteID):

POST http://services.fishbowl.com/api/odata/v1/1234567890/Lists HTTP/1.1
Accept: application/json
Authorization: Bearer u7kBYz1UhHkoRSc7V4gruBs-4sEpIkFV-F4LGiFMwfGwJNnT_JzNft
g6_Zm0yWi8P m60iPlmCCHUSwCX5Uru-OJq2jzhbT-E6nAc1OwzghTCmeoo0K69ubDBMFX5hyKlc
AjA9H3Vs-ZNjNYKarpSO5rA5ubG5-Va5Aigm9mp-Pre-EaGAY_HBdxZi-LBMSQ_mSjyIDPBpLFYP
BNzK3cu0xGobGsFLxPtDG3urs_4abXZtvxN8wm9rpsgr
Content-Type: application/json; charset=utf-8
{        
 "ListID":"0",
 "SiteID":"1234567890",
 "Name":"New List",
 "Description":"A Secondary List",
 "SubscribedByDefault":false,
 "Active":true
}


Sample Response:

  {    
 "odata.metadata":"http://services.fishbowl.com/API/odata/v1/1234567890/$metadata#Lists/@Element",
 "ListID":"3344556677",
 "SiteID":"1234567890",
 "Name":"New List",
 "Description":"A Secondary List",
 "DefaultFromName":null,
 "DefaultFromAddress":null,
 "DefaultReplyTo":null,
 "DefaultSubject":null,
 "DisplayName":false,
 "LockDefaultFromName":false,
 "LockDefaultFromAddress":false,
 "LockDefaultReplyTo":false,
 "LockDefaultSubject":false,
 "SubscribedByDefault":false,
 "Active":true,
 "DisplayDescription":false,
 "CreatedUtc":"0001-01-01T05:00:00Z" 
}


If the list is created successfully, the response will contain the newly created List ID. Save the List ID value so it can be used to subscribe members to the list during member creation process.