Event Webservice

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

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

post/api/event/updateSharedClipGroupV2

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/event/updateSharedClipGroupV2
  • 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

Description for the shared clip group

expirationTimeSecsinteger nullable
plaintextPasswordstring nullable

Password for accessing the shared clip group

sharedClipUuidstring RUUID nullable

base 64 (url-safe) uuid string

titlestring nullable

Title for the shared clip group

Example request

{
  "description": "Updated description of the security incident",
  "plaintextPassword": "newpassword123",
  "sharedClipUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "title": "Updated Security Incident"
}

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

URL for accessing the updated shared clip group

uuidstring RUUID nullable

base 64 (url-safe) uuid string

warningMsgstring nullable

Example response

{
  "shareUrl": "https://share.rhombus.com/clips/abc123",
  "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
}

Changes

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