Sub List API Calls
There are currently 6 different API calls for managing and viewing your sub lists. Listed below are details on each, including optional parameters and defaults.
API Endpoint
https://api.robly.com/Note
As with all API methods, the api_key and api_id paramaters are required for all methods below.
View Sub Lists
/api/v1/sub_lists/show?api_key=api_key&api_id=api_id [GET]Optional Params: include_all [true, false]
example
Example API call (GET)
https://api.robly.com/api/v1/sub_lists/show?api_id=8ec55ecb23a8facac6280e84be513fee&api_key=eb81bd1f0ad28b0a
JSON Output:
[{"sub_list":{"id":17269,"name":"List B","position":2,"created_at":"2014-06-26T18:42:33Z","updated_at":"2014-06-26T22:16:08Z"}},{"sub_list":{"id":17276,"name":"List C","position":3,"created_at":"2014-06-26T18:42:33Z","updated_at":"2014-06-26T22:16:08Z"}},{"sub_list":{"id":17277,"name":"List D","position":4,"created_at":"2014-06-26T18:42:33Z","updated_at":"2014-06-26T22:16:09Z"}}]
Include non-public sub lists
https://api.robly.com/api/v1/sub_lists/show?api_id=8ec55ecb23a8facac6280e84be513fee&api_key=eb81bd1f0ad28b0a&include_all=true
JSON Output:
[{"sub_list":{"id":15845,"name":"List A","position":1,"created_at":"2014-06-19T18:03:33Z","updated_at":"2014-06-26T22:16:08Z"}},{"sub_list":{"id":17269,"name":"List B","position":2,"created_at":"2014-06-26T18:42:33Z","updated_at":"2014-06-26T22:16:08Z"}},{"sub_list":{"id":17276,"name":"List C","position":3,"created_at":"2014-06-26T18:42:33Z","updated_at":"2014-06-26T22:16:08Z"}},{"sub_list":{"id":17277,"name":"List D","position":4,"created_at":"2014-06-26T18:42:33Z","updated_at":"2014-06-26T22:16:09Z"}}]
Rename a Sub List
/api/v1/sub_lists/rename_sub_list?api_key=api_key&api_id=api_id&sub_list_id=sub list id&sub_list_name=new sub list name [POST]Required Params: sub_list_id, sub_list_name
example
Example API call (POST)
https://api.robly.com/api/v1/sub_lists/rename_sub_list?api_id=8ec55ecb23a8facac6280e84be513fee&api_key=eb81bd1f0ad28b0a&sub_list_id=93823&sub_list_name=East Coast Members
JSON Response:
{"successful":true,"message":"Sub List renamed"}
Create a New Sub List
/api/v1/sub_lists/add_sub_list?api_key=api_key&api_id=api_id&sub_list_name=new sub list name [POST]Required Params: sub_list_name
example
Example API call (POST)
https://api.robly.com/api/v1/sub_lists/add_sub_list?api_id=8ec55ecb23a8facac6280e84be513fee&api_key=eb81bd1f0ad28b0a&sub_list_name=WestCoast Members
JSON Response:
{"successful":true,"message":"Sub List created"}
Delete a Sub List
This will delete the sub list and remove all associated contacts from the list.
/api/v1/sub_lists/delete_sub_list?api_key=api_key&api_id=api_id&sub_list_id=sub list id [POST]Required Params: sub_list_id
example
Example API call (POST)
https://api.robly.com/api/v1/sub_lists/delete_sub_list?api_id=8ec55ecb23a8facac6280e84be513fee&api_key=eb81bd1f0ad28b0a&sub_list_id=74837
JSON Response:
{"successful":true,"message":"Sub List deleted"}
Clear Contacts from a Sub List
This will leave the sub list but remove all contacts from the list.
/api/v1/sub_lists/clear_sub_list?api_key=api_key&api_id=api_id&sub_list_id=sub list id [POST]Required Params: sub_list_id
example
Example API call (POST)
https://api.robly.com/api/v1/sub_lists/clear_sub_list?api_id=8ec55ecb23a8facac6280e84be513fee&api_key=eb81bd1f0ad28b0a&sub_list_id=24817
JSON Response:
{"successful":true,"message":"Sub List cleared"}
Auto Sort Your Sub Lists
This will alphabetically sort all of your sub lists based on the names of the lists.
/api/v1/sub_lists/autosort?api_key=api_key&api_id=api_id [POST]example
Example API call (POST)
https://api.robly.com/api/v1/sub_lists/autosort?api_id=8ec55ecb23a8facac6280e84be513fee&api_key=eb81bd1f0ad28b0a
JSON Response:
{"successful":true,"message":"Sub Lists auto sorted by name"}