Skip to navigation
API ReferenceStaff

Set Staff Add-on Access

Gives or removes one staff member’s access to a paid add-on. Shared rules: see Writing Data.

  • Send exactly one of location_tracking or crm (the same keys as Get Staff Add-on Permissions): true gives access, false removes it.
  • Giving access uses one of the company’s purchased add-on seats.
  • If the add-on isn’t purchased, no seats are left, or there is no active subscription, you get 403 with the app’s own message.
  • On older plans where the add-on is part of the plan, every staff member already has access and it can’t be changed per person (400).
  • The response shows the staff member’s access to both add-ons.

Custom role needs: additional_settings:edit.

Authentication

AuthorizationApi-Key

Format: “Api-Key {api-key}”

Path parameters

salarybox_idstringRequired
SalaryBox ID of the staff member.

Request

This endpoint expects an object.
location_trackingbooleanOptional

true gives the staff member Location Tracking access, false removes it.

crmbooleanOptional

true gives the staff member CRM access, false removes it.

Response

The access was updated.
messagestring
statusboolean
dataobject

The staff member’s resulting access to both add-ons, computed the same way as Get Staff Add-on Permissions.

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error