Docs
Skip to content
post

Create account

Endpoint

posthttps://<REGION>.cloud.appwrite.io/v1/account

Description

Use this endpoint to allow a new user to register a new account in your project. After the user registration completes successfully, you can use the /account/verfication route to start verifying the user email address. To allow the new user to login to their new account, you need to create a new account session.

Required scopes

sessions.write

Authentication

Initialize the Appwrite client with setProject(). No signed-in user or server API key is required.

Rate limit

Up to 10 requests per hour for each IP address calling this endpoint.
Server API key requests bypass this rate limit.

Parameters

string
Required

User ID. Choose a custom ID or generate a random ID with ID.unique(). Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.

string
Required

User email.

string
Required

New user password. Must be between 8 and 256 chars.

string

User name. Max length: 128 chars.

Status
Content type
201
application/json

User

Name
Type
Description
string

User ID.

string

User creation date in ISO 8601 format.

string

User update date in ISO 8601 format.

string

User name.

string

Hashed user password.

string

Password hashing algorithm.

object7 possible types

Password hashing algorithm configuration.

Object types (7)

string

User registration date in ISO 8601 format.

boolean

User status. Pass true for enabled and false for disabled.

arrayof string

Labels for the user.

string

Password update time in ISO 8601 format.

string

User email address.

string

User phone number in E.164 format.

boolean

Email verification status.

boolean

Phone verification status.

boolean

Multi factor authentication status.

object

User preferences as a key-value object Can be one of: preferences

arrayof Target

A user-owned message receiver. A single user may have multiple e.g. emails, phones, and a browser. Each target is registered with a single provider.

Object type

string

Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.

JavaScript
import { Client, Account } from "appwrite";


const client = new Client()
    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
    .setProject('<YOUR_PROJECT_ID>'); // Your project ID


const account = new Account(client);


const result = await account.create(
    '<USER_ID>', // userId
    'email@example.com', // email
    '', // password
    '<NAME>' // name (optional)
);


console.log(result);