Resource Definitions:Lists/ID
From API Documentation
The lists/ID resource is an individual distribution list associated with your agent account.
Example URI: http://api.rezora.com/v1/lists/1234
Available methods are:
Contents |
GET
Returns an individual distribution. The distribution list record includes the following fields:
- list_id
- list_name
- list_date
- list_type - possible values: 0, 1 (cannnot delete)
Example Responses
XML Response
<?xml version="1.0" encoding="UTF-8"?> <lists version="1.0"> <list> <list_id>1234</list_id> <list_name>Current Prospects</list_name> <list_date>2010-07-21 16:28:52</list_date> <list_type>0</list_type> </list> </lists>
JSON Response
[ { "list_id":"1234", "list_name":"Current Prospects", "list_date":"2010-07-21 16:28:52", "list_type":"0" } ]
CSV Response
"list_id"|"list_name"|"list_date"|"list_type" "1234"|"Current Prospects"|"2010-07-21 16:28:52"|"0"
PUT
Updates an existing distribution list, and returns a success code. Note the you CANNOT update a Primary Sphere list (list_type = 1). You may include the following fields (required fields marked with a red asterisk (*)):
- list_name * (must be unique)
Example Request Data
XML Request
<?xml version="1.0" encoding="UTF-8"?> <data> <list_name>Hot Leads</list_name> </data>
JSON Request
{ "data":{ "list_name":"Hot Leads" } }
TEXT Request
list_name=Hot+Leads
Example Response Data
XML Response
<?xml version="1.0" encoding="UTF-8"?> <lists version="1.0"> <list> <status>200</status> </list> </lists>
JSON Response
[ { "status":"200" } ]
CSV Response
"status" "200"
DELETE
Permanently removes an individual distribution list, and returns a success code. Note the you CANNOT delete a Primary Sphere list (list_type = 1).
Example Response Data
XML Response
<?xml version="1.0" encoding="UTF-8"?> <lists version="1.0"> <list> <status>200</status> </list> </lists>
JSON Response
[ { "status":"200" } ]
CSV Response
"status" "200"