POST users

Creates a new user account. Depending on the context, the created user account is either a private account, or an account managed by the calling organization.

If the call to this endpoint is made in an unauthenticated way, the resulting account will be a private account. Private accounts are not associated with any organizations. If the request is made by one of an organization's administrators, the resulting account is set up as "managed by" that organization.

Resource URL

https://www.drillster.com/api/2.1.1/users

Parameters

Response

A 2.1.1 User object with only the ID of the created user populated. This ID should be stored by the client to be able to refer to the user in future requests. If the user already exists, a 2.1.1 AccountAlreadyExistsError is returned. This error message contains the user ID.

Example request

In the below example it is assumed that the new user account does not yet exist in the Drillster system.

POST https://www.drillster.com/api/2.1.1/users
emailAddress=alice%40example.com
name=Alice+Smith
timeZone=America%2fChicago
yearOfBirth=1980
locale=en
domicile=US

Response

If the user did not previously exist, a User object with the user ID populated is returned:

{
  "type": "USER",
  "id": "3mhUfNhHQzqTCN0oZLcsJg"
}

If the request is repeated (meaning that the user account will already exist), the following error response should be expected:

{
  "id": "account_exists",
  "description": "The given email address is linked to an existing account",
  "userId": "3mhUfNhHQzqTCN0oZLcsJg"
}

Error responses

The following error situations are possible: