1. Docs
  2. API Reference
  3. Update the Application name or settings

Update the Application name or settings

PATCH/portal/v1/accounts/{accountSlug}/applications/{appSlug}

Authentication

  • Bearer Token Authorization

    JWT access token

Headers

  • if-match required

Request body

  • namestring

Code samples

cURLJavaScriptPythonGo
curl -X PATCH "https://api.canopy.dev/portal/v1/accounts/{accountSlug}/applications/{appSlug}" \
  -H "if-match: value" \
  -H "Authorization: Bearer $CANOPY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string"
  }'

Responses

200 Application updated
{
  "id": "string",
  "account_id": "string",
  "name": "string",
  "slug": "string",
  "settings": {},
  "version": 0,
  "created_at": "2026-04-20T12:00:00.000Z",
  "updated_at": "2026-04-20T12:00:00.000Z"
}

application/json

  • idstring*
  • account_idstring*
  • namestring*
  • slugstring*
  • settingsany object*
  • versionnumber*
  • created_atstring (date-time)*
  • updated_atstring (date-time)*
401 Invalid or expired token
403 This token is not authorized for this endpoint (wrong principal type — e.g., admin token on identity-only endpoint, or vice versa)
409 Application has been modified since the requested version was read

Returned object

On this page

Related endpoints

GETGet the current Application
DELETEDelete an Application
PUTSet the App's default Environment
GETGet the admin's resume-state for this Application
PUTUpdate the admin's resume-state for this Application