v1

latestOpenAPI 3.0.1Apache 2.02026-07-1424096195.5 KB
Groups

Update Group by ID

Allows the updating of an existing Group

put/v3/groups/{uniqueId}

Path parameters

uniqueId'1' | '2' | '3' required

param ID of the Group that needs to be updated

ID of the Group to be updated

Query parameters

fieldsstring[]

Group subentity fields to include in response (See OPTIONS endpoint for valid values)

createActivityLogstring

Boolean to signal whether or not to create an alert for this action

Request body

idinteger
dateAddedstring date-time
ownerIdinteger
ownerNamestring
webLinkstring
typestring required
xidstring
namestring required
upVoteboolean
upVoteCountstring
downVoteCountstring
generatedReportboolean
externalDateAddedstring date-time
externalLastModifiedstring date-time
externalDateExpiresstring date-time
fileNamestring
fileSizeinteger
statusstring
malwareboolean
passwordstring
documentTypestring
documentDateAddedstring date-time
tostring
fromstring
subjectstring
scoreinteger
headerstring
bodystring
scoreIncludesBodyboolean
emailDatestring date-time
scoreBreakdownstring
eventTypestring
fileTypestring
fileTextstring
signatureDateAddedstring date-time
escalatedboolean
remindedboolean
overdueboolean
dueDatestring date-time
reminderDatestring date-time
escalationDatestring date-time
lastModifiedstring date-time
legacyLinkstring
firstSeenstring date-time
lastSeenstring date-time
eventDatestring date-time
publishDatestring date-time

Response

The updated Group

idinteger
dateAddedstring date-time
ownerIdinteger
ownerNamestring
webLinkstring
typestring required
xidstring
namestring required
upVoteboolean
upVoteCountstring
downVoteCountstring
generatedReportboolean
externalDateAddedstring date-time
externalLastModifiedstring date-time
externalDateExpiresstring date-time
fileNamestring
fileSizeinteger
statusstring
malwareboolean
passwordstring
documentTypestring
documentDateAddedstring date-time
tostring
fromstring
subjectstring
scoreinteger
headerstring
bodystring
scoreIncludesBodyboolean
emailDatestring date-time
scoreBreakdownstring
eventTypestring
fileTypestring
fileTextstring
signatureDateAddedstring date-time
escalatedboolean
remindedboolean
overdueboolean
dueDatestring date-time
reminderDatestring date-time
escalationDatestring date-time
lastModifiedstring date-time
legacyLinkstring
firstSeenstring date-time
lastSeenstring date-time
eventDatestring date-time
publishDatestring date-time