Update position by external code

Performs a full update (replacement) of a position. All fields in the request body will replace the current values.

Business Rules:

• Role (externalCodeRole) is required and must exist

• Area (externalCodeArea) is required and must exist

• Parent position is optional - can be null for root position

• Employee assignment is optional (can be null to unassign)

• Employee can only be assigned to one position at a time

• Operation Unit (externalCodeOperationUnit) is optional (can be null to unassign)

• Set nullable fields to null to remove them

Additional Leaders (additionalParents):

• When provided, completely replaces existing additional leaders

• An empty array removes all additional leaders

• If not provided, existing additional leaders are preserved

• Maximum of 5 additional leaders allowed

• All additional leader positions must exist

• Cannot reference itself or main parent as additional leader

• No duplicate codes allowed in the list

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length ≤ 50

The external code of the position to be updated

Body Params

Complete position data for replacement. All fields are required and will replace existing values.

string
required
length ≤ 255

Human-readable name for the position

string | null
required

Detailed description of the position. Set to null to remove description.

string
required
length ≤ 50

External code of the role to associate with this position (required)

string
required
length ≤ 50

External code of the area to associate with this position (required)

string | null
required

External code of the cost center to associate with this position. Set to null to remove cost center.

string | null
required

External code of the operation unit to associate with this position. Set to null to remove operation unit.

string
required
length ≤ 50

External code of the parent position in the organizational hierarchy (required)

string | null
required

Email address of the employee to assign to this position. Set to null to unassign employee.

string | null
required

Tax payer registry (CPF) of the employee to assign to this position. Set to null to unassign employee. Must be a valid CPF format.

string | null
required

Internal company identification number of the employee to assign to this position. Set to null to unassign employee.

additionalParents
array of strings | null

Optional list of external codes of additional parent positions (additional leaders) for this position. When provided, this list will completely replace any existing additional leaders. An empty array or null will remove all additional leaders. Maximum of 5 items allowed.

additionalParents
Responses

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