The following sections detail the supporter details, validation rules, and what is required when adding or updating a supporter
Supporter Census Object
|supporterId||Unique id of the supporter||36 character UUID||required for Update and Delete|
|title||Title of the supporter||36 characters||no|
|firstName||Name of the supporter||36 characters||no|
|middleName||Middle name of the supporter||36 characters||no|
|lastName||Last name of the supporter||100 characters||no|
|suffix||Suffix of the supporter||16 characters||no|
|dateOfBirth||Date of birth of the supporter||ISO_8601 formatted String with a GMT timezone||no|
|gender||Gender of the support||
Must be one of
|externalSystemId||Caller provided Id||100 characters||no|
|createdDate||Date the supporter was created in Salsa Engage||ISO_8601 formatted String with a GMT timezone||not updateable|
|lastModifiedDate||Date the supporter was last modified in Salsa Engage||ISO_8601 formatted String with a GMT timezone||not updateable|
|address||The address of the supporter||See Address Object||no|
|contacts||Various contacts of the supporter||List of contacts. See Contacts Object||
Yes - email is a required contact.
Contacts are limited to 1 per type
|customFieldValues||Various custom fields of the supporter||List of custom fields. See Custom Field Object||no|
|result||Constant to indicate state of the operation on the supporter.
The value provided is contextual to the operation requested
(E.g. delete, update, search).
Will be one of:
|addressLine1||Line 1 of the address||128 charachters||no|
|addressLine2||Line 2 of the address||128 charachters||no|
|state||State||2 character state code||no|
|postalCode||Postal Code||10 characters||no|
|country||Country||2 character country code||no|
|federalDistrict||US Federal House District||16 characters||not updateable|
|stateHouseDistrict||US State House District||16 characters||not updateable|
|stateSenateDistrict||US State Senate District||16 characters||not updateable|
|countyDistrict||US County District||16 characters||not updateable|
|municipalityDistrict||US Municipality District||32 characters||not updateable|
|lattitude||Lattitude||Floating point number||not updateable|
|longitude||Longitude||Floating point number||not updateable|
One of each type of contact can be managed with the supporter.
An email contact is required for a supporter
|type||The type of contact||
Must be one of
|value||Value for the contact||Must be a valid email address for an email contact||yes|
|status||Status of the contact||
Valid only for email contacts - ignored for others
These status codes relate to the experience of sending
If not provided for new supporters the email status
The above applies to email contacts only.
Salsa Engage provides the ability for you to configure custom fields. The API can then be used for the purpose of syncing data into those custom fields and/or acquire the data currently set.
The API does not provide the ability to create the custom field directly, custom fields must first be created within Salsa Engage. Once created, the name(or id) and the value of the field specific to a supporter can be included in supporter add or update calls.
|fieldId||Unique ID of the custom field||36 character UUID||no - can be provided in lieu of the name
when setting the value of a custom field for
a specific supporter
|name||Name of the custom field||64 characters||no - can be provided in lieu of the fieldId. If the field
id is not provided, then the system will attempt to identify the custom
field by name.
|value||Value of the custom field||This is dependent on how the custom field was configured within Salsa Engage. Salsa Engage provides a robust set of rules that can be configured to specify type, max length, range, etc. Provided values will be validated against these rules during an update, and an appropriate validation message will be returned if the value doesn't meet the criteria of the rules or if the custom field could not be found by name or id||yes|