API Reference

Set Setup Completed

post
https://api.vcita.biz/v1/partners/accounts//set_setup_completed

Overview

Mark an account's setup/onboarding as completed. This suspends the account's "to do" list (onboarding wizard).

Available for Directory tokens only.

Authentication

Uses HTTP Token authentication (not Bearer). Format: Authorization: Token token="{DIRECTORY_TOKEN}"

The token must be a Doorkeeper OAuth token with directory scope.

How It Works

  1. The endpoint looks up the business in the directory's members using pivots.uid
  2. Calls member.setup_completed! to mark setup as done
  3. Updates the member's setup attribute to setup_completed

Important: The business_uid must be the business UID (alphanumeric like '88pzdbz1hmkdoel4'), NOT a numeric database ID. The business must be a member of the directory associated with the token.

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

The business UID (alphanumeric string like '88pzdbz1hmkdoel4'). This maps to pivots.uid in the database. The business must be a member of the directory associated with the directory token.

Headers
string
required

HTTP Token authentication. Format: Token token="{DIRECTORY_TOKEN}". The token must have directory scope.

Responses

Updated 6 days ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 days ago