Change, archive, and delete apps

Complete the authentication setup. Each step names the permission it needs; Get an app lists yours in permissions. The examples use the app from Build and deploy an app.

Change details

Changing the title, description, or icon needs build:

curl --request PATCH \
  --url "https://api.canary.effectiveai.app/api/v2/apps/app-claims-notes" \
  --header "Authorization: Bearer $EFFECTIVE_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{ "description": "Notes on open claims", "iconEmoji": "🗂️" }'

The response is the updated app. Omitted fields stay the same, and null clears one.

Archive and restore

Archiving hides the app and keeps its source, deployments, and secrets. It needs build:

curl --request POST \
  --url "https://api.canary.effectiveai.app/api/v2/apps/app-claims-notes/archive" \
  --header "Authorization: Bearer $EFFECTIVE_API_KEY"

The response is 204, and the app then returns 404. Projects scoped to the app are archived with it. Restoring needs manage, which only the app’s owner or an administrator has once it’s archived:

curl --request POST \
  --url "https://api.canary.effectiveai.app/api/v2/apps/app-claims-notes/restore" \
  --header "Authorization: Bearer $EFFECTIVE_API_KEY"

The response is 200 with the app as it was.

Delete

Deleting needs manage and can’t be undone. It removes the app’s deployments, backend, database, source, and secrets, and works on archived apps. Pass the app’s ID as confirm:

curl --request DELETE \
  --url "https://api.canary.effectiveai.app/api/v2/apps/app-claims-notes?confirm=app-claims-notes" \
  --header "Authorization: Bearer $EFFECTIVE_API_KEY"

The response is 204. If it’s 503 or lost, send the same request again; the deletion continues where it stopped.

​Change details

​Archive and restore

​Delete

Change details

Archive and restore

Delete