/v0/accounts

POST

/v0/accounts

const url = 'http://localhost:3000/v0/accounts';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"name":"@example_man@example.com","email":"foo@example.com","passphrase":"じゃすた・いぐざんぽぅ","captcha_token":"example"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url http://localhost:3000/v0/accounts \
  --header 'Content-Type: application/json' \
  --data '{ "name": "@example_man@example.com", "email": "foo@example.com", "passphrase": "じゃすた・いぐざんぽぅ", "captcha_token": "example" }'

Request Body

application/json

object

name

required

Characters must be [A-Za-z0-9-.] The first and last characters must be [A-Za-z0-9-.]

string

>= 1 characters <= 64 characters

Example

@example_man@example.com

email

required

string format: email

Example

foo@example.com

passphrase

required

Passphrase must be a UTF-8 string excluding spaces, tabs, full-width spaces, newlines, and null characters.

string

>= 8 characters <= 512 characters

Example

じゃすた・いぐざんぽぅ

captcha_token

required

Captcha token (e.g. reCAPTCHA, Cloudflare Trunstile)

string

Responses

200

application/json

object

required

Account ID

string

name

required

Account name

string

email

required

Account email address

string format: email

Example

{
  "id": "38477395",
  "name": "@example_man@example.com",
  "email": "foo@example.com"
}

400

Bad Request

application/json

object

error

required

Any of:

Account name is invalid.

string

Allowed values: INVALID_ACCOUNT_NAME

Example

{
  "error": "INVALID_ACCOUNT_NAME"
}

409

Conflict

application/json

object

error

required

Any of:

string
string

Account email is already in use.

string

Allowed values: EMAIL_IN_USE

Example

{
  "error": "ACCOUNT_NAME_IN_USE"
}

500

Internal Server Error

application/json

object

error

required

Internal server error.

string

Allowed values: INTERNAL_ERROR

Example

{
  "error": "INTERNAL_ERROR"
}