Manual
CLI
API
Log in Get started free

Update your profile

Replaces your profile details.

Replaces your profile details.

HTTP
PUT /account

Access: Session token only. API keys get 403 with insufficient_scope.

Request body #

JSON.

FieldTypeRequiredDescription
displayNamestringyesThe name shown to others. At most 80 characters.
firstNamestringnoAt most 60 characters.
lastNamestringnoAt most 60 characters.
jobTitlestringnoAt most 80 characters.
companystringnoAt most 80 characters.
JSON
{ "displayName": "Ada Lovelace", "firstName": "Ada", "lastName": "Lovelace", "jobTitle": "Engineer", "company": "Analytical Engines" }

Response 200 #

The saved profile.

JSON
{
  "id": "0197a3c2-5b1e-7c4a-9d2f-3e8b6a1f0c55",
  "email": "ada@example.com",
  "displayName": "Ada Lovelace",
  "firstName": "Ada",
  "lastName": "Lovelace",
  "jobTitle": "Engineer",
  "company": "Analytical Engines",
  "locale": "en-GB"
}

Response fields #

FieldTypeDescription
idstringThe id of the user.
emailstringThe email address.
displayNamestringThe name shown to others.
firstNamestringThe first name. Defaults to the first word of the display name.
lastNamestringThe last name. Defaults to the rest of the display name.
jobTitlestring or nullThe job title.
companystring or nullThe company.
localestring or nullThe interface language, for example en-GB. null until picked.

Errors #

StatuserrorWhen
401unauthenticatedThe token is missing or not valid.
422invalid_requestA field is empty (displayName) or longer than allowed. fields names it with the code invalid.
429rate_limitedToo many requests, see Rate limiting.

See Errors for the error format.

Notes #

Fields you leave out are cleared, except displayName, which is required.