How do I correctly update the app handle in a TOML file?

English Shopify Shopify Apps
1

Hi All,

HuynhKim_0-1708603129159.png
HuynhKim_0-1708603129159.png1024×284 16.1 KB

I’m a newbie Shopify app dev. How do i update app handle from TOML file? In this doc https://shopify.dev/docs/apps/tools/cli/configuration#global mentioned an option “handle” at the same place with “name, client_id” but when I try add this option the result when run “npm run deploy” as below:

HuynhKim_0-1708601801212.png
HuynhKim_0-1708601801212.png1811×1011 104 KB

error 
│                                                                                                                                                │
│  Fix a schema error in shopify.app.toml:                                                                                                       │
│  [                                                                                                                                             │
│    {                                                                                                                                           │
│      "code": "unrecognized_keys",                                                                                                              │
│      "keys": [                                                                                                                                 │
│        "handle"                                                                                                                                │
│      ],                                                                                                                                        │
│      "path": [],                                                                                                                               │
│      "message": "Unrecognized key(s) in object: 'handle'"                                                                                      │
│    }                                                                                                                                           │
│  ]

So, What schema structure for this option “handle” is correct?

2

We are facing the same problem.
Also, we tested with a very random ‘handle’ value, to verify that no other app has the same handle, but the error is the same.

3

Hi there, what version of Shopify CLI are you using? You may need to upgrade to the latest version.

1 Like
4

We were running 3.51.0, after upgrade to the last version, 3.56.3, the handle can be changed.

Thank you!

5

Hi @jessehoek

I am still not able to update our app handle.

I have tried updating the the newest version and some of the other recent CLI versions and I still get the error of “message”: “Unrecognized key(s) in object: ‘handle’”.

I am currently trying to use v3.63.2

6

When I tried to run the below command after I updated the Shopify CLI to the current latest version - 3.66.1:

shopify app generate extension

I still got the error with the message "Unrecognized key(s) in object: ‘webhooks’".

However, I managed to solve it by simply commenting out webhooks section first, and then run the command above again.

1 Like
7

Same even I am unable to fix it

8

It looks like handle only gets updated when you release a new version (after switching configs). I switched the handle, ran my production deployment, and the handle updated

With the Shopify CLI:

  • shopify app config use
    • select your production config, with the updated handle
  • shopify app deploy
    • updated handle now appears in the admin
1 Like