This section is useful if you want to synchronize your users’ onboarding progress through a server-side API request.

This endpoint allows you to mark an onboarding task as “completed” for a user in your application.

Request

1. Details

Endpoint URL https://api.clice.app/ext/public/onboarding/taskCompleted
Method POST
Header 0 "Content-type": "application/json"
Header 1 "apiKey": "YOUR_API_KEY"
Header 2 "appId": "YOUR_APP_ID"

2. Body

Field name Type Required Description
cuId string yes The ID of the concerned user.
taskTitle string yes The title of the completed task.
onboardingName string yes The unique name of the related onboarding.

3. Example request

fetch("<https://api.clice.app/ext/public/onboarding/taskCompleted>", {
    method: "POST",
    headers: {
        "Content-type": "application/json",
        "apiKey": "0fc11e67-f2ce-490d-9794-b4fe7232b67e",
        "appId": "1ce82385-59e6-4887-8b97-40d97ae5b020",
    },
    body: JSON.stringify({
        cuId: "6818b732dec2323cdbda2278",
        taskTitle: "Add a friend",
        onboardingName: "My onboarding",
    }),
});

Response

1. Details

Field name Type
statusCode number
success boolean
message string
onboardingFinished number

Possible values for onboardingFinished

Value Meaning
0 The user’s onboarding is not completed.
1 The user’s onboarding is completed.
2 The system cannot determine whether the onboarding is completed (error in the route).