---
title: "Patch an app given its identifier"
method: PATCH
path: "/v1/apps/{app_id}"
tags: ["app instances"]
---

# Patch an app given its identifier

`PATCH /v1/apps/{app_id}`

## Headers

- `X-Fields` string, mask

## Request body

- AppInput
  - `appName` string — Name of the app
  - `templateName` string — The class of the app instance
  - `projectName` string
  - `metadata` object
  - `appParams` object
  - `appMetrics` object
  - `canoticCrowd` boolean
  - `status` string
  - `constraints` object
  - `dpWorkflows` string[]
  - `selectedWorkflow` string
  - `cancelAndRelabelJobsInState` string[]
  - `visibility` 'PRIVATE' | 'PUBLIC'
  - `superTasks` SuperTask[]
    - `parameters` object
    - `workers` object
    - `superTaskWorkflow` string
    - `parametersSchema` object
    - `workersSchema` object
  - `settings` AppSettings
    - `postProcessing` boolean
    - `downloadSettings` DownloadAppSettings
      - `customFileNameKeys` string[]
      - `expandOutputColumns` boolean
      - `includeMessages` boolean
      - `includeAnnotations` boolean
      - `flattenTables` boolean
      - `excludeHeaderRow` boolean
      - `fieldDelimiter` string
      - `quoteValues` boolean
      - `sendEmail` boolean
      - `saveSettings` boolean
    - `ttlSettings` AppTTLSettings
      - `onCompleted` TTLSettings
        - `enabled` boolean
        - `ttlInSeconds` integer
    - `inboxSettings` InboxAppSettings
      - `allowedEmails` string[]
      - `callbackUrl` string
      - `emailExtractionMode` 'ONLY_ATTACHMENTS' | 'ONLY_BODY' | 'BODY_AND_ATTACHMENTS'
      - `emailMarkJobWithMetadataMode` 'NO_METADATA' | 'RANDOM_UUID' | 'EMAIL_SENDER_EMAIL_ID'
    - `reviewSettings` AppReviewSettings
      - `autoAccept` ReviewAutoAccept
        - `type` 'Days' | 'Weeks' | 'Months'
        - `value` integer
      - `acceptViewed` boolean
      - `reviewBlank` boolean
      - `reviewFailed` boolean
      - `randomPercentage` integer
      - `tags` string[]
      - `thresholds` number[]
      - `validateChangesAfterReview` boolean
    - `webhookSettings` WebhookSettings
      - `callbackUrl` string
      - `method` 'POST' | 'PATCH' | 'PUT'
      - `sendBatchEvents` boolean
    - `allowProcessRepairedPDFs` boolean

## Response `200`

Success

- AppBatchIdOperationId
  - `name` string — Name of the app
  - `templateName` string — The class of the app instance
  - `projectName` string
  - `metadata` object
  - `appParams` object
  - `appMetrics` object
  - `canoticCrowd` boolean
  - `constraints` object
  - `dpWorkflows` string[]
  - `selectedWorkflow` string
  - `visibility` 'PRIVATE' | 'PUBLIC'
  - `superTasks` SuperTask[]
    - `parameters` object
    - `workers` object
    - `superTaskWorkflow` string
    - `parametersSchema` object
    - `workersSchema` object
  - `uuid` string — The app instance unique identifier
  - `created` string — time the app was created
  - `status` string
  - `appParamsHistory` object
  - `appMetricsHistory` object
  - `job_stats` object
  - `ownerEmail` string
  - `enterprise` boolean
  - `ownerId` integer
  - `workerRole` 'LABELER' | 'REVIEWER'
  - `role` string
  - `ownerType` 'USER' | 'ORGANIZATION'
  - `ownerUsername` string
  - `inputSchema` object
  - `inputUiSchema` object
  - `outputSchema` object
  - `outputUiSchema` object
  - `settings` object
  - `batchId` string
  - `operationId` integer

## Other responses

- `202` — Success
- `404` — App not found

---

[API](https://skmtc.net/super/apis/super-ai-api.md) · [All operations](https://skmtc.net/super/apis/super-ai-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/super/super-ai-api/versions/0d125680e232/schema)