Update an existing role

Updates a role identified by externalCode in the URL.

Business rules:

  • name, similarity, and externalCode are required and must not be empty.
  • jobLevel and description must be sent on every request; use null or "" to clear optional values in EO.
  • externalCode in the body must be unique within the company (cannot match another role's code).

Errors (HTTP):

  • 404 when no role matches the URL externalCode for the company.
  • 409 when the new externalCode is already used by another role.
  • 400 for validation failures (invalid enums, missing keys, empty required strings).
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

External code of the role to update

Body Params
string
required
length ≤ 300

role name

string
enum
required

role similarity

string | null
enum
required

role job level; send null or empty string to clear the value in EO

Allowed:
string
required
length ≤ 50

role external code

string | null
required

role description; send null or empty string to clear the value in EO

Responses
200

The role has been successfully updated.

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json