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 |
---|---|---|
POST | /signup | None |
NOTE|
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 |
---|---|
201 | success |
400 | the request was malformed |
500 | server error |
NOTE
If the status code is not
201
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
Javascript
const signup = await axios.post(
'https://backend.freesewing.org/signup',
{
email: "joost@joost.at",
language: "en"
}
)
Example response
JSON
201
{
"result": "success",
"email": "joost@joost.at"
}