Lists

A List is a collection of Pinpoints.

GET /v3.0/lists

List all lists.

POST /v3.0/lists

Create a new list.

Request JSON Object

  • description (string) – HTML description.
  • name (string) – Name of the list.

Status Codes

GET /v3.0/lists/:id

Return the given list.

PUT /v3.0/lists/:id

Update the given list.

  • Request JSON Object
    • description (string) – HTML description.
    • name (string) – Name of the list.

DELETE /v3.0/lists/:id

Delete the given list.

POST /v3.0/lists/:id/pinpoints

Add pinpoints to a list.

Example request:

POST /v3.0/lists/1234/pinpoints HTTP/1.1
Authorization: Bearer 0a1b2c3d4e5f
Content-Type: application/json
[
{"id": 1},
{"id": 2},
{"id": 3}
]

Example response

HTTP/1.1 200 OK
Content-Type: application/json
{
"errors": [],
"total": 3
}

DELETE /v3.0/lists/:id/pinpoints

Remove pinpoints from a list.

Example request:

DELETE /v3.0/lists/1234/pinpoints HTTP/1.1
Authorization: Bearer 0a1b2c3d4e5f
Content-Type: application/json
[
{"id": 1},
{"id": 2},
{"id": 3}
]

Example response

HTTP/1.1 200 OK
Content-Type: application/json
{
"errors": [],
"total": 3
}