API Reference

Create Online Profile

post
https://api.vcita.biz/v3/business_administration/online_profiles

Overview

Create a new online profile for the business. Requires can_access_admin_account? permission. Available for Staff tokens.

Important: Online profiles are singleton resources - each business can only have one online profile. If a profile already exists, this endpoint returns a 422 error with code already_exists. Use the PUT endpoint to update an existing profile.

Note: Online profiles cannot be deleted, only updated.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
supported_languages
array of strings

List of ISO 639-1 language/locale codes supported by the business for client-facing content (e.g., ["en", "es", "en-GB"]).

supported_languages
uri
length ≤ 2048

External URL to the business's privacy policy page (e.g., "https://example.com/privacy"). Optional.

Responses

Updated 3 months ago

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

Updated 3 months ago