--- updatedAt: 2026-04-28T05:46:18.000Z agentTools: projectIndex: https://developers.intandem.tech/llms.txt --- # Update Online Profile ## Overview with `can_access_admin_account?` permission Update an existing online profile. Available for **Staff tokens**. # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "Platform_administration", "description": "Unified OpenAPI specification for platform_administration domain", "version": "3.0", "x-generated": { "sourceFiles": [ "license.json", "operator-portal.json", "directory.json", "legacy_v2_todo.json", "legacy_v1_platform.json", "legacy_v2_settings_businesses.json", "business.json", "staff.json", "staff_member.json", "oauth.json", "online_profiles.json", "partners-api.json", "staff.json", "access_control.json", "accounts.json" ], "pathNormalizations": [ { "file": "license.json", "basePath": "/v3", "transformations": [ { "original": "/license/offerings", "normalized": "/v3/license/offerings", "basePath": "/v3" }, { "original": "/license/offerings/{uid}", "normalized": "/v3/license/offerings/{uid}", "basePath": "/v3" }, { "original": "/license/directory_offerings", "normalized": "/v3/license/directory_offerings", "basePath": "/v3" }, { "original": "/license/directory_offerings/{uid}", "normalized": "/v3/license/directory_offerings/{uid}", "basePath": "/v3" }, { "original": "/license/bundled_offerings", "normalized": "/v3/license/bundled_offerings", "basePath": "/v3" }, { "original": "/license/bundled_offerings/bulk", "normalized": "/v3/license/bundled_offerings/bulk", "basePath": "/v3" }, { "original": "/license/bundled_offerings/{uid}", "normalized": "/v3/license/bundled_offerings/{uid}", "basePath": "/v3" }, { "original": "/license/subscriptions", "normalized": "/v3/license/subscriptions", "basePath": "/v3" }, { "original": "/license/subscriptions/bulk", "normalized": "/v3/license/subscriptions/bulk", "basePath": "/v3" }, { "original": "/license/subscriptions/{uid}", "normalized": "/v3/license/subscriptions/{uid}", "basePath": "/v3" }, { "original": "/license/business_carts", "normalized": "/v3/license/business_carts", "basePath": "/v3" }, { "original": "/license/business_carts/{uid}", "normalized": "/v3/license/business_carts/{uid}", "basePath": "/v3" }, { "original": "/license/skus", "normalized": "/v3/license/skus", "basePath": "/v3" }, { "original": "/license/features_packages", "normalized": "/v3/license/features_packages", "basePath": "/v3" }, { "original": "/license/features", "normalized": "/v3/license/features", "basePath": "/v3" }, { "original": "/license/features/{uid}", "normalized": "/v3/license/features/{uid}", "basePath": "/v3" }, { "original": "/license/features_packages/{id}", "normalized": "/v3/license/features_packages/{id}", "basePath": "/v3" }, { "original": "/license/features_packages/add_feature", "normalized": "/v3/license/features_packages/add_feature", "basePath": "/v3" }, { "original": "/license/quota_consumptions", "normalized": "/v3/license/quota_consumptions", "basePath": "/v3" }, { "original": "/license/quota_balances", "normalized": "/v3/license/quota_balances", "basePath": "/v3" } ] }, { "file": "operator-portal.json", "basePath": "/api/operator_api/v1", "transformations": [ { "original": "/packages", "normalized": "/api/operator_api/v1/packages", "basePath": "/api/operator_api/v1" }, { "original": "/packages/{id}", "normalized": "/api/operator_api/v1/packages/{id}", "basePath": "/api/operator_api/v1" }, { "original": "/packages/add_feature", "normalized": "/api/operator_api/v1/packages/add_feature", "basePath": "/api/operator_api/v1" }, { "original": "/features", "normalized": "/api/operator_api/v1/features", "basePath": "/api/operator_api/v1" }, { "original": "/features/{id}", "normalized": "/api/operator_api/v1/features/{id}", "basePath": "/api/operator_api/v1" } ] }, { "file": "legacy_v1_platform.json", "basePath": "/platform/v1", "transformations": [ { "original": "/businesses", "normalized": "/platform/v1/businesses", "basePath": "/platform/v1" }, { "original": "/businesses/validate_login", "normalized": "/platform/v1/businesses/validate_login", "basePath": "/platform/v1" }, { "original": "/businesses/verify_audience_claim", "normalized": "/platform/v1/businesses/verify_audience_claim", "basePath": "/platform/v1" }, { "original": "/businesses/{business_uid}", "normalized": "/platform/v1/businesses/{business_uid}", "basePath": "/platform/v1" }, { "original": "/directory/branding", "normalized": "/platform/v1/directory/branding", "basePath": "/platform/v1" }, { "original": "/tokens", "normalized": "/platform/v1/tokens", "basePath": "/platform/v1" }, { "original": "/tokens/revoke", "normalized": "/platform/v1/tokens/revoke", "basePath": "/platform/v1" }, { "original": "/webhook/subscribe", "normalized": "/platform/v1/webhook/subscribe", "basePath": "/platform/v1" }, { "original": "/webhook/unsubscribe", "normalized": "/platform/v1/webhook/unsubscribe", "basePath": "/platform/v1" }, { "original": "/webhooks", "normalized": "/platform/v1/webhooks", "basePath": "/platform/v1" }, { "original": "/businesses/{business_uid}/features", "normalized": "/platform/v1/businesses/{business_uid}/features", "basePath": "/platform/v1" }, { "original": "/businesses/{business_uid}/purchased_items", "normalized": "/platform/v1/businesses/{business_uid}/purchased_items", "basePath": "/platform/v1" }, { "original": "/businesses/{business_uid}/recurly_data", "normalized": "/platform/v1/businesses/{business_uid}/recurly_data", "basePath": "/platform/v1" }, { "original": "/businesses/{business_uid}/staffs", "normalized": "/platform/v1/businesses/{business_uid}/staffs", "basePath": "/platform/v1" }, { "original": "/businesses/{business_uid}/staffs/{staff_uid}", "normalized": "/platform/v1/businesses/{business_uid}/staffs/{staff_uid}", "basePath": "/platform/v1" }, { "original": "/businesses/{business_uid}/staffs/{staff_uid}/sessions", "normalized": "/platform/v1/businesses/{business_uid}/staffs/{staff_uid}/sessions", "basePath": "/platform/v1" }, { "original": "/businesses/{business_uid}/wizards", "normalized": "/platform/v1/businesses/{business_uid}/wizards", "basePath": "/platform/v1" }, { "original": "/businesses/{business_uid}/wizards/{wizard_name}", "normalized": "/platform/v1/businesses/{business_uid}/wizards/{wizard_name}", "basePath": "/platform/v1" }, { "original": "/scheduling/staff", "normalized": "/platform/v1/scheduling/staff", "basePath": "/platform/v1" }, { "original": "/scheduling/staff/{staff_uid}", "normalized": "/platform/v1/scheduling/staff/{staff_uid}", "basePath": "/platform/v1" }, { "original": "/business/jobber/flows", "normalized": "/platform/v1/business/jobber/flows", "basePath": "/platform/v1" }, { "original": "/business/jobber/executions", "normalized": "/platform/v1/business/jobber/executions", "basePath": "/platform/v1" } ] }, { "file": "staff.json", "basePath": "/business/staffs", "transformations": [ { "original": "/v1/daily_staff_sign_ins", "normalized": "/business/staffs/v1/daily_staff_sign_ins", "basePath": "/business/staffs" }, { "original": "/v1/staffs/{uid}", "normalized": "/business/staffs/v1/staffs/{uid}", "basePath": "/business/staffs" } ] }, { "file": "oauth.json", "basePath": "/oauth", "transformations": [ { "original": "/token", "normalized": "/oauth/token", "basePath": "/oauth" }, { "original": "/userinfo", "normalized": "/oauth/userinfo", "basePath": "/oauth" } ] }, { "file": "online_profiles.json", "basePath": "/v3/business_administration", "transformations": [ { "original": "/online_profiles/{business_uid}", "normalized": "/v3/business_administration/online_profiles/{business_uid}", "basePath": "/v3/business_administration" }, { "original": "/online_profiles", "normalized": "/v3/business_administration/online_profiles", "basePath": "/v3/business_administration" }, { "original": "/online_profiles/{uid}", "normalized": "/v3/business_administration/online_profiles/{uid}", "basePath": "/v3/business_administration" } ] }, { "file": "accounts.json", "basePath": "/business/accounts", "transformations": [ { "original": "/v1/attributes", "normalized": "/business/accounts/v1/attributes", "basePath": "/business/accounts" }, { "original": "/v1/branding", "normalized": "/business/accounts/v1/branding", "basePath": "/business/accounts" }, { "original": "/v1/identities", "normalized": "/business/accounts/v1/identities", "basePath": "/business/accounts" }, { "original": "/v1/usage/last_3_months_activity", "normalized": "/business/accounts/v1/usage/last_3_months_activity", "basePath": "/business/accounts" } ] } ], "pathConflicts": [], "componentConflicts": [ { "type": "schema", "name": "ErrorResponse", "resolution": "Renamed to ErrorResponse_operator-portal", "files": [ "merged", "operator-portal.json" ] }, { "type": "schema", "name": "ErrorResponse", "resolution": "Renamed to ErrorResponse_directory", "files": [ "merged", "directory.json" ] }, { "type": "schema", "name": "Paging", "resolution": "Renamed to Paging_business", "files": [ "merged", "business.json" ] }, { "type": "schema", "name": "ErrorResponse", "resolution": "Renamed to ErrorResponse_online_profiles", "files": [ "merged", "online_profiles.json" ] }, { "type": "schema", "name": "ErrorResponse", "resolution": "Renamed to ErrorResponse_staff", "files": [ "merged", "staff.json" ] } ], "totalPaths": 85, "totalComponents": 54 } }, "servers": [ { "url": "https://api.vcita.biz", "description": "Unified API Gateway server" } ], "paths": { "/v3/business_administration/online_profiles/{uid}": { "put": { "summary": "Update Online Profile", "description": "## Overview\nwith `can_access_admin_account?` permission Update an existing online profile. Available for **Staff tokens**.", "operationId": "updateOnlineProfile", "parameters": [ { "name": "uid", "in": "path", "required": true, "description": "The unique identifier of the online profile.", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateOnlineProfileRequest" }, "examples": { "update_languages": { "summary": "Update supported languages only", "value": { "supported_languages": [ "en", "es", "de" ] } }, "set_privacy_policy": { "summary": "Set privacy policy URL", "value": { "privacy_policy_url": "https://newsite.com/privacy-policy" } }, "clear_policy_empty": { "summary": "Clear privacy policy (empty string)", "value": { "privacy_policy_url": "" } }, "clear_policy_null": { "summary": "Clear privacy policy (null)", "value": { "privacy_policy_url": null } } } } } }, "responses": { "200": { "description": "Online profile updated successfully.", "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "success": { "type": "boolean", "description": "Indicates whether the API request was successful (true) or failed (false)." }, "data": { "type": "object", "description": "The response payload. Present on successful responses (success: true)." }, "error": { "type": "string", "description": "Error message for simple error responses. Used in some legacy endpoints." }, "errors": { "type": "array", "description": "Array of error objects for detailed error responses. Present on error responses (success: false).", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code (e.g., 'already_exists', 'invalid', 'not_found')." }, "message": { "type": "string", "description": "Human-readable error message." }, "field": { "type": "string", "description": "The field that caused the error (for validation errors)." } }, "required": [ "code", "message" ] } } }, "required": [ "success" ], "description": "Generic wrapper object for API responses. Success responses contain 'data', while error responses contain 'errors' array or 'error' string." }, { "properties": { "data": { "type": "object", "description": "Online profile configuration for a business. Contains settings for client-facing features like supported languages and privacy policy used by the Client Portal. This is a singleton resource - each business has at most one online profile.", "properties": { "uid": { "type": "string", "readOnly": true, "description": "Unique identifier for the online profile record." }, "business_uid": { "type": "string", "description": "Unique identifier of the business that owns this online profile." }, "supported_languages": { "type": "array", "description": "List of ISO 639-1 language/locale codes supported by the business for client-facing content (e.g., [\"en\", \"es\", \"en-GB\"]).", "items": { "type": "string", "pattern": "^[a-z]{2}(-[A-Z]{2})?$" }, "uniqueItems": true }, "privacy_policy_url": { "type": "string", "maxLength": 2048, "format": "uri", "nullable": true, "description": "External URL to the business's privacy policy page (e.g., \"https://example.com/privacy\"). Null if not configured." }, "created_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "The date and time when the online profile was created, in ISO 8601 format." }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "The date and time when the online profile was last updated, in ISO 8601 format." } }, "example": { "uid": "abc123", "business_uid": "d290f1ee26c54", "supported_languages": [ "en", "es" ], "privacy_policy_url": "https://example.com/privacy", "created_at": "2026-01-12T10:30:00Z", "updated_at": "2026-01-12T10:30:00Z" } } } } ] }, "example": { "success": true, "data": { "uid": "abc123", "business_uid": "d290f1ee26c54", "supported_languages": [ "en", "es" ], "privacy_policy_url": "https://newsite.com/privacy-policy", "created_at": "2026-01-12T10:30:00Z", "updated_at": "2026-01-12T14:00:00Z" } } } } }, "401": { "description": "Unauthorized - Client token or missing authentication", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "success": false, "errors": [ { "code": "unauthorized", "message": "Client is not authorized" } ] } } } }, "403": { "description": "Forbidden - Staff token lacks required permission", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "success": false, "errors": [ { "code": "forbidden", "message": "Access denied" } ] } } } }, "404": { "description": "Not Found - Online profile not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "success": false, "errors": [ { "code": "not_found", "message": "Online profile not found" } ] } } } }, "422": { "description": "Unprocessable Entity - Validation error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "success": false, "errors": [ { "field": "privacy_policy_url", "code": "invalid", "message": "URL must be a valid HTTP or HTTPS URL" } ] } } } } }, "tags": [ "Online Profiles" ], "security": [ { "Bearer": [] } ] } } }, "components": { "schemas": { "ErrorResponse": { "type": "object", "description": "Standard error response format.", "properties": { "success": { "type": "boolean", "example": false }, "errors": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string", "description": "Human-readable error message." }, "code": { "type": "string", "description": "Error code for programmatic handling." }, "field": { "type": "string", "description": "The field that caused the error (if applicable)." } } } } } }, "UpdateOnlineProfileRequest": { "type": "object", "properties": { "supported_languages": { "type": "array", "description": "List of ISO 639-1 language/locale codes supported by the business for client-facing content (e.g., [\"en\", \"es\", \"en-GB\"]).", "items": { "type": "string", "pattern": "^[a-z]{2}(-[A-Z]{2})?$" }, "uniqueItems": true }, "privacy_policy_url": { "type": "string", "format": "uri", "maxLength": 2048, "nullable": true, "description": "External URL to the business's privacy policy page. Set to empty string or null to clear. Omit to leave unchanged." } } } }, "securitySchemes": { "Bearer": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT", "description": "Provide a valid bearer token in the Authorization header. Example: 'Authorization: Bearer {app_token}'" } } } } ```