Skip to main content
PUT
/
room
/
share
/
:room_id
Share Private Room
curl --request PUT \
  --url https://api.example.com/room/share/:room_id
{
  "signature": "<string>"
}
Generates a signature token that can be used to share access to a private room. Users with this signature can access the room by including it in the query parameters when retrieving the private room.

​
Authentication

Required. Include the authentication token in the Authorization header. User must have access to the private room.

​
Path Parameters

​
room_id
string
required
Unique identifier of the room to share.

​
Response

​
signature
string
A signature token that grants temporary access to the private room. Share this token with other users to grant them access.

​
Errors

  • 401 - Unauthorized (no token provided)
  • 403 - Forbidden (user does not have access to this private room)
  • 500 - Internal server error

​
Example Request

curl -X PUT https://api.planttogether.com/room/share/550e8400-e29b-41d4-a716-446655440000 \
  -H "Authorization: YOUR_AUTH_TOKEN"

​
Example Response

{
  "signature": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

​
Usage

Once you have a signature, share it with other users. They can use it to access the private room by including it as a query parameter: 
curl "https://api.planttogether.com/room/private/user-123/room-name?signature=SIGNATURE_TOKEN" \
  -H "Authorization: THEIR_AUTH_TOKEN"
The signature will be processed and grant them access to the room. See the Get Private Room endpoint for more details. Source: express/src/index.ts:154-169

Build docs developers (and LLMs) love

Get started for freeTalk to us