users

Store a new user

Creates a new user. The data required can be submitted as a JSON body or as a list of parameters. The user will be given a random password, which they can reset using the "forgot password" function.

post/v1/users

Headers

X-Trace-Idstring uuid

Example:40c71bbb-c676-4f24-83cf-cc725d7d7a00

Unique identifier associated with this request.

Request body

created_atstring date-time

updated_atstring date-time

emailstring email required

The new users email address.

blockedboolean

Boolean to indicate if the user is blocked.

blocked_code'email_changed' | 'null' string nullable

If you say the user must be blocked, this will be the reason code.

role'owner' | 'demo' | 'null' string nullable

Role for the user. Can be empty or omitted.

Example request

{
  "created_at": "2026-08-01T00:00:00+00:00",
  "updated_at": "2026-08-01T00:00:00+00:00",
  "email": "james@firefly-iii.org",
  "blocked_code": "email_changed",
  "role": "owner"
}

Response

New user stored, result in response.

Changes

No recorded changes to this endpoint across all 1 revision of this API.