/people/{vanId}/names

patch

https://api.securevan.com/v4/people/{vanId}/names

Path Params

vanId

string

required

Defaults to 12345678

Unique person identifier available in the current context

Body Params

title

string

Optional; an honorific

firstName

string

Optional; a person’s first name

middleName

string

Optional; a person’s middle name

lastName

string

Optional; a person’s last name

suffix

string

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

professionalSuffix

string

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

nickname

string

Optional; a person's preferred informal name

salutation

string

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

additionalSalutation

string

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

formalSalutation

string

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

envelopeName

string

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

formalEnvelopeName

string

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

additionalEnvelopeName

string

Optional; additional preferred name to use for mailings

pronouns

string

Optional; a person's pronouns

organizationContactCommonName

string

Optional; an organization's common name

organizationContactOfficialName

string

Optional; an organization's official name

Responses

Language

Credentials

Basic

base64

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400

404404