< Back to home

Profile

Profiles are user-defined data structures that can contain many different types of data. There are two types of Profile - Single and Multiple. The Single profile type can contain any number of fields, but only a single value for each field (i.e. 1 row in a table). The Multiple profile type can contain many entries (i.e. many rows in a table).

Properties

Name Type Description Required
ContactId Int32 This is the Contact Id of the associated Contact, or the Id of the associated item if this is not a Contact profile. This is required when adding or updating an existing Contact or item's profile data. No
ProfileSectionTitle String The name/title of the Profile/Profile Section. Yes
ProfileSectionFormat ProfileSectionFormat The format of the Profile/Profile Section. Single is 1 and Multiple is 2. Yes
ProfileArea ProfileArea The area that this Profile Section belongs to. Defaults to Contacts. Contacts is 1, Groups is 2, Enquiries is 3, Event Delegates is 4, Events is 5, Advice & Representation is 6, Volunteers is 7, Contact Campaign Appointments is 8, Fund is 9, Event Bookings is 10, and Event Sub Events is 11 No
Rows List<ProfileRow> The actual Profile data. A Single Profile will only consist of a single row; Multiple Profiles may have more. No

Endpoints

Url Actions Description
api/profile/{profileArea}/{profileSectionTitle}/{id} GET Returns the specified Profile Details for an item.
api/profile/{profileSectionTitle}/{id} GET Returns the specified Profile Details for a contact.
api/profile POST Adds or updates the specified Profile Details.