Tolgee Octri Demo
PUT/v2/quick-start/steps/{step}/complete

Complete a quick-start guide step

Marks a step in the quick-start guide as completed. Supply the step identifier in step to record its completion and retrieve the guide's updated state.

1 parameter
stepstringrequired
The identifier of the quick-start guide step to mark as completed.

5 status codes
200Returns the quick-start guide state, including the completed steps and current `finished` and `open` values.
completedStepsarray<string>required
finishedbooleanrequired
openbooleanrequired
400Returned when the request is invalid.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
401Returned when authentication is missing or invalid.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
403Returned when the authenticated user does not have access to this resource.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
404Returned when the requested resource is not found.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional

Error handling

The step path parameter must identify the guide step to complete. A 400 indicates an invalid request, a 401 indicates missing or invalid authentication, a 403 indicates insufficient access, and a 404 indicates that the requested resource was not found.