NGngpvan

/people/{vanId}/names

Changed on
patch/people/{vanId}/names

Request

  • Base URL
    https://api.securevan.com/v4
  • URL
    https://api.securevan.com/v4/people/{vanId}/names
  • Auth
    HTTP basic

Path parameters

vanIdstring required

Unique person identifier available in the current context

Request body

titlestring

Optional; an honorific

firstNamestring

Optional; a person’s first name

middleNamestring

Optional; a person’s middle name

lastNamestring

Optional; a person’s last name

suffixstring

Optional; part of name following last name, e.g. "Jr."

professionalSuffixstring

Optional; a person's professional suffix, e.g. "M.D."

nicknamestring

Optional; a person's preferred informal name

salutationstring

Optional; preferred greeting for correspondence; defaults to a person's firstName

additionalSalutationstring

Optional; additional preferred greeting for correspondence; defaults to organizationContactCommonName for organizations

formalSalutationstring

Optional; preferred formal greeting for correspondence; defaults to title and lastName for people or "Friends" for organizations

envelopeNamestring

Optional; preferred name to use for mailings; defaults to the person's full name, including their middle initial, or organizationContactCommonName depending on the contact type

formalEnvelopeNamestring

Optional; preferred formal name to use for mailings; defaults to the person's full name, including their middle initial, title, and suffix, or organizationContactOfficialName depending on the contact type

additionalEnvelopeNamestring

Optional; additional preferred name to use for mailings

pronounsstring

Optional; a person's pronouns

organizationContactCommonNamestring

Optional; an organization's common name

organizationContactOfficialNamestring

Optional; an organization's official name

Response

200

vanIdinteger
firstNamestring
lastNamestring
middleNamestring
suffixstring
titlestring
sourceFileTitleunknown
sourceFileFirstNameunknown
sourceFileMiddleNameunknown
sourceFileLastNameunknown
sourceFileSuffixunknown
contactModestring
organizationContactCommonNameunknown
organizationContactOfficialNameunknown
salutationstring
formalSalutationstring
additionalSalutationunknown
envelopeNamestring
formalEnvelopeNamestring
additionalEnvelopeNameunknown
contactMethodPreferenceCodeunknown
nicknamestring
websiteunknown
professionalSuffixstring
partyunknown
employerunknown
occupationunknown
sexunknown
dateOfBirthunknown
selfReportedRaceunknown
selfReportedEthnicityunknown
selfReportedRacesunknown
selfReportedEthnicitiesunknown
selfReportedGendersunknown
selfReportedSexualOrientationsunknown
selfReportedLanguagePreferenceunknown
emailsunknown
phonesunknown
addressesunknown
recordedAddressesunknown
identifiersunknown
codesunknown
customFieldsunknown
primaryCustomFieldunknown
contributionSummaryunknown
suppressionsunknown
caseworkCasesunknown
caseworkIssuesunknown
caseworkStoriesunknown
notesunknown
scoresunknown
customPropertiesunknown
electionRecordsunknown
membershipStatusunknown
organizationRolesunknown
districtsunknown
surveyQuestionResponsesunknown
finderNumberunknown
biographyImageUrlunknown
primaryContactunknown

Example response

{
  "vanId": 12345678,
  "firstName": "Steven",
  "lastName": "Brooks",
  "middleName": "Allen",
  "suffix": "II",
  "title": "Mr.",
  "contactMode": "Person",
  "salutation": "Steven",
  "formalSalutation": "Mr. Brooks",
  "pronouns": {
    "pronounId": 11,
    "pronounName": "He/Him/His"
  },
  "envelopeName": "Steven A. Brooks",
  "formalEnvelopeName": "Mr. Steven A. Brooks, II",
  "nickname": "Steve",
  "professionalSuffix": "M.D."
}

Changes