This is currently restricted to updating the user's "email confirmation" status only. The API user (brand manager or reseller) must have brand exclusive access to the user i.e. the user must only have access to businesses/employees that the API user manages.

Request

PUT https://api.yourpayroll.com.au/api/v2/user

Request body

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

{
    "emailConfirmed": "boolean",
    "username": "string"
}

Properties

Name Type Description
emailConfirmed boolean Boolean
username string

Required

Response

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

Status code Description Resource
200 OK

OK

UserUpdatedModel