Update Employee

put

https://connect.digits.com/v1/organization/employee

Fully replace an employee binding. The employee must already exist. The request must identify the employee by Digits-assigned ID or caller-assigned user ID, include the employee's organization role, and may include entity access (entities and/or entityRole), client access (clients and/or clientRole), or both. entityRole and clientRole are stored as employee-level defaults for future entities or client entities and are applied to current access unless explicit entities or clients entries override them.

Access omitted from the request is removed.

Requires scope: organization:sync.

Body Params

Request to fully replace an employee binding. Identify the employee by Digits-assigned ID or caller-assigned user ID. organizationRole is required. Optionally provide entity access (entityRole, entities, or both), client access (clientRole, clients, or both), or both. entityRole and clientRole are employee-level defaults: they are stored on the employee row for future entities or client entities, and applied to current access unless explicit entities or clients entries override them. Access omitted from the request is removed.

userId

string

User's Digits-assigned ID (provide userId or userExternalId).

userExternalId

string

User's caller-assigned ID (provide userId or userExternalId).

organizationRole

string

required

The employee's role within the organization.

entities

array of objects

Explicit role assignments on the organization's own entities. When entityRole is set, these override that default for named entities.

entities

clients

array of objects

Explicit role assignments on client entities. When clientRole is set, these override that default for named clients or entities.

clients

entityRole

string

Employee-level default role for the organization's own entities. Stored for future entities and applied to existing entities unless entities provides overrides.

clientRole

string

Employee-level default role for client entities. Stored for future client entities and applied to current client access unless clients provides overrides.

Responses

200OK

defaultDefault error response