Antylogic
DemoApp login

399 operational guides

Docs sections
DocsTeam
Device

Edit Staff Role

Update the name, description or colour of an existing staff role for the active location without changing employee assignments.

In this article

Staff roles are a location-level catalogue used to keep employee records and operational views readable. This guide covers editing an existing role in Harbor Soho or any other selected location.

The action changes only the role name, description and colour. It does not move employees between roles, create access-control roles or delete the role.

Before you start

  • Work inside the correct organisation and location, for example Harbor Demo Group > Harbor Soho.
  • The staff role already exists in the active location.
  • Your account can view staff roles. Saving changes also requires `staff-roles:manage` for the location.

Instructions

  1. 1.

    Open Staff Roles

    Open Staff management for the active location and switch to the Roles tab. The table shows role names, descriptions, assigned employee counts and row actions; use search if the list is long.

  2. 2.

    Open The Role

    Select the role row or choose Edit. The detail form opens for that role and keeps the return context on the Roles tab.

  3. 3.

    Review Current Values

    Check Name, Description and the app label `Color` before editing. Save stays unavailable until the form is valid and contains a change.

  4. 4.

    Edit The Role

    Change the name, description or colour. Use a label operators will recognise when assigning staff in the active location.

  5. 5.

    Save Changes

    Choose Save once the form is valid. Antylogic sends the update for the current location role, shows the role-updated confirmation and returns to Staff management on Roles.

  6. 6.

    Cancel Without Saving

    Choose Cancel or use the header back action to leave the form without sending an update. The app returns to the Roles tab.

Validations and limits

  • The role must belong to the active location; roles from another location resolve as not found.
  • `Name` is required and is trimmed before saving.
  • A colour is required. Available colour codes are `gray`, `blue`, `indigo`, `purple`, `pink`, `orange`, `success`, `warning` and `error`.
  • Save is disabled while submitting, in read-only mode, when Name is blank, when Color is missing or when nothing changed.
  • Only name, description and colour are updated; assigned employees stay on their existing staff records.
  • The update uses `PUT /api/app/{orgId}/{locationId}/staff-roles/{roleId}` and still requires non-empty name and colour values.
  • This guide covers staff roles in `staff_roles`, not access-control roles under `/roles`.
  • Duplicate staff role names are not documented as blocked, so choose clear names for the location.
  • The Delete button can appear for managers, but deletion belongs to the separate `staff-role.delete` action.

Expected result

The staff role catalogue entry is updated for the active location, the `staff_roles` list and detail data are refreshed, and the same employees remain attached to the role as before.

Related articles