ContactService
Methods to retrieve information about contacts and groups. Click here for a free trial.
The following operations are supported. For a formal definition, please review the Service Description.
-
DeleteContacts
Deletes multiple contacts.
Parametersids An array containing the identities of the contacts to delete. -
DeleteGroup
Deletes a group.
Parametersid The identity of the group to delete. includeMembers True if the contacts within the group should also be deleted. - GetContactByQuickName
-
AddContacts
Adds multiple contacts.
Parameterscontacts An array of contacts to add. You can leave the ID fields blank if you want Esendex to generate an identities for the new contacts. Returns
An array of identities assigned to the new contacts. -
GetGroupMembers
Retrieves a list of contact contained within a group.
ParametersgroupID The identity of the group whose contacts you want to retrieve. Returns
An array of contacts contained within the group. -
UpdateGroup
Updates an existing group.
Parametersgroup The group to update. memberIDs The identities of the contacts to include in the group. -
DeleteGroups
Deletes multiple a groups.
Parametersid The identities of the groups to delete. - GetGroupByName
-
GetGroup
Retrieves a contact group from your account.
Parametersid The identity of the contact group you want to retrieve. Returns
The requested group. -
GetGroups
Retrieves a list of groups for your account.
Returns
An array of groups. -
DeleteContact
Deletes a contact.
Parametersid The identity of the contact to delete. -
UpdateContact
Updates an existing contact.
Parameterscontact The contact to update. -
GetContacts
Retrieves a list of contacts for your account.
Returns
An array of contacts. -
AddGroup
Adds a new group.
Parametersgroup The group to add. You can leave the ID field blank if you want Esendex to generate an identity for the new group. memberIDs The identities of the contacts to include in the group. Returns
The identity assigned to the new group. -
GetContact
Retrieves a contact from your account.
Parametersid The identity of the contact you want to retrieve. Returns
The requested contact. -
AddContact
Adds a new contact.
Parameterscontact The contact to add. You can leave the ID field blank if you want Esendex to generate an identity for the new contact. Returns
The identity assigned to the new contact.