Skip to content

Commit 189acdc

Browse files
oliverkleeSam Tuke
authored andcommitted
[FOLLOWUP] API documentation for /lists/{list}/members (#88)
1 parent 17d227a commit 189acdc

File tree

1 file changed

+52
-0
lines changed

1 file changed

+52
-0
lines changed

Documentation/Api/RestApi.apib

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,58 @@ provided as basic auth password. (The basic auth user name can be any string.)
128128
}
129129

130130

131+
## Members of a subscriber list [/lists/{list}/members]
132+
133+
### Retrieve all members of a subscriber list [GET]
134+
135+
+ Request (application/json)
136+
137+
+ Response 200 (application/json)
138+
139+
+ Body
140+
141+
{
142+
"creation_date" => "2016-07-22T15:01:17+00:00",
143+
"email" => "[email protected]",
144+
"confirmed" => true,
145+
"blacklisted" => true,
146+
"bounce_count" => 17,
147+
"unique_id" => "95feb7fe7e06e6c11ca8d0c48cb46e89",
148+
"html_email" => true,
149+
"disabled" => true,
150+
"id" => 1,
151+
},
152+
{
153+
"creation_date" => "2017-07-22T15:12:17+00:00",
154+
"email" => "[email protected]",
155+
"confirmed" => true,
156+
"blacklisted" => false,
157+
"bounce_count" => 1,
158+
"unique_id" => "95feb7fe7e06e6c11ca8d0c48cb4616d",
159+
"html_email" => false,
160+
"disabled" => false,
161+
"id" => 2,
162+
}
163+
164+
+ Response 403 (application/json)
165+
166+
+ Body
167+
168+
{
169+
"code": 403,
170+
"message": "No valid session key was provided as basic auth password."
171+
}
172+
173+
+ Response 404 (application/json)
174+
175+
+ Body
176+
177+
{
178+
"code": 404,
179+
"message": "There is no list with that ID."
180+
}
181+
182+
131183
# Group Subscribers
132184

133185
Resources related to subscribers.

0 commit comments

Comments
 (0)