Update a user account

PUT

/user/{userId}

curl --request PUT \
  --url https://client-api.abi.ai/user/abi1234 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "uniqueId": "123abc789xyz", "firstName": "Jane", "lastName": "Doe", "email": "janedoe@example.com", "phone": "+441234567890", "address": "123 Main St, Apt 4B", "age": 34, "dateOfBirth": "1994-10-07", "gender": "male", "language": "en", "country": "it", "location": "es", "origin": "gb", "physicianCountry": "es" }'

• Abi Client API

Authorizations

• bearerAuth

Parameters

Path Parameters

userId

required

string

The Abi identifier of the user account.

Example

abi1234

Request Body^required

Media typeapplication/json

Supply only the fields that should change; omitted fields are left unchanged.

object

uniqueId

Your stable identifier for the user.

string

Example

123abc789xyz

firstName

The user’s first name.

string

Example

Jane

lastName

The user’s surname.

string

Example

Doe

email

The user’s email address.

string format: email

Example

janedoe@example.com

phone

The user’s mobile number including international dialing code (E.164).

string

Example

+441234567890

address

The user’s address.

string

Example

123 Main St, Apt 4B

age

The user’s age.

number

Example

34

dateOfBirth

The user’s date of birth.

string format: date

Example

1994-10-07

gender

The user’s gender

string

Allowed values: male female other

Example

female

language

The language Abi uses to communicate with the user.

string

Example

en

country

The user’s nationality or country code.

string

Example

it

location

The country where the user lives or is currently located.

string

Example

es

origin

The country in which the user was born.

string

Example

gb

physicianCountry

The country in which responding healthcare professionals are licensed.

string

Example

es

Responses

200

User updated. See the User account model for the full response-field reference.

Media typeapplication/json

object

Example

{
  "id": "abi1234",
  "uniqueId": "123abc789xyz",
  "userStatus": "activeUser",
  "firstName": "Jane",
  "lastName": "Doe",
  "email": "janedoe@gmail.com",
  "gender": "female",
  "phone": "+441234567890",
  "origin": "gb",
  "location": "es",
  "country": "it",
  "physicianCountry": "es",
  "language": "en",
  "dateOfBirth": "1994-10-07",
  "partnerName": "Abi",
  "associatedAccounts": 5
}

400

Request could not be completed.

Media typeapplication/json

object

code

Short machine-readable error code.

string

message

Human-readable explanation of the error.

string

Example^generated

{
  "code": "example",
  "message": "example"
}

404

Request could not be completed.

Media typeapplication/json

object

code

Short machine-readable error code.

string

message

Human-readable explanation of the error.

string

Example^generated

{
  "code": "example",
  "message": "example"
}