POST /api/v2/users/sign_up
Sign up new user

Headers

Header name	Description
Content-Type required	application/json
X-API-KEY required	YOUR_API_KEY

Params

Param name	Description
email required	Email Validations: Must be a String
first_name required	First name Validations: Must be a String
last_name required	Last name Validations: Must be a String
company optional	Company Validations: Must be a String

Examples

// With invalid parameters
POST /api/v2/users/sign_up
{
  "first_name": "first",
  "last_name": "last",
  "email": "bossman@email.com",
  "title": "bossman"
}
400
{
  "error": "email domain name not allowed"
}

// Missing "email" parameter
POST /api/v2/users/sign_up
{
  "first_name": "first",
  "last_name": "last"
}
422
{
  "error": "Missing parameter email"
}

// Missing "first_name" parameter
POST /api/v2/users/sign_up
{
  "email": "first.last@email.com",
  "last_name": "last"
}
422
{
  "error": "Missing parameter first_name"
}

// Missing "last_name" parameter
POST /api/v2/users/sign_up
{
  "email": "first.last@email.com",
  "first_name": "first"
}
422
{
  "error": "Missing parameter last_name"
}

// Forbidden domain name
POST /api/v2/users/sign_up
{
  "first_name": "first",
  "last_name": "last",
  "email": "newuser@email.com",
  "company": "company"
}
400
{
  "error": "email domain name not allowed"
}

// Email is already registered
POST /api/v2/users/sign_up
{
  "first_name": "first",
  "last_name": "last",
  "email": "newuser@example.com",
  "company": "company"
}
400
{
  "error": "Email has already been taken"
}

// Successful request
POST /api/v2/users/sign_up
{
  "first_name": "first",
  "last_name": "last",
  "email": "newuser@example.com",
  "company": "company"
}
201
{
  "ok": "user created"
}

Errors

Code	Description
401	Unauthorized
404	Not found
500	Internal Server Error
422	Missing parameters