Skip to main content
PUT
V0 - Add, update or remove employee (externalId)

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Content-Type
string
default:application/json

Standard application/json content type.

X-Findity-ApiVersion
string
default:3

Findity API version. Use 3 for the current admin API.

Path Parameters

externalId
string
required

The external source id of the organization

Query Parameters

sendInvitationMail
boolean
default:true

When true (default), an invitation email is sent to newly created users. When false, no invitation email is sent.

Body

application/json

Array of user objects to upsert in the organization. Set delete: true on a user object to remove that user.

externalSourceId
string

External source identifier of the user. Used to match an existing user; if no match, a new user is created.

Example:

"222"

employeeId
string

Employee identifier set by the organization. Must be unique within the organization.

Example:

"12345"

organizationalUnitExternalSourceId
string

External source id of the organizational unit (department) the user belongs to.

Example:

"1234567"

title
string

Job title of the user.

Example:

"12345"

admin
boolean

Whether the user has administrator privileges in the organization.

Example:

"false"

impersonatorEmployees
array[]

Other users in the organization who may impersonate this user (e.g. to handle expenses on their behalf).

endDate
string

Date the user stops being an active employee. ISO 8601. A future date is allowed; a past date marks the employee as ended.

Example:

"2019-12-31T00:00:000Z"

person
object

Person profile attached to the user — the individual identity the user represents. A Person can have multiple Users across different Organizations within the same client application.

presetValues
array[]

Custom dimension values that are preset on the user, optionally with temporary approver assignments.

Response

200 - application/json
Last modified on August 31, 2026