User

Create new user

Changed on

Create a new user.

post/v1/users

Request

  • Base URL: https://example.com/api
  • URL: https://example.com/api/v1/users
  • Auth: OAuth 2 (authorization code, authorization URL /oauth/authorize, token URL /oauth/token; client credentials, token URL /oauth/token; password, token URL /oauth/token, scopes: user)

Request body

usernamestring required

The unique username of the user.

first_namestring required

First name of the user.

last_namestring required

Last name of the user.

emailstring email required

Email address of the user.

passwordstring password required

Password of the user.

picturestring uri nullable

Profile picture of the user.

titlestring nullable

Work title of the user.

biostring nullable

Self description of the user.

addressstring nullable

Working address of the user.

phonestring nullable

Phone number of the user.

linksstring[] nullable

Links to show on profile page.

languagesLanguage[] nullable

Languages of the user.

Example request

{
  "username": "test-user",
  "first_name": "Test",
  "last_name": "User",
  "email": "user@example.com",
  "password": "super-secret",
  "picture": "https://example.com/users/my-user.png",
  "title": "Senior Software Engineer",
  "bio": "I'm working smart on software.",
  "address": "Remote",
  "phone": "+15555551234",
  "links": [
    "https://example.com/my-user"
  ]
}

Response

Example response

idstring required

ID of the newly created resource.

Changes

  • 8a34c0b5508eRevision changes
    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 58fc399a7dc5Revision changes
    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became required

    • breaking

      the request property became required