Skip to main content
PUT
Update App Custom Data

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

app_id
string<uuid>
required
file_id
string<uuid>
required

Body

application/json
file_name
string | null
active
boolean | null
labels
string<uuid>[] | null

Response

Successful Response

tenant_id
string<uuid>
required

The ID of the tenant to store this data in

file_name
required

The name of the file

Required string length: 1 - 2083
data_type
enum<string>
required

The type of custom data (file, url, ...)

Available options:
file,
url
id
string<uuid> | null

The ID

app_id
string<uuid> | null

The ID of the app to store this data in

carbon_object_id

The ID of the object in Carbon

carbon_data_source_type
string | null

The type of the data source in Carbon

carbon_last_synced_on
string<date-time> | null

The timestamp the file was last synced from Carbon

file_mime
string | null

The mimetype of the file

file_size
integer | null

The size of the file in Bytes

external_url

The external URL to the file

Required string length: 1 - 2083
active
boolean
default:true

Indicates if the data source will be included in queries

state
enum<string>
default:PENDING

The state of the file

Available options:
CREATED,
PENDING,
QUEUED,
QUEUED_FOR_RECONCILIATION,
SYNC_FAILED,
FAILED,
INDEXED,
DELETING
labels
AppLabel · object[]

The labels associated with the file

added_on
string<date-time>

The timestamp the file was added

modified_on
string<date-time> | null

The timestamp the file was last modified

deleted_on
string<date-time> | null

The timestamp the file was added