Create Staff Invite Link
Returns the same invite link as Invite Staff in the SalaryBox app. Shared rules: see Writing Data.
- Send an empty body:
{}. - Extra limits: 1 request per 10 seconds and 20 per hour.
- If the link service fails or takes longer than 10 seconds, you get
502. Try again.
Custom role needs: staff_details:edit.
Authentication
AuthorizationApi-Key
Format: “Api-Key {api-key}”
Request
This endpoint expects an object.
Response
The invite link was created.
message
status
data
rate_limit
Optional. Remaining invite-link requests in each rate-limit window.
Errors
400
Bad Request Error
403
Forbidden Error
502
Bad Gateway Error