API Reference

Create Client Employee

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

Grant an employee access to a client business. Both the user and the
client must already exist. This operation is synchronous.

Requires scope: organization:sync.

Path Params
string
required

Client organization's Digits-assigned ID.

Body Params
string

Client organization's Digits-assigned ID.

string

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

string

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

string
required

Role within the organization.

entities
array of objects

Explicit role assignments within this client's entities. When entityRole is set, these override that default for named entities.

entities
string

Employee-level default role for this client's entities. Stored for future entities and applied to existing entities unless entities provides overrides.

Responses

Updated about 1 month ago

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

Updated about 1 month ago