Video Webservice

Update shared timelapse group

Update title, description, or expiration on a shared timelapse link

post/api/video/updateSharedTimelapseGroup

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/video/updateSharedTimelapseGroup
  • Auth: API key in header x-auth-apikey

Headers

x-auth-scheme'api-token' | 'api' | 'partner-api-token' | 'partner-api' required

Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.

Request body

descriptionstring nullable

New description for the shared timelapse group

descriptionUpdateboolean nullable

Whether to update the description

expirationTimeSecsinteger nullable

New expiration time in seconds for the shared group

expirationTimeUpdateboolean nullable

Whether to update the expiration time

passwordUpdateboolean nullable

Whether to update the password

plaintextPasswordstring nullable

New plaintext password for the shared timelapse group

titlestring nullable

New title for the shared timelapse group

titleUpdateboolean nullable

Whether to update the title

uuidstring RUUID nullable

base 64 (url-safe) uuid string

Example request

{
  "description": "Updated shared timelapse for security review",
  "descriptionUpdate": true,
  "expirationTimeSecs": 172800,
  "plaintextPassword": "newSecurePassword123",
  "title": "Updated Security Review",
  "titleUpdate": true,
  "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
}

Response

OK

errorboolean nullable
errorCodestring nullable

Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.

errorMsgstring nullable
shareUrlstring nullable

Updated share URL for the timelapse group

uuidstring RUUID nullable

base 64 (url-safe) uuid string

warningMsgstring nullable

Example response

{
  "shareUrl": "https://example.com/share/timelapse/12345",
  "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
}

Changes

No recorded changes to this operation across all 1 revision of this API.