API Reference

Updates custom client-admin access settings for the onboarding.

post
https://example.com/wep/companies//onboarding/start//settings/cca

Access: System, Admin, and ClientAdmin users only.

This endpoint allows updating the visibility of an onboarding process for CCAs. If access is not limited,
all current and future CCAs will have access. If access is limited, only the specified client user IDs will be allowed.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required

The ID of the company.

int32
required

The ID of the onboarding process.

Body Params

The CCA settings to apply, including limitation and allowed client user IDs.

Represents the input model for configuring Custom Client Admin (CCA) access settings
for a specific onboarding process.

boolean | null
required

Indicates whether access to the onboarding should be limited to specific custom client admins.
When true, only the client users listed in Worklio.ApiModels.API.Models.Clients.Onboarding.Inputs.CCASettings_v10.CustomClientUserIds can access the onboarding.
When false, all current and future CCAs can access it automatically.

customClientUserIds
array of int32s | null

Specific client-user identifiers that should keep access to the onboarding when CCA access is limited.
This field is required only when Worklio.ApiModels.API.Models.Clients.Onboarding.Inputs.CCASettings_v10.LimitAccessForCCA is true.

customClientUserIds
Headers
string
required
Defaults to 2.0

The requested API version

string
Defaults to 2.0

The requested API version

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