Update user profile

POST/api/v1/users

Updates the profile information for an existing user.

cv-api-key

Productionhttps://api.care360-next.carevalidate.com/api/v1/users

Staginghttps://api-staging.care360-next.carevalidate.com/api/v1/users

Important

Users can freely update their profile information until a case has been assigned to a provider. Once a case is assigned, the following fields are locked: firstName, lastName, dob, and gender. This is a security measure because ID verification is performed before a case is assigned to a provider. If a user needs to update any of these locked fields, they must contact the support team for a manual update.

Headers

Headers

cv-api-keystringrequired

Your unique API key for authentication.

Content-Typestringrequired

Must be application/json.

Example: application/json

Request Body

Body Parameters

actionstringrequired

The action to be performed. Must be UPDATE_PROFILE.

Values:UPDATE_PROFILE

dataobjectrequired

An object containing the user's profile details to be updated.

Show 16 child properties

emailstringrequired

The user's email address.

Example: john.doe@example.com

firstNamestringoptional

The user's first name.

Example: John

lastNamestringoptional

The user's last name.

Example: Doe

dobstringoptional

The user's date of birth in YYYY-MM-DD format.

Example: 1995-10-01

genderstringoptional

The user's gender.

Values:MALEFEMALEOTHER

phoneNumberstringoptional

The user's phone number.

Example: +11111111111

addressstringoptional

The user's street address. It should not be a PO Box Address.

Example: 123 ABC street

address2stringoptional

Optional second line for the address (e.g., apartment or suite number). Send null to reset.

Example: Apt 2

citystringoptional

The user's city.

Example: NYC

statestringoptional

The user's state in 2-character abbreviation format.

Example: NY

countrystringoptional

The user's country code in 2-character abbreviation format.

Example: US

postalCodestringoptional

The user's postal code (e.g., 12345 or 12345-6789).

Example: 01010

allergiesstringoptional

The user's allergies.

Example: Peanuts, Shellfish

currentMedicationsstringoptional

The user's current medications.

Example: Aspirin, Metformin

healthConditionsstringoptional

The user's health conditions.

Example: Diabetes, Hypertension

languagePreferencesarrayoptional

The user's language preferences.

Example: ["en", "es", "fr"]

Example Request

cURL

curl --location '<BASE_URL>/api/v1/users' \
--header 'cv-api-key: <redacted>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "action": "UPDATE_PROFILE",
  "data": {
      "email": "john.doe@example.com",
      "firstName": "John",
      "lastName": "Doe",
      "dob": "1995-10-01",
      "phoneNumber": "+11111111111",
      "gender": "MALE",
      "address": "123 ABC street",
      "address2": "Apt 2",
      "city": "NYC",
      "state": "NY",
      "country": "US",
      "postalCode": "01010"
      "allergies": "Peanuts, Shellfish",
      "currentMedications": "Aspirin, Metformin",
      "healthConditions": "Diabetes, Hypertension",
      "languagePreferences": ["en", "es", "fr"]
  }
}'

JavaScript

const response = await fetch('<BASE_URL>/api/v1/users', {
method: 'POST',
headers: {
  'cv-api-key': '<redacted>',
  'Content-Type': 'application/json',
},
body: JSON.stringify({
  action: 'UPDATE_PROFILE',
  data: {
    email: 'john.doe@example.com',
    firstName: 'John',
    lastName: 'Doe',
    dob: '1995-10-01',
    phoneNumber: '+11111111111',
    gender: 'MALE',
    address: '123 ABC street',
    address2: 'Apt 2',
    city: 'NYC',
    state: 'NY',
    country: 'US',
    postalCode: '01010',
    allergies: 'Peanuts, Shellfish',
    currentMedications: 'Aspirin, Metformin',
    healthConditions: 'Diabetes, Hypertension',
    languagePreferences: ['en', 'es', 'fr'],
  },
}),
});
const data = await response.json();
console.log(data);

Python

import requests

response = requests.post(
  '<BASE_URL>/api/v1/users',
  headers={
      'cv-api-key': '<redacted>',
      'Content-Type': 'application/json',
  },
  json={
      'action': 'UPDATE_PROFILE',
      'data': {
          'email': 'john.doe@example.com',
          'firstName': 'John',
          'lastName': 'Doe',
          'dob': '1995-10-01',
          'phoneNumber': '+11111111111',
          'gender': 'MALE',
          'address': '123 ABC street',
          'address2': 'Apt 2',
          'city': 'NYC',
          'state': 'NY',
          'country': 'US',
          'postalCode': '01010',
          'allergies': 'Peanuts, Shellfish',
          'currentMedications': 'Aspirin, Metformin',
          'healthConditions': 'Diabetes, Hypertension',
          'languagePreferences': ['en', 'es', 'fr'],
      },
  },
)
print(response.json())

Responses

▶200Profile updated successfullyThe profile was updated successfully. Returns the updated user object.

{
  "status": 200,
  "success": true,
  "message": "Profile updated successfully",
  "data": {
    "user": {
      "email": "john@example.com",
      "firstName": "John",
      "lastName": "Doe",
      "dob": "1995-10-01T00:00:00.000Z",
      "phoneNumber": "+15513446634",
      "gender": "MALE",
      "address": "123 ABC street",
      "address2": "Apt 2",
      "city": "NYC",
      "state": "NY",
      "country": "US",
      "postalCode": "01010",
      "allergies": "Peanuts, Shellfish",
      "currentMedications": "Aspirin, Metformin",
      "healthConditions": "Diabetes, Hypertension",
      "languagePreferences": [
        "en",
        "es",
        "fr"
      ]
    }
  }
}

▶400User does not existThe email provided does not correspond to an existing user.

{
  "status": 400,
  "success": false,
  "message": "User {email} does not exist"
}

▶400User not in organizationThe user exists but is not part of the organization associated with the API key.

{
  "status": 400,
  "success": false,
  "message": "User {email} does not exist in the organization"
}

▶400Not allowed to update profileThe user's role is not USER, so they cannot update their profile.

{
  "status": 400,
  "success": false,
  "message": "Not allowed to update the profile"
}

▶400Cannot update demographic fieldsThe user has cases with status Approved, Assigned, InProgress, NoDecision, or Rejected. Fields firstName, lastName, dob, and gender are locked.

{
  "status": 400,
  "success": false,
  "message": "Cannot update user profile fields (firstName, lastName, dob, gender) for user with cases"
}

▶400Phone number already in useThe new phoneNumber is already associated with a different user.

{
  "status": 400,
  "success": false,
  "message": "Unable to use this phone number. Please use a different one"
}

Try It Out

Try itAPI Playground

▶