1
0
Fork 0
freesewing/markdown/dev/reference/backend/account/create/en.md
2023-05-22 16:41:02 +02:00

1.7 KiB

title
Create an account

Creates a new User account. The User account will remain inactive until it is confirmed.

Endpoints

Creating a new User account is possible via this endpoint:

Method Path Authentication
/signup None

This endpoint requires no authentication

Request body

Property Type Description
email string The E-mail address of the User
language boolean The language code for the User

Response status codes

Possible status codes for these endpoints are:

Status code Description
success
the request was malformed
server error
If the status code is not the `error` property in the response body should indicate the nature of the problem.

Response body

Value Type Description
result String Either success or error
error String Will give info on the nature of the error. Only set if an error occurred.
email String The E-mail address where the confirmation email was sent to

Example request

const signup = await axios.post(
  'https://backend.freesewing.org/signup',
  {
    email: "joost@joost.at",
    language: "en"
  }
)

Example response

{
  "result": "success",
  "email": "joost@joost.at"
}