Sign in

v1

latestSwagger 2.02026-08-04244186228.2 KB
app instances

Patch an app given its identifier

patch/v1/apps/{app_id}

Headers

X-Fieldsstring mask

An optional fields mask

Request body

appNamestring

Name of the app

templateNamestring

The class of the app instance

projectNamestring
metadataobject
appParamsobject
appMetricsobject
canoticCrowdboolean
statusstring
constraintsobject
dpWorkflowsstring[]
selectedWorkflowstring
cancelAndRelabelJobsInStatestring[]
visibility'PRIVATE' | 'PUBLIC'

Example request

{
  "cancelAndRelabelJobsInState": [
    "UNPROCESSED"
  ],
  "visibility": "PRIVATE",
  "settings": {
    "inboxSettings": {
      "emailExtractionMode": "ONLY_ATTACHMENTS",
      "emailMarkJobWithMetadataMode": "NO_METADATA"
    },
    "reviewSettings": {
      "autoAccept": {
        "type": "Days"
      }
    },
    "webhookSettings": {
      "method": "POST"
    }
  }
}

Response

Success

namestring

Name of the app

templateNamestring

The class of the app instance

projectNamestring
metadataobject
appParamsobject
appMetricsobject
canoticCrowdboolean
constraintsobject
dpWorkflowsstring[]
selectedWorkflowstring
visibility'PRIVATE' | 'PUBLIC'
uuidstring

The app instance unique identifier

createdstring

time the app was created

statusstring
appParamsHistoryobject
appMetricsHistoryobject
job_statsobject
ownerEmailstring
enterpriseboolean
ownerIdinteger
workerRole'LABELER' | 'REVIEWER'
rolestring
ownerType'USER' | 'ORGANIZATION'
ownerUsernamestring
inputSchemaobject
inputUiSchemaobject
outputSchemaobject
outputUiSchemaobject
settingsobject
batchIdstring
operationIdinteger

Example response

{
  "visibility": "PRIVATE",
  "workerRole": "LABELER",
  "ownerType": "USER"
}