Update Business

post

https://api.vcita.biz/platform/v1/businesses/{business_uid}

Overview

Updates an existing business. This endpoint allows updating business information, admin account details, integrations, and subscription plan. Only provided fields will be updated.

Available for Directory & Internal Tokens.

Note: Directory Tokens require the directory to be configured with manual billing. Staff Tokens may work for businesses not associated with a directory and with non-Recurly subscriptions.

Responses

Language

Credentials

Bearer

JWT

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Business updated successfully. Returns the updated business information including admin account, business details, integrations, and subscription plan.

400Bad Request - Invalid parameters provided for business update. The request contains invalid or missing required fields, or validation errors occurred.

401Unauthorized - The provided token type is not authorized for this endpoint. This endpoint requires Directory or Internal tokens. Staff tokens are not permitted.

404Not Found - The specified business ID does not exist or you do not have permission to access it.

500Internal Server Error - An unexpected error occurred while processing the request.