Complete An Onboarding Step

This endpoint mark completed a specific onboarding step. Some steps do not allow this api call to be performed. In particular for the "contents" and "categories" steps use the api call Start An Onboarding Step. Step status should be "not_started" or "failed".

info

This operation requires authentication. The logged user must be the creator of the community (id=1).

warning

The onboarding APIs are not available for Enterprise plans.

HTTP Request

POST /api/v2/onboarding/{id}/complete/

Parameters

Name	In	Type	Required	Description
id	path	integer	true	A unique integer value identifying this onboarding step

Example Request

JavaScript

const headers = {
  'Content-Type':'application/x-www-form-urlencoded',
  'Accept':'application/json',
  'Authorization': 'Bearer {access_token}'
};

fetch('/api/v2/onboarding/{id}/complete/',
{
  method: 'POST',
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Bash

# You can also use wget
curl -X POST /api/v2/onboarding/{id}/complete/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access_token}'

Responses

Status	Meaning	Description	Schema
200	OK	Response status code	Onboarding Step