Update User Demographics

Partially update user info via the Junction API. Requires authentication with your team API key.

PATCH /v2/user/{user_id}/info

cURL

curl --request PATCH \
     --url {{BASE_URL}}/v2/user/{user_id}/info \
     --header 'Accept: application/json' \
     --header 'x-vital-api-key: <API_KEY>' \
     --header 'Content-Type: application/json' \
     --data '
{
  "first_name": "John",
  "last_name": "Doe", 
  "email": "[e-mail]", 
  "phone_number":"[phone]",
  "gender": "Male", 
  "dob": "1999-01-01", 
  "address": {
	  "first_line": "Some Street", 
	  "second_line": null,
    "zip_code": "85004",
    "state": "AZ",
    "city": "Phoenix"
  }
}
'

Response

{
  "first_name": "John",
  "last_name": "Doe", 
  "email": "[e-mail]", 
  "phone_number":"[phone]",
  "gender": "Male", 
  "dob": "1999-01-01", 
  "address": {
	  "first_line": "Some Street", 
	  "second_line": null,
    "zip_code": "85004",
    "state": "AZ",
    "city": "Phoenix"
  }
}

Patient name fields (first_name, last_name) must follow specific validation rules due to lab restrictions. See Patient Name Validation for complete details.

cURL

curl --request PATCH \
     --url {{BASE_URL}}/v2/user/{user_id}/info \
     --header 'Accept: application/json' \
     --header 'x-vital-api-key: <API_KEY>' \
     --header 'Content-Type: application/json' \
     --data '
{
  "first_name": "John",
  "last_name": "Doe", 
  "email": "[e-mail]", 
  "phone_number":"[phone]",
  "gender": "Male", 
  "dob": "1999-01-01", 
  "address": {
	  "first_line": "Some Street", 
	  "second_line": null,
    "zip_code": "85004",
    "state": "AZ",
    "city": "Phoenix"
  }
}
'

Response

{
  "first_name": "John",
  "last_name": "Doe", 
  "email": "[e-mail]", 
  "phone_number":"[phone]",
  "gender": "Male", 
  "dob": "1999-01-01", 
  "address": {
	  "first_line": "Some Street", 
	  "second_line": null,
    "zip_code": "85004",
    "state": "AZ",
    "city": "Phoenix"
  }
}

Authorizations

x-vital-api-key · string · header · required

Vital Team API Key

Path Parameters

user_id · string · required

Body

application/json

first_name · string · required

last_name · string · required

email · string<email> · required

phone_number · string · required

gender · string · required

dob · string<date> · required

address · UserAddress · object · required

Show child attributes

medical_proxy · GuarantorDetails · object | null

Show child attributes

race · enum<string> | null

ℹ️ This enum is non-exhaustive.

Available options: african_american_or_black, asian, indigenous_native_american_alaska_native, other, pacific_islander_or_hawaiian, white_caucasian

ethnicity · enum<string> | null

ℹ️ This enum is non-exhaustive.

Available options: hispanic, non_hispanic, ashkenazi_jewish, other

sexual_orientation · enum<string> | null

ℹ️ This enum is non-exhaustive.

Available options: lesbian_gay_or_homosexual, heterosexual_or_straight, bisexual, dont_know, other

gender_identity · enum<string> | null

ℹ️ This enum is non-exhaustive.

Available options: male, female, female_to_male_ftm_transgender_male_trans_man, male_to_female_mtf_transgender_female_trans_woman, genderqueer, other

Response

200

application/json

Successful Response

first_name · string · required

last_name · string · required

email · string · required

phone_number · string · required

gender · string · required

dob · string<date> · required

address · UserAddress · object · required

Show child attributes

medical_proxy · GuarantorDetails · object | null

Show child attributes

race · enum<string> | null

ℹ️ This enum is non-exhaustive.

Available options: african_american_or_black, asian, indigenous_native_american_alaska_native, other, pacific_islander_or_hawaiian, white_caucasian

ethnicity · enum<string> | null

ℹ️ This enum is non-exhaustive.

Available options: hispanic, non_hispanic, ashkenazi_jewish, other

sexual_orientation · enum<string> | null

ℹ️ This enum is non-exhaustive.

Available options: lesbian_gay_or_homosexual, heterosexual_or_straight, bisexual, dont_know, other

gender_identity · enum<string> | null

ℹ️ This enum is non-exhaustive.

Available options: male, female, female_to_male_ftm_transgender_male_trans_man, male_to_female_mtf_transgender_female_trans_woman, genderqueer, other