Skip to main content
PATCH
/
v0
/
business
/
{business_id}
Update a Business
curl --request PATCH \
  --url https://api.sandbox.getasset.com/v0/business/{business_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "New Roofing Pros",
  "status": "active",
  "plaid_user_token": "user-sandbox-067d33a3-b015-76b0-8000-9b6e63d60ac4",
  "onboarding_date": "2023-12-25"
}
'
{
  "data": {
    "tenant_id": "<string>",
    "name": "<string>",
    "industry": "<string>",
    "entries_start": "2023-11-07T05:31:56Z",
    "entity_type": "c-corp",
    "fiscal_year": "<string>",
    "plaid_user_token": "<string>",
    "external_id": "<string>",
    "id": "<string>",
    "status": "active",
    "onboarding_date": "2023-12-25"
  }
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
business_id
string<biz_string>
required

Body

application/json
​
name
string | null

The updated name of the Business

Maximum string length: 255
Example:

"New Roofing Pros"

​
status
enum<string> | null

The updated status of the Business

Available options:
active,
inactive
Example:

"active"

​
plaid_user_token
string | null

The Plaid user token for the Business

Maximum string length: 255
Example:

"user-sandbox-067d33a3-b015-76b0-8000-9b6e63d60ac4"

​
onboarding_date
string<date> | null

The date the business was onboarded

Response

Successful Response

​
data
BusinessPublic · object
required