PUT
/
v1
/
apps
/
custom-data
/
{app_id}
/
files
/
{file_id}
curl --request PUT \
  --url https://api.pulze.ai/v1/apps/custom-data/{app_id}/files/{file_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "file_name": "<string>",
  "active": true,
  "labels": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "app_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "carbon_object_id": "<string>",
  "carbon_data_source_type": "<string>",
  "carbon_last_synced_on": "2023-11-07T05:31:56Z",
  "file_name": "<string>",
  "file_mime": "<string>",
  "file_size": 123,
  "external_url": "<string>",
  "data_type": "file",
  "active": true,
  "state": "PENDING",
  "labels": [
    {
      "name": "<string>",
      "description": "<string>",
      "color": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "added_on": "2023-11-07T05:31:56Z",
  "modified_on": "2023-11-07T05:31:56Z",
  "deleted_on": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
app_id
string
required
​
file_id
string
required

Body

application/json
​
file_name
string | null
​
active
boolean | null
​
labels
string[] | null

Response

200
application/json
Successful Response
​
tenant_id
string
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 | null

The ID

​
app_id
string | 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 | 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>

The state of the file

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

The labels associated with the file

​
added_on
string

The timestamp the file was added

​
modified_on
string | null

The timestamp the file was last modified

​
deleted_on
string | null

The timestamp the file was added

Was this page helpful?

Raise issue
Space Upload Custom DataSpace Delete Custom Data