Skip to content

create

PUT
/list-share

Creates a list share.

Authorizations

Parameters

Query Parameters

requestKey
string

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

Request Body

object
list
required

List Id

string
>= 15 characters <= 15 characters
user
required

User Id

string
>= 15 characters <= 15 characters
permission
required

Permissions for user

string
Allowed values: view edit
Example
{
"list": "dci7qk44birm2bn",
"user": "z014o6bpcg680mg",
"permission": "view"
}

Responses

200

object
collectionId
required
string
collectionName
required
string
created
required
string
expand
required
object
list
required
object
author
required
string
avatar
required
string
collectionId
required
string
collectionName
required
string
created
required
string
description
required
string
expand
required
object
author
required
object
avatar
required
string
bio
required
string
collectionId
required
string
collectionName
required
string
created
required
string
emailVisibility
required
boolean
id
required
string
token
required
string
updated
required
string
username
required
string
verified
required
boolean
id
required
string
name
required
string
public
required
boolean
trails
required
Array<string>
updated
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",
"expand": {
"list": {
"author": "3mugf953w4a9fg5",
"avatar": "dscn0010_xN987yGxE0.jpg",
"collectionId": "r6gu2ajyidy1x69",
"collectionName": "lists",
"created": "2024-12-30 17:41:00.152Z",
"description": "Hallo",
"expand": {
"author": {
"avatar": "pexels_photo_2230444_WILu8cRHVb.jpg",
"bio": "ex aliqua velit deserunt ea exercitation do. Velit ullamco elit culpa eiusmod officia irure aute Lorem in ullamco labore ex. Officia ea qui in exercitation amet. Consequat laboris id duis enim Lorem dolore fugiat excepteur sunt. Sint consectetur duis tempor deserunt non. Ex amet sunt eu commodo.\n\nMollit labore cupidatat qui enim consectetur irure. Ea et reprehenderit ipsum adipisicing duis proident tempor esse excepteur dolor dolore anim consectetur aliqua. Laborum culpa eiusmod id ea consectetur do sit reprehenderit consequat voluptate mollit commodo. Ullamco aute ea minim enim et cupidatat ipsum cillum fugiat. Proident consectetur commodo Lorem do incididunt labore pariatur esse ea officia adipisicing. Do et sint culpa proident enim irure aliqua dolore magna. Laborum Lorem sunt amet occaecat occaecat mollit consectetur laborum ut.",
"collectionId": "_pb_users_auth_",
"collectionName": "users",
"created": "2024-06-29 19:23:47.731Z",
"emailVisibility": false,
"id": "3mugf953w4a9fg5",
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhcGlLZXlVaWQiOiIzMjk3NmExMi03ODE1LTQ1NGQtYTU5Yi1hNzY0ZTE4NmJjNjIiLCJzZWFyY2hSdWxlcyI6eyJjaXRpZXM1MDAiOnt9LCJ0cmFpbHMiOnsiZmlsdGVyIjoicHVibGljID0gdHJ1ZSBPUiBhdXRob3IgPSAzbXVnZjk1M3c0YTlmZzUgT1Igc2hhcmVzID0gM211Z2Y5NTN3NGE5Zmc1In19fQ.swips6eep2qMd0Nf3hdZr711N2fHyikOo7syWvuLEIA",
"updated": "2024-12-30 18:36:39.161Z",
"username": "Flomp",
"verified": true
}
},
"id": "dci7qk44birm2bn",
"name": "Liste mit Oachkatzerl",
"public": true,
"trails": [
"ovo0m6pxxjupfp9",
"yesm2tqc6jok8jq",
"z94vgei3jdc37k4"
],
"updated": "2024-12-30 18:58:44.269Z"
}
},
"id": "r8r938af52vdae1",
"list": "dci7qk44birm2bn",
"permission": "view",
"updated": "2025-01-03 10:36:23.596Z",
"user": "znhd3hgrxl85c9f"
}

400

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

Exception

{
"message": "Failed to create record.",
"detail": {
"code": 400,
"message": "Failed to create record.",
"data": {
"author": {
"code": "validation_missing_rel_records",
"message": "Failed to find all relation records with the provided ids."
}
}
}
}

x-400:Invalid Params

object
message
required
string
detail
required
Array<object>
object
code
string
expected
string
received
string
path
Array<string>
message
string
Examples

Exception

{
"message": "invalid_params",
"detail": [
{
"code": "invalid_type",
"expected": "string",
"received": "number",
"path": [
"text"
],
"message": "Expected string, received number"
}
]
}