---
updatedAt: 2026-04-28T05:46:18.000Z
agentTools:
  projectIndex: https://developers.intandem.tech/llms.txt
---

# Close an Account

## Overview
Close an existing account under your directory.

Available for **Directory tokens only**.

## 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` must be the business UID (alphanumeric like '88pzdbz1hmkdoel4'), not a numeric database ID.

# 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": {
    "/v1/partners/accounts/{business_uid}/close": {
      "post": {
        "summary": "Close an Account",
        "description": "## Overview\nClose an existing account under your directory.\n\nAvailable for **Directory tokens only**.\n\n## Authentication\nUses HTTP Token authentication. Format: `Authorization: Token token=\"{DIRECTORY_TOKEN}\"`\n\nThe token must be a Doorkeeper OAuth token with `directory` scope.\n\n> **Note**: The `business_uid` must be the business UID (alphanumeric like '88pzdbz1hmkdoel4'), not a numeric database ID.",
        "operationId": "close-an-account",
        "tags": [
          "Partners API"
        ],
        "parameters": [
          {
            "name": "business_uid",
            "in": "path",
            "description": "The business UID (alphanumeric string like '88pzdbz1hmkdoel4'). The business must be a member of the directory associated with the directory token.",
            "schema": {
              "type": "string"
            },
            "required": true,
            "example": "88pzdbz1hmkdoel4"
          },
          {
            "name": "Authorization",
            "in": "header",
            "description": "HTTP Token authentication. Format: `Token token=\"{DIRECTORY_TOKEN}\"`. The token must have `directory` scope.",
            "required": true,
            "schema": {
              "type": "string"
            },
            "example": "Token token=\"aaaabbbbccccddddeeeeffff11112222\""
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"business_id\": \"112233aabbcc\"\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "business_id": {
                      "type": "string",
                      "example": "112233aabbcc"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "401",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "HTTP Token: Access denied.\n"
                  }
                }
              }
            }
          },
          "422": {
            "description": "422",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "Bad parameter(s), see content for more information.\n"
                  }
                }
              }
            }
          }
        },
        "deprecated": false,
        "security": []
      }
    }
  }
}
```