Create New User

Creates a new user and sends an email to inform the user.

In order to make sure that the correct brand details are included in the email, be sure to POST the API request to https://{yourbrand}.yourpayroll.com.au.
To prevent sending of the new user email, set apiOnly to true in the request.

Request

POST https://apimy.yourpayroll.io/api/v2/user

Request body

The request body takes a complete NewUserModel resource, containing the following writable properties:

{
    "apiOnly": "boolean",
    "displayName": "string",
    "email": "string",
    "emailConfirmed": "boolean",
    "timeZone": "string",
    "username": "string"
}

Properties

Name Type Description
apiOnly boolean Boolean
displayName string

Required
email string String
emailConfirmed boolean Boolean
timeZone string String
username string

Required

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK

OK

 NewUserCreatedModel