HomeEvent PluginAPI Callsapi/PluginContactInfoUpdate - Update Contact Information

1.4. api/PluginContactInfoUpdate - Update Contact Information

This API call allows you to submit updates to contact information.

The call requires you to pass the uid of the contact and updatevalues.

 


 

Parameters To Submit

Parameter Parameter Help Parameter Data Type
uid The contact's uid. String – Max 50 chars
updatevalues JSONString stringified array of parameters. Review parameters below. String
API Key    

 


 

updatevalues

If the parameters below highlighted with “*” are submitted, they cannot be submitted as blank values. County and Country can be submitted as None.

Parameter Parameter Help Parameter Data Type
Title Contact’s title. String – Max 20 chars
FirstName* Contact’s first name. String – Max 100 chars
LastName* Contact’s last name. String – Max 100 chars
KnownAs* What the contact is known by. String – Max 100 chars
EmailAddress* Contact’s email address. String – Max 200 chars
JobTitle* Contact’s job title. String – Max 200 chars
MobileCountry* Contact’s mobile country code. String – Max 5 chars
Mobile* Contact’s mobile number. String – Max 25 chars
TelCountry* Contact’s telephone country code. String – Max 5 chars
Tel* Contact’s telephone number. String – Max 30 chars
TelExt* Contact’s telephone extension number. String – Max 10 chars
Address1 First line of the contact’s address if the contact has a personal address different to main Company/Organisation address. String – Max 75 chars
Address2 Second line of the contact’s address if the contact has a personal address different to main Company/Organisation address. String – Max 75 chars
Address3 Third line of the contact’s address if the contact has a personal address different to main Company/Organisation address. String – Max 75 chars
Address4 Fourth line of the contact’s address if the contact has a personal address different to main Company/Organisation address. String – Max 75 chars
County* County the contact resides if the contact has a personal address different to the main Company/Organisation address. (See api/PortalList with list “County” for available options) String – Provide ListValue from api/PortalList “County”
Postcode Postcode of contact’s address if the contact has a personal address different to the main Company/Organisation address. String – Max 15 chars
Country* County the contact resides if the contact has a personal address different to the main Company/Organisation address. (See api/PortalList with list “Country” for available options) String – Provide ListValue from api/PortalList “Country”
MarketingPreferences Stringified array of marketing interest preferences with "Marketing", "Email", "Mail" and "Tel" properties where "Email", "Mail" and "Tel" are true or false. String

 

This call returns a Boolean of True if successful.

This page was: Helpful | Not Helpful