API Reference

Updates Custom Client Admin (CCA) access settings for the specified onboarding process.

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

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.

boolean | null
required

Indicates whether access to the onboarding process should be limited to specific CCAs. If true, only the client users listed in Worklio.ApiModels.API.Models.Clients.Onboarding.Inputs.CCASettings_v10.CustomClientUserIds will have access. If false, all current and future CCAs will have access automatically.

customClientUserIds
array of int32s | null

A list of specific client user IDs who should have access to the onboarding process. This field is required only when Worklio.ApiModels.API.Models.Clients.Onboarding.Inputs.CCASettings_v10.LimitAccessForCCA is true.

customClientUserIds
Headers
string
Defaults to 1.0

The requested API version

string
Defaults to 1.0

The requested API version

Responses

Updated 5 days 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 5 days ago