PATCH
/
user
curl --request PATCH \
  --url https://api.letraz.app/api/v1/user/ \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "title": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "email": "jsmith@example.com",
  "phone": "<string>",
  "dob": "2023-12-25",
  "nationality": "<string>",
  "address": "<string>",
  "city": "<string>",
  "postal": "<string>",
  "website": "<string>",
  "profile_text": "<string>",
  "country": "<string>"
}'
{
  "id": "<string>",
  "title": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "email": "jsmith@example.com",
  "phone": "<string>",
  "dob": "2023-12-25",
  "nationality": "<string>",
  "address": "<string>",
  "city": "<string>",
  "postal": "<string>",
  "country": {
    "code": "<string>",
    "name": "<string>"
  },
  "website": "<string>",
  "profile_text": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

​
title
string | null

The title of the user. This can be Mr., Mrs., Dr., etc. (optional)

Maximum length: 10
​
first_name
string

The first name of the user.

Maximum length: 50
​
last_name
string | null

The last name of the user. (optional)

Maximum length: 50
​
email
string

The email of the user. Needs to be unique and a valid email.

Maximum length: 254
​
phone
string | null

The phone number of the user. (optional)

Maximum length: 25
​
dob
string | null

The date of birth of the user. (optional)

​
nationality
string | null

The nationality of the user. (optional)

Maximum length: 50
​
address
string | null

The address line of the user. Typically includes the apartment or plot number and the locality. (optional)

Maximum length: 500
​
city
string | null

The city the user lives in. (optional)

Maximum length: 50
​
postal
string | null

The postal code of the user. (optional)

Maximum length: 50
​
website
string | null

The user's personal portfolio or blog website. (optional)

Maximum length: 50
​
profile_text
string | null

The profile text of the user. This can be a short bio or a summary This would be shows on top of the user's resume. (optional)

Maximum length: 1000
​
country
string | null

The country the user lives in. (optional)

Response

201
application/json
​
id
string
required

The unique identifier for the user. Typically provided from the client side while creating the user.

​
first_name
string
required

The first name of the user.

Maximum length: 50
​
email
string
required

The email of the user. Needs to be unique and a valid email.

Maximum length: 254
​
country
object
required
​
created_at
string
required

The timestamp at which the user was created.

​
updated_at
string
required

The timestamp at which the user was last updated.

​
title
string | null

The title of the user. This can be Mr., Mrs., Dr., etc. (optional)

Maximum length: 10
​
last_name
string | null

The last name of the user. (optional)

Maximum length: 50
​
phone
string | null

The phone number of the user. (optional)

Maximum length: 25
​
dob
string | null

The date of birth of the user. (optional)

​
nationality
string | null

The nationality of the user. (optional)

Maximum length: 50
​
address
string | null

The address line of the user. Typically includes the apartment or plot number and the locality. (optional)

Maximum length: 500
​
city
string | null

The city the user lives in. (optional)

Maximum length: 50
​
postal
string | null

The postal code of the user. (optional)

Maximum length: 50
​
website
string | null

The user's personal portfolio or blog website. (optional)

Maximum length: 50
​
profile_text
string | null

The profile text of the user. This can be a short bio or a summary This would be shows on top of the user's resume. (optional)

Maximum length: 1000