Use of arrays when working with Shortcut (formerly Clubhouse) where format as used in documentation isn't acceptable?

đŸŒ± Just Getting Started
, ,
1

First-time user of Postman, FWIW.

I’m attempting to update story labels on Shortcut (formerly Clubhouse) cards. Looking at Shortcut’s documentation, the params need to be an array. The story_public_id is for a story that definitely exists (it’s updated in a previous request).

Shortcut documentation with example:

Screen Shot 2021-10-07 at 10.37.29 AM
Screen Shot 2021-10-07 at 10.37.29 AM804×503 72.8 KB

Screen Shot 2021-10-07 at 10.37.37 AM
Screen Shot 2021-10-07 at 10.37.37 AM768×62 6.58 KB

None of the label params are required.

Using the same formatting as in Shortcut’s documentation, I get the following error:

{"message":"The request included invalid or missing parameters.","errors":{"labels":["not",["sequential?","a-java.lang.String"]]}}

Screen Shot 2021-10-07 at 10.50.07 AM
Screen Shot 2021-10-07 at 10.50.07 AM1484×382 46.2 KB

I’ve also tried running the request by changing the value to see if any variations might work, but no dice.

  • with OR without braces AND with brackets AND with “”
  • no braces with brackets AND with “”
  • braces without brackets AND with “”
  • braces and brackets, no “” around ‘description’, “” around ‘testyLabel’
  • braces and brackets with no “” around ‘description’ AND no “” around ‘testyLabel’
  • braces and brackets, no “” around ‘testyLabel’, “” around ‘description’

Also went through the same variations of quotes around values with and without braces and brackets, same result.

I’ve contacted Shortcut support; they said that the request looks correct to them. TIA for any advice!

2

Isn’t labels party of the request body in the example curl?

Did you manually create that request in Postman or take the example curl and import it?

3

Yes, that’s the example from Shortcut’s documentation. I did import the curl to test it but that was no use either. The request in Postman in the screenshots above was manually created.

4

If this is the documentation that you were looking at Shortcut Rest API, V3

Importing the curl example request on the page using the Import > Raw text feature, would then create the request in a new tab for you.

It’s then just a case of changing the payload to suit your needs.

image
image2350×2426 362 KB

It looks like you were trying to add these as a Query Param rather than in the request body.