PUT
/
apps
/
{appId}
curl --request PUT \
  --url https://api.us.vartiq.com/apps/{appId} \
  --header 'Content-Type: application/json' \
  --header 'companyid: <companyid>' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "name": "<string>",
  "description": "<string>"
}'
{
  "success": true,
  "message": "<string>",
  "data": {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "environment": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>"
  }
}

Headers

companyid
string
required

The unique identifier of your company

URL Parameters

appId
string
required

The unique identifier of the app to update

Body Parameters

name
string

New name for the app

description
string

New description for the app

Response

success
boolean

Indicates if the request was successful

message
string

A message describing the result of the operation

data
object

The updated app object

Response Example

{
  "success": true,
  "message": "App updated successfully",
  "data": {
    "id": "app_01JT38PHYK11F3X3M4772HE3TK",
    "name": "hello app",
    "description": "hello1",
    "environment": "development",
    "createdAt": "2025-04-30T11:53:17.020Z",
    "updatedAt": "2025-04-30T11:53:44.548Z"
  }
}
PUT
/
apps
/
{appId}
curl --request PUT \
  --url https://api.us.vartiq.com/apps/{appId} \
  --header 'Content-Type: application/json' \
  --header 'companyid: <companyid>' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "name": "<string>",
  "description": "<string>"
}'
{
  "success": true,
  "message": "<string>",
  "data": {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "environment": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>"
  }
}

Headers

companyid
string
required

The unique identifier of your company

URL Parameters

appId
string
required

The unique identifier of the app to update

Body Parameters

name
string

New name for the app

description
string

New description for the app

Response

success
boolean

Indicates if the request was successful

message
string

A message describing the result of the operation

data
object

The updated app object

Response Example

{
  "success": true,
  "message": "App updated successfully",
  "data": {
    "id": "app_01JT38PHYK11F3X3M4772HE3TK",
    "name": "hello app",
    "description": "hello1",
    "environment": "development",
    "createdAt": "2025-04-30T11:53:17.020Z",
    "updatedAt": "2025-04-30T11:53:44.548Z"
  }
}