Grant Employee Access

Grants a user access to the employee.

Request

POST https://api.yourpayroll.com.au/api/v2/business/{businessId}/employee/{employeeId}/access

Path parameters

Parameter name Value Description Additional
businessId string Required
employeeId string Required

Request body

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

{
    "email": "string",
    "name": "string",
    "suppressNotificationEmails": "boolean"
}

Properties

Name Type Description
email string String
name string String
suppressNotificationEmails boolean Boolean

Response

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

Status code Description Resource
200 OK

OK