Skip to content

update

POST
/list-share/{id}

Updates a list share.

Authorizations

Parameters

Path Parameters

id
required
string
>= 15 characters <= 15 characters

List Share Id

Example
6vcudpc4wgc0ckk

Query Parameters

requestKey
string

Unique request key. Prevents auto cancel when sending multiple requests.

Request Body

object
permission
string
Allowed values: view edit
Example
{
"permission": "view"
}

Responses

200

object
collectionId
required
string
collectionName
required
string
created
required
string
id
required
string
list
required
string
permission
required
string
updated
required
string
user
required
string
Examples

Success

{
"collectionId": "1kot7t9na3hi0gl",
"collectionName": "list_share",
"created": "2025-01-03 10:36:23.596Z",
"id": "r8r938af52vdae1",
"list": "dci7qk44birm2bn",
"permission": "edit",
"updated": "2025-01-03 10:39:28.597Z",
"user": "znhd3hgrxl85c9f"
}

400

object
message
required
string
detail
required
Array<object>
object
code
string
minimum
integer
type
string
inclusive
boolean
exact
boolean
message
string
path
Array<string>
Examples

Exception

{
"message": "invalid_params",
"detail": [
{
"code": "too_small",
"minimum": 15,
"type": "string",
"inclusive": true,
"exact": true,
"message": "String must contain exactly 15 character(s)",
"path": [
"id"
]
}
]
}

404

object
message
required
string
detail
required
object
code
required
integer
message
required
string
data
required
object
Examples

Exception

{
"message": "The requested resource wasn't found.",
"detail": {
"code": 404,
"message": "The requested resource wasn't found.",
"data": {}
}
}