Home → API Documentation → User Dashboard → api/UserActions
8.2. api/UserActions
This API call allows you to submit updates, such as to contact information and company information, depending on the call type (calltype).
The call requires you to pass the uid of the user logged in, the calltype and updatevalues.
Call Types
• UserProfileUpdate – Update contact information.
• UserCompanyUpdate – Update company information.
• UserUpdate – Update whether a user has left the primary record.
• UserAdded – Add a new user to the primary record.
• UserOfferUpdate – Update/submit user offer.
• UserEventUpdate – Update/submit user event.
• UserNewsUpdate – Update/submit user news item.
• UserVacancyUpdate – Update/submit user vacancy
• UserConsent
UserProfileUpdate
This call will allow you to update contact information, given the uid that is provided.
The following fields of information can be added to the JSONString stringified array to be passed in the updatevalues field.
Parameters To Submit
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” |
| SocialMedia | Stringified array of social media information with "SocialMedia" and "SocialMediaURL" properties. Available social media options will return as part of api/User. | String |
| 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.
UserCompanyUpdate
This call will allow you to update the primary record information, given the uid that is provided.
The following fields of information can be added to the JSONString stringified array to be passed in the updatevalues field. Please note that we only allow the update to take place if the user (uid) is a main contact or web admin.
Parameters To Submit
If the parameters below highlighted with “*” are submitted, they cannot be submitted as blank values.
| Parameter | Parameter Help | Parameter Data Type |
| Company* | Primary record’s name. | String – Max 250 chars |
| CompanyTelCountry* | Primary record’s telephone country code. | String – Max 5 chars |
| CompanyTel* | Primary record’s telephone number. | String – Max 30 chars |
| CompanyFax | Primary record’s fax number. | String – Max 20 chars |
| CompanyEmail* | Primary record’s email address. | String – Max 250 chars |
| CompanyWeb* | Primary record’s website URL. Should prefix with “http://” or “https://”. | String – Max 250 chars |
| Category* | Primary record’s business category. | String – Provide ListValue from api/PortalList “BusinessCategory” |
| BusinessDescription | Primary record’s business description that is used in the directory. | String |
| Address1* | First line of the primary record’s main address. | String – Max 75 chars |
| Address2 | Second line of the primary record’s main address. | String – Max 75 chars |
| Address3 | Third line of the primary record’s main address. | String – Max 75 chars |
| Address4* | Fourth line of the primary record’s main address. | String – Max 75 chars |
| County* | County where the primary record resides. | String – Provide ListValue from api/PortalList “County” |
| Postcode* | Postcode of the primary record’s main address. | String – Max 15 chars |
| Country* | Country where the primary record resides. | String – Provide ListValue from api/PortalList “Country” |
| SocialMedia | Stringified array of social media information with "SocialMedia" and "SocialMediaURL" properties. Available social media options will return as part of api/User. | String |
This call returns a Boolean of True if successful.
UserAdded
This call will allow a contact to add a new contact to the primary record.
Parameters To Submit
If the parameters below highlighted with “*” are submitted, they cannot be submitted as blank values.
| Parameter | Parameter Help | Parameter Data Type |
| FirstName* | Contact’s first name to be added. | String – Max 100 chars |
| LastName* | Contact’s last name to be added. | String – Max 100 chars |
| EmailAddress* | Contact’s email address to be added. | String – Max 200 chars |
| JobTitle | Contact’s job title to be added. | String – Max 200 chars |
This call returns a JSONString if successful. Within the JSONString is ContactAdded containing the new contact's uid, First Name, Last Name and Email Address.
UserUpdate
This call will allow a main contact or web admin to update contact records to say the contact has Left.
Parameters To Submit
All parameters are required and cannot be empty.
| Parameter | Parameter Help | Parameter Data Type |
| uid | Contact’s uid to be updated. | String – Max 50 chars |
| ContactLeft | Whether the client has left or not (true/false). By default, we do not return users who have been marked as left. This can be changed if you wish for the ability to unmark contacts who have returned. | Boolean |
This call returns a Boolean of True if successful.
UserOfferUpdate
This call will allow a main contact or web admin to update/submit an offer.
Parameters To Submit
If the parameters below highlighted with “*” are submitted, they cannot be submitted as blank values.
| Parameter | Parameter Help | Parameter Data Type |
| oid* | "AddNew" if a new offer or oid of offer being updated. | String – Max 50 chars |
| Category* | The category of the offer. | String – Provide ListValue from api/PortalList “OfferCategory” |
| ShortDescription* | The title of the offer. | String – Max 150 chars |
| LongDescription | The main body of text of the offer. | String |
| StartDate* | Then the offer should start displaying on the website. | Datetime - YYYY-MM-DD hh:mm:ss.mmm |
| EndDate* | Then the offer should stop displaying on the website. | Datetime - YYYY-MM-DD hh:mm:ss.mmm |
| OfferCode | User can submit a code that needs to be used to redeem the offer. | String – Max 50 chars |
| Removed* | If the offer has been deleted. | Boolean |
This call returns a Boolean of True if successful.
UserEventUpdate
This call will allow a main contact or web admin to update/submit an event.
Parameters To Submit
If the parameters below highlighted with “*” are submitted, they cannot be submitted as blank values.
| Parameter | Parameter Help | Parameter Data Type |
| mid* | "AddNew" if a new event or mid of event being updated. | String – Max 50 chars |
| Category* | The category of the event. | String – Provide ListValue from api/PortalList “EventCategory” |
| ShortDescription* | The title of the event. | String – Max 150 chars |
| LongDescription | The main body of text of the event. | String |
| StartDate* | The date the event should start displaying on the website. | Datetime - YYYY-MM-DD hh:mm:ss.mmm |
| StartTime* | The time the event should start displaying on the website. | Datetime - YYYY-MM-DD hh:mm:ss.mmm |
| EndDate* | The date the event should stop displaying on the website. | Datetime - YYYY-MM-DD hh:mm:ss.mmm |
| EndTime* | The time the event should stop displaying on the website. | Datetime - YYYY-MM-DD hh:mm:ss.mmm |
| EventLocation | The location of the event. | String |
| EventCode | User can submit a code that needs to be used to redeem the event or for them to track how the booking came through. | String – Max 50 chars |
| Removed* | If the offer has been deleted. | Boolean |
This call returns a Boolean of True if successful.
UserNewsUpdate
This call will allow a main contact or web admin to update/submit a news item.
Parameters To Submit
If the parameters below highlighted with “*” are submitted, they cannot be submitted as blank values.
| Parameter | Parameter Help | Parameter Data Type |
| nid* | "AddNew" if a new news item or nid of the news item being updated. | String – Max 50 chars |
| Category* | The category of the news item. | String – Provide ListValue from api/PortalList “NewsCategory” |
| ShortDescription* | The title of the news item. | String – Max 150 chars |
| LongDescription | The main body of text of the news item. | String |
| StartDate* | The date the news item should start displaying on the website. | Datetime - YYYY-MM-DD hh:mm:ss.mmm |
| EndDate* | The date the news item should stop displaying on the website. | Datetime - YYYY-MM-DD hh:mm:ss.mmm |
| Removed* | If the news item has been deleted. | Boolean |
This call returns a Boolean of True if successful.
UserVacancyUpdate
This call will allow a main contact or web admin to update/submit a vacancy.
Parameters To Submit
If the parameters below highlighted with “*” are submitted, they cannot be submitted as blank values.
| Parameter | Parameter Help | Parameter Data Type |
| vid* | "AddNew" if a new vacancy or vid of the vacancy being updated. | String – Max 50 chars |
| Category* | The category of the vacancy. | String – Provide ListValue from api/PortalList “VacancyCategory” |
| ShortDescription* | The title of the vacancy. | String – Max 150 chars |
| LongDescription | The main body of text of the vacancy. | String |
| StartDate* | The date the vacancy should start displaying on the website. | Datetime - YYYY-MM-DD hh:mm:ss.mmm |
| EndDate* | The date the vacancy should stop displaying on the website. | Datetime - YYYY-MM-DD hh:mm:ss.mmm |
| Removed* | If the vacancy has been deleted. | Boolean |
This call returns a Boolean of True if successful.
UserConsent
This call allows storage of the exact consent text the user is agreeing to. Should be performed on a yearly (365-day) basis.
Property is normally returned via users login, as to whether consent agreement is currently required.
Parameters To Submit
All parameters are required and cannot be empty.
| Parameter | Parameter Help | Parameter Data Type |
| ConsentReceived | Whether the user has agreed to the clients terms and conditions. (true/false) | Boolean |
| ConsentText | Full consent/terms and conditions text being agreed to. This is stored within the CRM and dated on when consented. | String |
This call returns a Boolean of True if successful.