Skip to main content
PUT
/
v0
/
platform
/
instances
/
{instance_id}
Update an Instance
curl --request PUT \
  --url https://api.sandbox.teal.dev/v0/platform/instances/{instance_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "entries_start": "2024-01-01T00:00:00Z",
  "name": "ACME Goods Inc",
  "parent_id": "Kv7sp6Y1gAH2vfNxAWemRy",
  "clear_fields": [
    "parent_id"
  ]
}
'
{
  "id": "<string>",
  "entries_start": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "subscription": "tier0",
  "accounting_package": "platformgl",
  "parent_id": "Kv7sp6Y1gAH2vfNxAWemRy",
  "child_ids": "['A5SswbYm7eZM2ec5q7Hm2t']",
  "parent": "<unknown>",
  "children": [
    "<unknown>"
  ]
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
instance_id
string
required

The instance ID

Body

application/json
​
entries_start
string<date-time> | null

The datetime in UTC time from which the API will sync an Instance's accounting data. Transactions or journal entries cannot be entered before this date.

Example:

"2024-01-01T00:00:00Z"

​
name
string | null

The name of the business.

Example:

"ACME Goods Inc"

​
parent_id
string | null

The ID of the Instance's parent.

Example:

"Kv7sp6Y1gAH2vfNxAWemRy"

​
clear_fields
enum<string>[] | null

A list of fields to be cleared.

Available options:
parent_id
Example:
["parent_id"]

Response

Successful Response

​
id
string
required

The unique ID of the object.

​
entries_start
string<date-time>
required

The datetime in UTC time from which the API will sync an Instance's accounting data. Transactions or journal entries cannot be entered before this date.

​
name
string
required

The name of the business.

​
subscription
enum<string>
required

The Instance's subscription tier.

Available options:
tier0,
tier1,
tier2,
tier3,
tier4,
tier5
​
accounting_package
enum<string>
required

The type of accounting package the Instance uses as the source of truth for their books.

Available options:
platformgl,
quickbooks
​
parent_id
string | null

The ID of the Instance's parent.

Example:

"Kv7sp6Y1gAH2vfNxAWemRy"

​
child_ids
string[] | null

The IDs of the Instance's children.

Example:

"['A5SswbYm7eZM2ec5q7Hm2t']"

​
parent
any | null

The Instance's parent. Included in expanded responses.

​
children
any[] | null

The Instance's children. Included in expanded responses.