Update shared clip page title, description, password, or expiration time

Update shared clip page title, description, password, or expiration time

POST /api/event/updateSharedClipGroupV2

Update shared clip page title, description, password, or expiration time

cURL

curl --request POST \
  --url https://api2.rhombussystems.com/api/event/updateSharedClipGroupV2 \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "description": "Updated description of the security incident",
  "expirationTimeSecs": 123,
  "plaintextPassword": "newpassword123",
  "sharedClipUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "title": "Updated Security Incident"
}
'

200

{
  "error": true,
  "errorMsg": "<string>",
  "shareUrl": "https://share.rhombus.com/clips/abc123",
  "uuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "warningMsg": "<string>"
}

Authorizations

x-auth-apikey · string · header · required

Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Headers

x-auth-scheme · enum<string> · default: api-token · 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.

Available options: api-token, api, partner-api-token, partner-api

Body

application/json

Request object for updating a shared clip group.

description · string | null

Description for the shared clip group

Example:

"Updated description of the security incident"

expirationTimeSecs · integer<int32> | null · write-only

plaintextPassword · string | null

Password for accessing the shared clip group

Example:

"newpassword123"

sharedClipUuid · string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

title · string | null

Title for the shared clip group

Example:

"Updated Security Incident"

Response

200 - application/json

OK

Response object for updating a shared clip group.

error · boolean | null

errorMsg · string | null

shareUrl · string | null

URL for accessing the updated shared clip group

Example:

"https://share.rhombus.com/clips/abc123"

uuid · string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

warningMsg · string | null