Skip to content

Enter a share link as a guest with a display name (REQ-086). Sets the guest cookie.

POST
/share/{token}
curl --request POST \
--url https://example.com/api/v1/share/example \
--header 'Content-Type: application/json' \
--data '{ "display_name": "example" }'
token
required
string
Media typeapplication/json
object
display_name
required
string
>= 1 characters <= 60 characters
Examplegenerated
{
"display_name": "example"
}

The guest may now read the bundle.

Media typeapplication/json
object
bundle_id
required
string format: uuid
title
required
string
Examplegenerated
{
"bundle_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"title": "example"
}

An error.

Media typeapplication/problem+json

RFC 9457 problem details with a stable code.

object
type
required
string
title
required
string
status
required
integer
detail
string
instance
string
code
required

A stable machine-readable error code.

string
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example",
"code": "example"
}