Skip to main content
Server path: /clicksend-contacts | Type: Application | PCID required: Yes

Tools


clicksend_contacts_lists_by_list_id_delete

ListsByListIdDelete Parameters:
ParameterTypeRequiredDefaultDescription
list_idintegerYesList ID

clicksend_contacts_lists_by_list_id_get

Get specific contact list Parameters:
ParameterTypeRequiredDefaultDescription
list_idintegerYesList ID

clicksend_contacts_lists_by_list_id_put

Update specific contact list Parameters:
ParameterTypeRequiredDefaultDescription
list_idintegerYesYour list id
list_namestringYesYour list name.

clicksend_contacts_lists_contacts_by_list_id_and_contact_id_delete

Delete a contact Parameters:
ParameterTypeRequiredDefaultDescription
list_idintegerYesList ID
contact_idintegerYesContact ID

clicksend_contacts_lists_contacts_by_list_id_and_contact_id_get

Get a specific contact Parameters:
ParameterTypeRequiredDefaultDescription
list_idintegerYesYour contact list id you want to access.
contact_idintegerYesYour contact id you want to access.

clicksend_contacts_lists_contacts_by_list_id_and_contact_id_put

Update specific contact Parameters:
ParameterTypeRequiredDefaultDescription
list_idintegerYesContact list id
contact_idintegerYesContact ID
address_citystringNoYour nearest city
address_countrystringNoYour current country
address_line_1stringNoYour street address
address_line_2stringNoAddress Line 2
address_postal_codestringNoYour current postcode
address_statestringNoYour current state
custom_1stringNoCustom 1
custom_2stringNoCustom 2
custom_3stringNoCustom 3
custom_4stringNoCustom 4
emailstringNoYour email. Must be provided if no phone number or fax number.
fax_numberstringNoYour fax number. Must be provided if no phone number or email.
first_namestringNoYour first name.
last_namestringNoYour last name
organization_namestringNoYour organisation name
phone_numberstringNoYour phone number in E.164 format. Must be provided if no fax number or email.

clicksend_contacts_lists_contacts_by_list_id_get

Get all contacts in a list Parameters:
ParameterTypeRequiredDefaultDescription
list_idintegerYesContact list ID
pageintegerNoPage number
limitintegerNoNumber of records per page
updated_afterintegerNoGet all contacts updated after a given timestamp.

clicksend_contacts_lists_contacts_by_list_id_post

Create new contact Parameters:
ParameterTypeRequiredDefaultDescription
list_idintegerYesList id
address_citystringNoYour nearest city
address_countrystringNoYour current country
address_line_1stringNoYour street address
address_line_2stringNoAddress Line 2
address_postal_codestringNoYour current postcode
address_statestringNoYour current state
custom_1stringNoCustom 1
custom_2stringNoCustom 2
custom_3stringNoCustom 3
custom_4stringNoCustom 4
emailstringNoYour email. Must be provided if no phone number or fax number.
fax_numberstringNoYour fax number. Must be provided if no phone number or email.
first_namestringNoYour first name.
last_namestringNoYour last name
organization_namestringNoYour organisation name
phone_numberstringNoYour phone number in E.164 format. Must be provided if no fax number or email.

clicksend_contacts_lists_copy_contact_put

Copy contact to another list Parameters:
ParameterTypeRequiredDefaultDescription
from_list_idintegerYesList ID for list that contains contact.
contact_idintegerYesContact ID
to_list_idintegerYesList ID for list you want to copy the contact to.

clicksend_contacts_lists_get

Get all contact lists Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number
limitintegerNoNumber of records per page

clicksend_contacts_lists_import_by_list_id_post

Import contacts to list Parameters:
ParameterTypeRequiredDefaultDescription
list_idintegerYesYour contact list id you want to access.
field_orderstring[]YesOrder of fields in file
file_urlstringYesURL of file to process

clicksend_contacts_lists_post

Create new contact list Parameters:
ParameterTypeRequiredDefaultDescription
list_namestringYesYour list name.

clicksend_contacts_lists_remove_duplicates_by_list_id_put

Remove duplicate contacts Parameters:
ParameterTypeRequiredDefaultDescription
list_idintegerYesYour list id
fieldsobjectYesFrom Email object.

clicksend_contacts_lists_remove_opted_out_contacts_by_list_id_and_opt_out_list_id_put

Remove all opted out contacts Parameters:
ParameterTypeRequiredDefaultDescription
list_idintegerYesYour list id
opt_out_list_idintegerYesYour opt out list id

clicksend_contacts_lists_transfer_contact_put

Transfer contact to another list Parameters:
ParameterTypeRequiredDefaultDescription
from_list_idintegerYesList ID for list that contains contact.
contact_idintegerYesContact ID
to_list_idintegerYesList ID for list you want to transfer contact to.