ContactList Object v5

 Help Us Improve Our API Documentation!

We're beginning an initiative to improve our API docs. We would love your help!

Please take this quick 4-question survey to help us out! Thank you in advance for your time!

The following API calls are currently available for the ContactList object:

GET LIST - Get a list of all of your contact lists.

https://restapi.surveygizmo.com/v5/contactlist

Note: Get requests will cache for 60 seconds. If you make repeated API get requests that are identical, the return will be cached and will thus return identical results.
ParametersExampleRequired
Authentication Credentialsapi_token=5D685159B6964FB69B044D3E7D2676D1True
pagepage=3False
resultsperpageresultsperpage=100False
Response Example (.debug format):

Array
(
 [result_ok] => 1
 [page] => 1
 [results_per_page] => 50
 [0] => Array
 (
 [id] => 1
 [list_name] => New Customers
 [date_modifed] => 2012-10-23 10:46:09
 [date_created] => 2012-10-23 10:01:00
 [user_id_created] => 183830
 [user_id_modified] => 0
 )

 [1] => Array
 (
 [id] => 3
 [list_name] => My New List
 [date_modifed] => 2012-10-23 14:50:13
 [date_created] => 2012-10-23 14:01:00
 [user_id_created] => 183830
 [user_id_modified] => 0
 )

 [2] => Array
 (
 [id] => 7
 [list_name] => Existing Customers
 [date_modifed] => 2013-02-07 17:58:31
 [date_created] => 2013-02-07 17:58:31
 [user_id_created] => 183830
 [user_id_modified] => 0
 )

 [3] => Array
 (
 [id] => 13
 [list_name] => Pet Sitting Customers
 [date_modifed] => 2013-02-18 12:19:27
 [date_created] => 2013-02-18 12:00:00
 [user_id_created] => 183830
 [user_id_modified] => 183830
 )

)
Back to the Top

GET CONTACTLIST - Get information about a specific contact list.

https://restapi.surveygizmo.com/v5/contactlist/16

Note: Get requests will cache for 60 seconds. If you make repeated API get requests that are identical, the return will be cached and will thus return identical results.
ParametersExampleRequired
Authentication Credentialsapi_token=5D685159B6964FB69B044D3E7D2676D1True
pagepage=3False
resultsperpageresultsperpage=100False
Response Example (.debug format):

Array
(
 [result_ok] => 1
 [data] => Array
 (
 [id] => 100139484
 [list_name] => My New List 
 [date_modified] => 2015-08-04 17:06:59
 [date_created] => 2015-08-04 16:00:00
 [user_id_created] => 123456 
 [user_id_modified] => 
 )

)
Back to the Top

CREATE CONTACTLIST - Create a new contact list.

https://restapi.surveygizmo.com/v5/contactlist?_method=PUT&list_name=New Contact List

ParametersExampleRequired
Authentication Credentialsapi_token=5D685159B6964FB69B044D3E7D2676D1True
list_nameNew Contact ListTrue
Response Example (.debug format):

Array
(
 [result_ok] => 1
 [data] => Array
 (
 [id] => 1
 [list_name] => New Customers
 [date_modifed] => 2012-10-23 10:46:09
 [date_created] => 2012-10-23 10:01:00
 [user_id_created] => 183830
 [user_id_modified] => 0
 )
)

CHANGE/UPDATE/ADD TO CONTACTLIST - Update your contact list.

https://restapi.surveygizmo.com/v5/contactlist/16?_method=POST&list_name=NewListName

ParametersExampleRequired
Authentication Credentialsapi_token=5D685159B6964FB69B044D3E7D2676D1True
list_nameNew Contact ListTrue
Response Example (.debug format):

Array
(
 [result_ok] => 1
 [data] => Array
 (
 [id] => 100271266
 [list_name] => New Contact List
 [date_modified] => 2016-05-31 12:06:30
 [date_created] => 2013-03-29 10:01:00
 [user_id_created] => 123456
 [user_id_modified] => 123456
 )
)

DELETE CONTACT LIST - Delete a contact list.

https://restapi.surveygizmo.com/v5/contactlist/3?_method=DELETE

ParametersExampleRequired
Authentication Credentialsapi_token=5D685159B6964FB69B044D3E7D2676D1True
Response Example (.debug format):

Array
(
 [result_ok] => 1
)
Back to the Top