Skip to main content
PATCH
/
api
/
v1
/
share
/
{shareId}
Update share settings
curl --request PATCH \
  --url https://handauncle-backend-prod-205012263523.asia-south1.run.app/api/v1/share/{shareId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "allowContinuation": true,
  "expires_in_days": 183,
  "customTitle": "<string>",
  "customDescription": "<string>"
}
'
{
  "success": true,
  "data": {
    "id": "<string>",
    "shareId": "<string>",
    "userId": "<string>",
    "conversationId": "<string>",
    "shareType": "full",
    "visibility": "public",
    "allowContinuation": true,
    "viewCount": 123,
    "continuationCount": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "status": "active",
    "messageIds": [
      "<string>"
    ],
    "customTitle": "<string>",
    "customDescription": "<string>",
    "lastViewedAt": "2023-11-07T05:31:56Z",
    "expiresAt": "2023-11-07T05:31:56Z",
    "revokedAt": "2023-11-07T05:31:56Z"
  },
  "meta": {
    "timestamp": "2023-11-07T05:31:56Z",
    "requestId": "<string>"
  }
}
Allows owners to toggle continuation, extend/shorten expiration, and tweak custom titles/descriptions. All fields are optional, and only the provided ones are persisted.

Request Body

FieldTypeDescription
allowContinuationbooleanToggle fork permission
expiresInDaysnumberUpdate expiration (1-365 days)
customTitlestringUpdate share title (max 200 chars)
customDescriptionstringUpdate description (max 500 chars)

Authorizations

Authorization
string
header
required

Auth0 access token for registered users.

Path Parameters

shareId
string
required

Share identifier returned by POST /api/v1/share.

Required string length: 8 - 64

Body

application/json
allowContinuation
boolean
expires_in_days
integer
Required range: 1 <= x <= 365
customTitle
string
Maximum string length: 200
customDescription
string
Maximum string length: 500

Response

Share updated.

success
enum<boolean>
required
Available options:
true
data
object
required
meta
object
required