Update details of an associated user

Updates the user details (name / email) of a user that is associated with the business. This endpoint will only work if the user is already associated with the business and is not associated with any other business

Request

PUT https://api.nzpayroll.co.nz/api/v2/business/{businessId}/access

Path parameters

Parameter name Value Description Additional
businessId string Required

Query parameters

Parameter name Value Description Additional
email string Required

Request body

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

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

Properties

Name Type Description
email string String
name string String

Response

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

Status code Description Resource
200 OK

OK