Update Account API


With Update Account API you can update various business details such as:

  • Business information - Address, Phone, Country, TimeZone etc
  • User information - Name, Email, Phone, Language etc
  • Category \ Identities - Business verticals
  • Branding - Business colors, Logo and Pictures
  • Plan - Business subscription details:
    -- External subscription params - external parameters relevant to the partner
    -- Plan Name - plan name in vcita
    -- Staff Slot - If staff_slots parameter is not sent the account will get the default value of staff slots configured in the plan. Otherwise if the parameter is sent, the number of staff slots in the business will be set from this value.

🚧

Note

Each request to update the business plan creates a new record, hence if you wish to keep some of the values from the old plan make sure to send them in the request as well (i.e. external_subscription_params, staff_slots)


Example of account update API where we only update the account's plan:

curl --request POST \
     --url https://api.vcita.biz/platform/v1/businesses/{{BUSINESS_ID}} \
     --header 'Accept: application/json' \
     --header 'Authorization: Bearer {{AUTHORIZATION_TOKEN}}' \
     --header 'Content-Type: application/json' \
     --data @- <<EOF
{
     "business": {
            "meta": {
               "plan": {
                    "plan_name": "PLAN_NAME"
               }
          }
     }
}