Skip to main content
PUT
/
user
/
update
/
{id}
Update User
curl --request PUT \
  --url https://api.decodahealth.com/user/update/{id} \
  --header 'API-KEY: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'TENANT: <tenant>' \
  --data '
{
  "firstName": "<string>",
  "lastName": "<string>",
  "externalId": "<string>",
  "email": "<string>",
  "phoneNumber": "<string>",
  "address": "<string>",
  "addressLineTwo": "<string>",
  "city": "<string>",
  "state": "<string>",
  "zipCode": "<string>",
  "country": "<string>",
  "addressValid": true,
  "meta": {},
  "primaryLocationId": "<string>"
}
'
{
  "id": "<string>",
  "type": "PROVIDER",
  "createdDate": "2023-11-07T05:31:56Z",
  "firstName": "<string>",
  "lastName": "<string>",
  "phoneNumber": "<string>",
  "email": "<string>",
  "locationId": "<string>",
  "externalId": "<string>",
  "address": "<string>",
  "addressLineTwo": "<string>",
  "city": "<string>",
  "state": "<string>",
  "zipCode": "<string>",
  "country": "<string>",
  "addressValid": true,
  "meta": {},
  "isArchived": true,
  "primaryLocationId": "<string>"
}

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Path Parameters

id
string
required

Body

application/json
firstName
string | null
lastName
string | null
externalId
string | null
email
string | null
phoneNumber
string | null
address
string | null
addressLineTwo
string | null
city
string | null
state
string | null
zipCode
string | null
country
string | null
addressValid
boolean | null
meta
Meta · object
primaryLocationId
string | null

Response

Successful Response

id
string
required

The unique identifier for the user.

type
enum<string>
required

The type of user.

Available options:
PROVIDER,
PATIENT,
ASSISTANT
createdDate
string<date-time>
required

The date and time when the user was created.

firstName
string | null

The user's first name.

lastName
string | null

The user's last name.

phoneNumber
string | null

The user's phone number.

email
string | null

The user's email address.

locationId
string | null

The location of the user.

externalId
string | null

The user's external identifier if available.

address
string | null

The user's primary address.

addressLineTwo
string | null

Additional address information.

city
string | null

The city of the user's address.

state
string | null

The state of the user's address.

zipCode
string | null

The postal code of the user's address.

country
string | null

The country of the user's address.

addressValid
boolean | null

Whether the user's address is valid.

meta
Meta · object

Any additional metadata about the user relevant to your system.

isArchived
boolean | null

Whether the user is archived.

primaryLocationId
string | null

The primary location of the user.