ContactListContact Sub-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 contacts in a specified contact list.

https://restapi.surveygizmo.com/v5/contactlist/31/contactlistcontact
ParametersExampleRequired
Authentication Credentialsapi_token=5D685159B6964FB69B044D3E7D2676D1True
pagepage=3False
resultsperpageresultsperpage=100False

Response Example (.debug format):


Array
(
 [result_ok] => 1
 [page] => 1
 [results_per_page] => 50
 [data] => Array
 (
 [0] => Array
 (
 [id] => 100039752
 [email_address] => jon.doe@sgizmo.com
 [status] => Active
 [first_name] => jon
 [last_name] => doe
 [organization] => 
 [division] => 
 [department] => 
 [group] => 
 [role] => 
 [is_manager] => False
 [team] => 
 [home_phone] => 
 [fax_phone] => 
 [business_phone] => 
 [mailing_address] => 
 [mailing_address2] => 
 [mailing_address_city] => 
 [mailing_address_state] => 
 [mailing_address_postal] => 
 [mailing_address_country] => 
 [title] => 
 [url] => 
 )

 [1] => Array
 (
 [id] => 100039747
 [email_address] => jane.doe@sgizmo.com
 [status] => Active
 [first_name] => jane
 [last_name] => doe
 [organization] => 
 [division] => 
 [department] => 
 [group] => 
 [role] => 
 [is_manager] => 
 [team] => 
 [home_phone] => 
 [fax_phone] => 
 [business_phone] => 
 [mailing_address] => 
 [mailing_address2] => 
 [mailing_address_city] => 
 [mailing_address_state] => 
 [mailing_address_postal] => 
 [mailing_address_country] => 
 [title] => 
 [url] => 
 )

)

Back to the Top

GET CONTACTLISTCONTACT - Get information about a specific contact within a specific list.

https://restapi.surveygizmo.com/v5/contactlist/31/contactlistcontact/100039752
ParametersExampleRequired
Authentication Credentialsapi_token=5D685159B6964FB69B044D3E7D2676D1True
pagepage=3False
resultsperpageresultsperpage=100False

Response Example (.debug format):


Array
(
 [result_ok] => 1
 [data] => Array
 (
 [id] => 100039752
 [email_address] => jon.doe@sgizmo.com
 [status] => Active
 [first_name] => jon
 [last_name] => doe
 [organization] => 
 [division] => 
 [department] => 
 [group] => 
 [role] => 
 [is_manager] => False
 [team] => 
 [home_phone] => 
 [fax_phone] => 
 [business_phone] => 
 [mailing_address] => 
 [mailing_address2] => 
 [mailing_address_city] => 
 [mailing_address_state] => 
 [mailing_address_postal] => 
 [mailing_address_country] => 
 [title] => 
 [url] => 
 )

)

Back to the Top

CREATE CONTACTLISTCONTACT - Create a new contact inside of a specific contact list.

https://restapi.surveygizmo.com/v5/contactlist/31/contactlistcontact?_method=PUT
ParametersExampleRequired
Authentication Credentialsapi_token=5D685159B6964FB69B044D3E7D2676D1True
email_addressjon.doe@sgizmo.comTrue
statusActive, InactiveFalse
first_nameJonFalse
last_nameDoeFalse
organizationSurveyGizmoFalse
divisionNorth AmericaFalse
departmentSalesFalse
groupInside SalesFalse
roleTeam LeadFalse
is_managerFalseFalse
teamGreen TeamFalse
home_phone123-456-7890False
fax_phone123-456-7890False
business_phone123-456-7890False
mailing_address123 Main StFalse
mailing_address2Suite 100False
mailing_address_cityAnycityFalse
mailing_address_stateCOFalse
mailing_address_postal12345False
mailing_address_countryUSFalse
titleTitleFalse
urlwww.webiste.comFalse
custom[ID]†custom[15]=valueFalse

†These are the custom fields that are available as part of the account email lists. Learn how to get the ID number for custom fields.

Response Example (.debug format):


Array
(
 [result_ok] => 1
 [data] => Array
 (
 [id] => 100012345
 [email_address] => jon.doe@sgizmo.com
 [status] => Active
 [first_name] => Jon
 [last_name] => Doe
 [organization] =>
 [division] =>
 [department] =>
 [group] =>
 [role] =>
 [is_manager] => False
 [team] =>
 [home_phone] => 
 [fax_phone] =>
 [business_phone] =>
 [mailing_address] =>
 [mailing_address2] =>
 [mailing_address_city] =>
 [mailing_address_state] =>
 [mailing_address_postal] =>
 [mailing_address_country] =>
 [title] =>
 [url] =>
 )
)

Back to the Top

CHANGE/UPDATE CONTACTLISTCONTACT - Update a contact within a specific contact list.

https://restapi.surveygizmo.com/v5/contactlist/31/contactlistcontact?_method=POST&email_address=email
ParametersExampleRequired
Authentication Credentialsapi_token=5D685159B6964FB69B044D3E7D2676D1True
email_addressjon.doe@sgizmo.comTrue
statusActive, InactiveFalse
first_nameJonFalse
last_nameDoeFalse
organizationSurveyGizmoFalse
divisionNorth AmericaFalse
departmentSalesFalse
groupInside SalesFalse
roleTeam LeadFalse
is_managerFalseFalse
teamGreen TeamFalse
home_phone123-456-7890False
fax_phone123-456-7890False
business_phone123-456-7890False
mailing_address123 Main StFalse
mailing_address2Suite 100False
mailing_address_cityAnycityFalse
mailing_address_stateCOFalse
mailing_address_postal12345False
mailing_address_countryUSFalse
titleTitleFalse
urlwww.webiste.comFalse
custom[ID]†custom[15]=valueFalse

†These are the custom fields that are available as part of the account email lists. Learn how to get the ID number for custom fields.

Response Example (.debug format):


Array
(
 [result_ok] => 1
 [data] => Array
 (
 [id] => 100039767
 [email_address] => jon.doe@sgizmo.com
 [status] => Active
 [first_name] => Jon
 [last_name] => 
 [organization] => 
 [division] => 
 [department] => 
 [group] => 
 [role] =>
 [is_manager] => False
 [team] => 
 [home_phone] => 
 [fax_phone] => 
 [business_phone] => 
 [mailing_address] => 
 [mailing_address2] => 
 [mailing_address_city] => 
 [mailing_address_state] => 
 [mailing_address_postal] => 
 [mailing_address_country] => 
 [title] => 
 [url] => 
 )

)

DELETE CONTACTLISTCONTACT - Delete a specific contact from a contact list.

https://restapi.surveygizmo.com/v5/contactlist/31/contactlistcontact/100012345?_method=DELETE
ParametersExampleRequired
Authentication Credentialsapi_token=5D685159B6964FB69B044D3E7D2676D1True

Response Example (.debug format):


Array
(
 [result_ok] => 1
)

Back to the Top