Skip to content
Documentation

Create user

POST
/api/v1/users

Creates a new user.

Authorizations

Section titled “Authorizations ”

Request Body

Section titled “Request Body ”
object
first_name
required
string
last_name
required
string
email
required
string
role_id
required
integer
workspace_ids

Array of workspace IDs the user should be added to

Array<integer>
team_ids

Array of team IDs the user should be added to (must belong to selected workspaces)

Array<integer>

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Successful

object
id
required
integer
Example
12345
first_name
required
string
Example
Joe
last_name
required
string
Example
Cottam
email
required
string format: email
Example
[email protected]
created_at
required
string format: date-time
Example
2023-08-23T10:30:00.000Z
updated_at
required
string format: date-time
Example
2023-08-23T10:30:00.000Z
profile_image_url
required
string format: url
nullable
Example
https://example.com/profile.jpg
wants_marketing_emails
required
boolean
two_factor_enabled
required
boolean
disabled_email_notifications
required
Array<string>
Allowed values: mentioned_in_comment reply_in_comment_thread requested_review review_changes_requested review_approved ready_to_publish
organization_membership
required
object
role_id
required
integer
Example
12345
invitation_sent_at
required
string format: date-time
nullable
Example
2023-08-23T10:30:00.000Z
invitation_accepted_at
required
string format: date-time
nullable
Example
2023-08-23T10:30:00.000Z

401

Section titled “401 ”

Unauthorized

object
message
required
string
Example
Record not found

403

Section titled “403 ”

Forbidden

object
message
required
string
Example
Record not found

422

Section titled “422 ”

Unprocessable Entity

object
message
required
string
Example
Failed to save
errors
required
object
key
additional properties
Array<string>
Example
{
  "errors": {
    "username": [
      "Username is required.",
      "Username must be unique."
    ],
    "email": [
      "Invalid email format."
    ]
  }
}