MailingList

The MailingList object

The MailingList object looks like this in JSON:

{
    "object": "mailing_list",
    "id": 1,
    "name": "Underclassmen",
    "include_spouses": true,
    "merge_spouses": false,
    "include_org_members": false,
    "include_orgs": false,
    "retired_at": null,
    "retired_by_id": null,
    "added_by_name": "Elizabeth Fox",
    "added_at": "2020-01-05T00:20:21+00:00",
    "added_by_id": 1,
    "sandbox": true
}

Attribute	Required	Data Type
id	Yes	int
name	Yes	text (255)
include_spouses	Yes	bool
merge_spouses	Yes	bool
include_org_members	Yes	bool
include_orgs	Yes	bool
retired_at	No	datetime
retired_by_id	No	int
added_by_name	No	text
added_at	No	datetime
added_by_id	No	int
sandbox	No	bool

index

Example code to call this method:

curl "https://yourschool.populiweb.com/api2/mailinglists" \
-H "Content-Type: application/json" \ 
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \ 
-X GET

require 'httparty'
response = HTTParty.get(
 'https://yourschool.populiweb.com/api2/mailinglists',
 headers: {
  'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
 },
)
puts response.body

import requests
response = requests.get(
 'https://yourschool.populiweb.com/api2/mailinglists',
 headers={
  'Authorization': 'Bearer YOUR_POPULI_API_KEY'
 },
)
print(response.json())

using Newtonsoft.Json;
using RestSharp;
var client = new RestClient();
var request = new RestRequest(new Uri("https://yourschool.populiweb.com/api2/mailinglists"), Method.Get);
request.AddHeader("Authorization", "Bearer YOUR_POPULI_API_KEY");
var response = client.Execute(request);
var response_object = JsonConvert.DeserializeObject(response.Content);
Console.Write(response_object);

$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, 'https://yourschool.populiweb.com/api2/mailinglists');
curl_setopt($curl, CURLOPT_HTTPHEADER, ['Authorization: Bearer YOUR_POPULI_API_KEY']);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
$response = curl_exec($curl);
$response_decoded = json_decode($response);
var_dump($response_decoded);

Example response:

{
    "object": "list",
    "count": 1,
    "results": 1,
    "results_per_page": null,
    "pages": 1,
    "page": 1,
    "offset": 0,
    "has_more": false,
    "data": [
        {
            "object": "mailing_list",
            "id": 1,
            "name": "Underclassmen",
            "include_spouses": true,
            "merge_spouses": false,
            "include_org_members": false,
            "include_orgs": false,
            "retired_at": null,
            "retired_by_id": null,
            "added_by_name": "Elizabeth Fox",
            "added_at": "2020-01-05T00:20:21+00:00",
            "added_by_id": 1
        }
    ],
    "sandbox": true
}

Retrieves all MailingList objects.

HTTP Request

GET /mailinglists

Parameters

None

Permissions

One of the following roles is required to call this method:

Staff

show

Example code to call this method:

curl "https://yourschool.populiweb.com/api2/mailinglists/(mailinglist)" \
-H "Content-Type: application/json" \ 
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \ 
-X GET

require 'httparty'
response = HTTParty.get(
 'https://yourschool.populiweb.com/api2/mailinglists/(mailinglist)',
 headers: {
  'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
 },
)
puts response.body

import requests
response = requests.get(
 'https://yourschool.populiweb.com/api2/mailinglists/(mailinglist)',
 headers={
  'Authorization': 'Bearer YOUR_POPULI_API_KEY'
 },
)
print(response.json())

using Newtonsoft.Json;
using RestSharp;
var client = new RestClient();
var request = new RestRequest(new Uri("https://yourschool.populiweb.com/api2/mailinglists/(mailinglist)"), Method.Get);
request.AddHeader("Authorization", "Bearer YOUR_POPULI_API_KEY");
var response = client.Execute(request);
var response_object = JsonConvert.DeserializeObject(response.Content);
Console.Write(response_object);

$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, 'https://yourschool.populiweb.com/api2/mailinglists/(mailinglist)');
curl_setopt($curl, CURLOPT_HTTPHEADER, ['Authorization: Bearer YOUR_POPULI_API_KEY']);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
$response = curl_exec($curl);
$response_decoded = json_decode($response);
var_dump($response_decoded);

Example response:

{
    "object": "mailing_list",
    "id": 1,
    "name": "Underclassmen",
    "include_spouses": true,
    "merge_spouses": false,
    "include_org_members": false,
    "include_orgs": false,
    "retired_at": null,
    "retired_by_id": null,
    "added_by_name": "Elizabeth Fox",
    "added_at": "2020-01-05T00:20:21+00:00",
    "added_by_id": 1,
    "sandbox": true
}

Retrieves a specific MailingList object.

HTTP Request

GET /mailinglists/(mailinglist)

Parameters

No additional parameters are needed beyond the ID of the object being requested that appears in the URL.

Permissions

One of the following roles is required to call this method:

Staff