API Reference

Add/Remove staff

get deprecated
https://api.vcita.biz/v1/partners/accounts//change_addons

Deprecated

This endpoint is deprecated. Addon management is now handled by the Subscription API. Please migrate all integrations to use the Subscription API endpoints for adding or removing staff and other addon changes.

Overview

Add or remove the staff members quota from accounts under your directory.

Available for Directory tokens only. This endpoint is only available for manually billed directory accounts.

Authentication

Uses HTTP Token authentication. Format: Authorization: Token token="{DIRECTORY_TOKEN}"

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

Note: The business_uid parameter should contain the business UID (alphanumeric like '88pzdbz1hmkdoel4'), not the numeric database ID.

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'). The business must be a member of the directory associated with the directory token.

Query Params
string
required

Number of staff for adding/removing from the account (use minus value for removing)

Headers
string
required

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

Responses

Updated 2 months ago

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

Updated 2 months ago