Models

User

object

created_atstring<date-time>read only

Example

2026-10-01T00:00:00+00:00

updated_atstring<date-time>read only

Example

2026-10-01T00:00:00+00:00

emailstring<email>required

The new users email address.

Example

james@firefly-iii.org

blockedboolean

Boolean to indicate if the user is blocked.

Example

false

blocked_codeUserBlockedCodeProperty | nullemail_changednull

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

Example

email_changed

roleUserRoleProperty | nullownerdemonull

Role for the user. Can be empty or omitted.

Example

owner

Example

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