Skip to main content
POST
/
api
/
video
/
updateSharedTimelapseGroup
Update shared timelapse group
curl --request POST \
  --url https://api2.rhombussystems.com/api/video/updateSharedTimelapseGroup \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "description": "Updated shared timelapse for security review",
  "descriptionUpdate": true,
  "expirationTimeSecs": 172800,
  "expirationTimeUpdate": false,
  "passwordUpdate": false,
  "plaintextPassword": "newSecurePassword123",
  "title": "Updated Security Review",
  "titleUpdate": true,
  "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
'
{
  "error": true,
  "errorMsg": "<string>",
  "shareUrl": "https://example.com/share/timelapse/12345",
  "uuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "warningMsg": "<string>"
}

Authorizations

x-auth-apikey
string
header
required

Your API key for Rhombus.

Headers

x-auth-scheme
string
default:api-token
required

Authentication scheme indicator ("api-token").

Required string length: 9

Body

application/json

Request object for updating a shared timelapse group.

description
string | null

New description for the shared timelapse group

Example:

"Updated shared timelapse for security review"

descriptionUpdate
boolean | null

Whether to update the description

Example:

true

expirationTimeSecs
integer<int32> | null

New expiration time in seconds for the shared group

Example:

172800

expirationTimeUpdate
boolean | null

Whether to update the expiration time

Example:

false

passwordUpdate
boolean | null

Whether to update the password

Example:

false

plaintextPassword
string | null

New plaintext password for the shared timelapse group

Example:

"newSecurePassword123"

title
string | null

New title for the shared timelapse group

Example:

"Updated Security Review"

titleUpdate
boolean | null

Whether to update the title

Example:

true

uuid
string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

Response

200 - application/json

OK

Response object for updating a shared timelapse group.

error
boolean | null
errorMsg
string | null
shareUrl
string | null

Updated share URL for the timelapse group

Example:

"https://example.com/share/timelapse/12345"

uuid
string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

warningMsg
string | null