We're moving the community! Starting July 7, the current community will be read-only for approx. 2 weeks. You can browse content, but posting will be temporarily unavailable. Learn more

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

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

HuynhKim
Shopify Partner
2 0 1

Hi All,

 

HuynhKim_0-1708603129159.png

 

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

 

 

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?

 

Replies 7 (7)

Angel3llideas
Shopify Partner
6 0 1

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.

jessehoek
Shopify Staff
2 1 2

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

To learn more visit the Shopify Help Center or the Community Blog.

Angel3llideas
Shopify Partner
6 0 1

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

 

Thank you!

Nexzer
Shopify Partner
9 0 3

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

justbuild
Shopify Partner
6 1 2

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.

vashisth00
Shopify Partner
2 0 2

Same even I am unable to fix it 

BenHarkins
Shopify Partner
18 0 4

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