Plugin Management

Update plugin

PUT
http://localhost:3000/api/plugins/{id}

Updates an existing plugin record based on the provided ID and metadata.

Body

multipart/form-data

Updated plugin metadata

namestring

Plugin name

descriptionstring

Plugin description

typestringDESKTOPWEBMOBILE

Type of the plugin

statusstringACTIVEINACTIVEDEPRECATEDARCHIVED

Status of the plugin

isActivebooleanfalse

Plugin is active or not

categoryIdstring

Plugin category ID

authorstring

Author

licensestring

License

homepagestring

Homepage URL

repositorystring

Repository URL

tagsArray<string>

Plugin tags

requiresSubscriptionbooleanfalse

Is subscription plan enabled

uploadedByIdstring

ID of user who uploaded the plugin

idstringrequired

Unique identifier for the plugin

Example
123e4567-e89b-12d3-a456-426614174000
versionUpdatePluginVersionDTO

Updated version details for the plugin

Show child attributes
isActivebooleantrue
isArchivedbooleanfalse
archivedAtstring<date-time>
Example
2018-11-21T06:20:32.232Z
tenantIdstring
organizationIdstring
numberstring

Version following SemVer (MAJOR.MINOR.PATCH[-prerelease][+build])

changelogstring

Change Log of the plugin version

checksumstring

Verification hash of the plugin version

signaturestring

Digital signature for authenticity verification

releaseDatestring

Date when the release was recorded

installationsArray<PluginInstallation_1>

Related installations to plugin version

Show child attributes
deletedAtstring<date-time>
Example
2018-11-21T06:20:32.232Z
createdAtstring<date-time>

The creation timestamp of the entity.

Example
2018-11-21T06:20:32.232Z
updatedAtstring<date-time>

The last update timestamp of the entity.

Example
2018-11-21T06:20:32.232Z
idstring
isActivebooleantrue
isArchivedbooleanfalse
archivedAtstring<date-time>
Example
2018-11-21T06:20:32.232Z
tenantIdstring
organizationIdstring
pluginPlugin_1required

Installed the plugin

Show child attributes
deletedAtstring<date-time>
Example
2018-11-21T06:20:32.232Z
createdAtstring<date-time>

The creation timestamp of the entity.

Example
2018-11-21T06:20:32.232Z
updatedAtstring<date-time>

The last update timestamp of the entity.

Example
2018-11-21T06:20:32.232Z
idstring
isActivebooleanfalse

Plugin is active or not

isArchivedbooleanfalse
archivedAtstring<date-time>
Example
2018-11-21T06:20:32.232Z
namestringrequired

Plugin name

descriptionstring

Plugin description

typestringDESKTOPWEBMOBILErequired

Type of the plugin

statusstringACTIVEINACTIVEDEPRECATEDARCHIVEDrequired

Status of the plugin

categoryIdstring

Plugin category ID

categoryobject

Plugin category

versionsArray<string>required

Versions of the plugin

authorstring

Plugin author

licensestring

Plugin license

homepagestring

Homepage URL

repositorystring

Repository URL

uploadedByUser

User who uploaded the plugin

Show child attributes
deletedAtstring<date-time>
Example
2018-11-21T06:20:32.232Z
createdAtstring<date-time>

The creation timestamp of the entity.

Example
2018-11-21T06:20:32.232Z
updatedAtstring<date-time>

The last update timestamp of the entity.

Example
2018-11-21T06:20:32.232Z
idstring
isActivebooleantrue
isArchivedbooleanfalse
archivedAtstring<date-time>
Example
2018-11-21T06:20:32.232Z
tenantIdstring
thirdPartyIdstring
firstNamestring
lastNamestring
emailstring
phoneNumberstring
usernamestring
timeZonestring
timeFormatstring1224
hashstring
refreshTokenstring
imageUrlstring
preferredLanguagestringenbgherufreszhdeptitnlplar
preferredComponentLayoutstringCARDS_GRIDTABLE
uiPreferencesobject
codestring
codeExpireAtstring<date-time>
emailVerifiedAtstring<date-time>
lastLoginAtstring<date-time>
emailTokenstring
roleIdstring
imageIdstring
defaultTeamIdstring
lastTeamIdstring
defaultOrganizationIdstring
lastOrganizationIdstring
uploadedAtstring<date-time>

Upload date

requiresSubscriptionbooleanfalserequired

Is subscription plan enabled

isFeaturedbooleanfalserequired

Whether the plugin is featured

isVerifiedbooleanfalserequired

Whether the plugin is verified by Gauzy

lastDownloadedAtstring<date-time>

Last downloaded date

pluginTenantsArray<string>

Plugin tenants for this plugin

settingsArray<string>

Plugin settings

subscriptionsArray<string>

Plugin subscriptions

subscriptionPlansArray<string>

Plugin subscription plans

pluginTagsArray<string>

Plugin tag relationships

versionPluginVersion_1required

Installed version of the plugin

Show child attributes
deletedAtstring<date-time>
Example
2018-11-21T06:20:32.232Z
createdAtstring<date-time>

The creation timestamp of the entity.

Example
2018-11-21T06:20:32.232Z
updatedAtstring<date-time>

The last update timestamp of the entity.

Example
2018-11-21T06:20:32.232Z
idstring
isActivebooleantrue
isArchivedbooleanfalse
archivedAtstring<date-time>
Example
2018-11-21T06:20:32.232Z
tenantIdstring
organizationIdstring
numberstringrequired

Version following SemVer (MAJOR.MINOR.PATCH[-prerelease][+build])

changelogstringrequired

Change Log of the plugin version

checksumstringrequired

Verification hash of the plugin version

signaturestringrequired

Digital signature for authenticity verification

releaseDatestring

Date when the release was recorded

downloadCountnumberrequired

Download count

pluginPlugin_1required

Plugin associated with the version

Show child attributes
deletedAtstring<date-time>
Example
2018-11-21T06:20:32.232Z
createdAtstring<date-time>

The creation timestamp of the entity.

Example
2018-11-21T06:20:32.232Z
updatedAtstring<date-time>

The last update timestamp of the entity.

Example
2018-11-21T06:20:32.232Z
idstring
isActivebooleanfalse

Plugin is active or not

isArchivedbooleanfalse
archivedAtstring<date-time>
Example
2018-11-21T06:20:32.232Z
namestringrequired

Plugin name

descriptionstring

Plugin description

typestringDESKTOPWEBMOBILErequired

Type of the plugin

statusstringACTIVEINACTIVEDEPRECATEDARCHIVEDrequired

Status of the plugin

categoryIdstring

Plugin category ID

categoryobject

Plugin category

versionsArray<string>required

Versions of the plugin

authorstring

Plugin author

licensestring

Plugin license

homepagestring

Homepage URL

repositorystring

Repository URL

uploadedByUser

User who uploaded the plugin

Show child attributes
deletedAtstring<date-time>
Example
2018-11-21T06:20:32.232Z
createdAtstring<date-time>

The creation timestamp of the entity.

Example
2018-11-21T06:20:32.232Z
updatedAtstring<date-time>

The last update timestamp of the entity.

Example
2018-11-21T06:20:32.232Z
idstring
isActivebooleantrue
isArchivedbooleanfalse
archivedAtstring<date-time>
Example
2018-11-21T06:20:32.232Z
tenantIdstring
thirdPartyIdstring
firstNamestring
lastNamestring
emailstring
phoneNumberstring
usernamestring
timeZonestring
timeFormatstring1224
hashstring
refreshTokenstring
imageUrlstring
preferredLanguagestringenbgherufreszhdeptitnlplar
preferredComponentLayoutstringCARDS_GRIDTABLE
uiPreferencesobject
codestring
codeExpireAtstring<date-time>
emailVerifiedAtstring<date-time>
lastLoginAtstring<date-time>
emailTokenstring
roleIdstring
imageIdstring
defaultTeamIdstring
lastTeamIdstring
defaultOrganizationIdstring
lastOrganizationIdstring
uploadedAtstring<date-time>

Upload date

requiresSubscriptionbooleanfalserequired

Is subscription plan enabled

isFeaturedbooleanfalserequired

Whether the plugin is featured

isVerifiedbooleanfalserequired

Whether the plugin is verified by Gauzy

lastDownloadedAtstring<date-time>

Last downloaded date

pluginTenantsArray<string>

Plugin tenants for this plugin

settingsArray<string>

Plugin settings

subscriptionsArray<string>

Plugin subscriptions

subscriptionPlansArray<string>

Plugin subscription plans

pluginTagsArray<string>

Plugin tag relationships

sourcesArray<PluginSource_1>

Sources of the plugin version

Show child attributes
deletedAtstring<date-time>
Example
2018-11-21T06:20:32.232Z
createdAtstring<date-time>

The creation timestamp of the entity.

Example
2018-11-21T06:20:32.232Z
updatedAtstring<date-time>

The last update timestamp of the entity.

Example
2018-11-21T06:20:32.232Z
idstring
isActivebooleantrue
isArchivedbooleanfalse
archivedAtstring<date-time>
Example
2018-11-21T06:20:32.232Z
tenantIdstring
organizationIdstring
typestringCDNNPMGAUZYrequired

Type of the plugin source

operatingSystemstringLINUXMACWINDOWSUNIVERSALrequired

Plugin Os type source

architecturestringX64ARMrequired

Plugin Os type source architecture

urlstringrequired

URL of the plugin source (CDN)

integritystringrequired

Integrity hash for the CDN source

crossOriginstringrequired

Cross-origin policy for the CDN source

namestringrequired

NPM package name

registrystringrequired

NPM registry URL

privatebooleanfalse

Indicates if the package is private (requires NPM authentication token for access).

scopestringrequired

NPM scope (if applicable)

filePathstringrequired

File path for uploaded plugin

fileNamestringrequired

File name of the uploaded plugin

fileSizenumberrequired

File size of the uploaded plugin (in bytes)

mimeTypestringrequired

MIME type of the uploaded plugin file

fileKeystringrequired

Plugin file identifier

versionPluginVersion_1required

Associated plugin version

Show child attributes
PluginVersion_1
storageProviderstringLOCALS3WASABICLOUDINARYDIGITALOCEAN
installationsArray<PluginInstallation_1>

Related installations to plugin version

Same fields as version.installations

installedByEmployee

Employee who installed the plugin

Show child attributes
deletedAtstring<date-time>
Example
2018-11-21T06:20:32.232Z
createdAtstring<date-time>

The creation timestamp of the entity.

Example
2018-11-21T06:20:32.232Z
updatedAtstring<date-time>

The last update timestamp of the entity.

Example
2018-11-21T06:20:32.232Z
idstring
isActivebooleantrue
isArchivedbooleanfalse
archivedAtstring<date-time>
Example
2018-11-21T06:20:32.232Z
tenantIdstring
organizationIdstring
short_descriptionstring
descriptionstring
startedWorkOnstring<date-time>
endWorkstring<date-time>
payPeriodstringNONEBI_WEEKLYWEEKLYTWICE_PER_MONTHMONTHLY
Example
WEEKLY
billRateValuenumber
minimumBillingRatenumber
billRateCurrencystringAFNAFAALLALKDZDADPAOAAOKAONAORARAARSARMARPARLAMDAWGAUDATSAZNAZMBSDBHDBDTBBDBYNBYBBYRBEFBECBELBZDBMDBTNBOBBOLBOVBOPBAMBADBANBWPBRCBRZBREBRRBRNBRBBRLGBPBNDBGLBGNBGOBGMBUKBIFXPFKHRCADCVEKYDXAFCLECLPCLFCNXCNYCOPCOUKMFCDFCRCHRDHRKCUCCUPCYPCZKCSKDKKDJFDOPNLGXCDDDMECSECVEGPGQEERNEEKETBEURXEUFKPFJDFIMFRFXFOXFUGMDGEKGELDEMGHSGHCGIPGRDGTQGWPGNFGNSGYDHTGHNLHKDHUFISKISJINRIDRIRRIQDIEPILSILPILRITLJMDJPYJODKZTKESKWDKGSLAKLVLLVRLBPLSLLRDLYDLTLLTTLULLUCLUFMOPMKDMKNMGAMGFMWKMYRMVRMVPMLFMTLMTPMROMURMXVMXNMXPMDCMDLMCFMNTMADMAFMZEMZNMZMMMKNADNPRANGTWDNZDNIONICNGNKPWNOKOMRPKRPABPGKPYGPEIPENPESPHPPLNPLZPTEGWEQARXRERHDRONROLRUBRURRWFSVCWSTSARRSDCSDSCRSLLSGDSKKSITSBDSOSZARZALKRHKRWKROSSPSURESPESAESBLKRSHPSDDSDGSDPSRDSRGSZLSEKCHFSYPSTDTJRTJSTZSTHBTPETOPTTDTNDTRYTRLTMTTMMUSDUSNUSSUGXUGSUAHUAKAEDUYUUYPUYIUZSVUVVEFVEBVNDVNNCHECHWXOFYDDYERYUNYUDYUMYURZRNZRZZMWZMKZWDZWRZWL
Example
USD
reWeeklyLimitnumber
offerDatestring<date-time>
acceptDatestring<date-time>
rejectDatestring<date-time>
employeeLevelstring
anonymousBonusboolean
averageIncomenumberrequired
averageBonusnumberrequired
totalWorkHoursnumberrequired
averageExpensesnumberrequired
show_anonymous_bonusboolean
show_average_bonusboolean
show_average_expensesboolean
show_average_incomeboolean
show_billrateboolean
show_payperiodboolean
show_start_work_onboolean
isJobSearchActiveboolean
linkedInUrlstring
facebookUrlstring
instagramUrlstring
twitterUrlstring
githubUrlstring
gitlabUrlstring
upworkUrlstring
stackoverflowUrlstring
isVerifiedboolean
isVettedboolean
totalJobsnumberrequired
jobSuccessnumberrequired
isTrackingEnabledboolean
isOnlineboolean
isAwaystringfalse
isTrackingTimeboolean
allowScreenshotCaptureboolean
allowManualTimeboolean
allowModifyTimeboolean
allowDeleteTimeboolean
allowAgentAppExitboolean
allowLogoutFromAgentAppboolean
trackKeyboardMouseActivityboolean
trackAllDisplaysboolean
upworkIdstring
linkedInIdstring
userIdstringrequired
contactIdstringrequired
organizationPositionIdstringrequired
installedAtstring

Installed date

uninstalledAtstring

Uninstalled date

statusstringINSTALLEDUNINSTALLEDFAILEDIN_PROGRESSrequired

Plugin installation status

isActivatedbooleanfalse

Whether this installation is currently activated

activatedAtstring<date-time>

When this installation was last activated

deactivatedAtstring<date-time>

When this installation was last deactivated

idstringrequired

Unique identifier for the plugin version

Example
123e4567-e89b-12d3-a456-426614174000
sourcesArray<UpdatePluginSourceDTO>

Updated source details for the plugin version

Show child attributes
isActivebooleantrue
isArchivedbooleanfalse
archivedAtstring<date-time>
Example
2018-11-21T06:20:32.232Z
tenantIdstring
organizationIdstring
typestringCDNNPMGAUZY

Type of the plugin source

operatingSystemstringLINUXMACWINDOWSUNIVERSAL

Plugin Os type source

architecturestringX64ARM

Plugin Os type source architecture

urlstring

URL of the plugin source (CDN)

integritystring

Integrity hash for the CDN source

crossOriginstring

Cross-origin policy for the CDN source

namestring

NPM package name

registrystring

NPM registry URL

privatebooleanfalse

Indicates if the package is private (requires NPM authentication token for access).

scopestring

NPM scope (if applicable)

filePathstring

File path for uploaded plugin

fileNamestring

File name of the uploaded plugin

fileSizenumber

File size of the uploaded plugin (in bytes)

mimeTypestring

MIME type of the uploaded plugin file

fileKeystring

Plugin file identifier

storageProviderstringLOCALS3WASABICLOUDINARYDIGITALOCEAN
idstringrequired

Unique identifier for the plugin source

Example
123e4567-e89b-12d3-a456-426614174000
subscriptionPlansArray<UpdatePluginSubscriptionPlanDTO>

Subscription plans to create or update. Plans with an id will be updated, plans without an id will be created

Show child attributes
idstringrequired

Unique identifier for the plugin

Example
123e4567-e89b-12d3-a456-426614174000
pricenumber

Plan price

isPopularboolean

Whether this plan is marked as popular

isRecommendedboolean

Whether this plan is recommended

trialDaysnumber

Trial period duration in days

setupFeenumber

Setup fee for the plan

discountPercentagenumber

Discount percentage for the plan

namestring

Plan name

descriptionstring

Plan description

typestringfreetrialbasicpremiumenterprisecustom

Plan type

currencystringAFNAFAALLALKDZDADPAOAAOKAONAORARAARSARMARPARLAMDAWGAUDATSAZNAZMBSDBHDBDTBBDBYNBYBBYRBEFBECBELBZDBMDBTNBOBBOLBOVBOPBAMBADBANBWPBRCBRZBREBRRBRNBRBBRLGBPBNDBGLBGNBGOBGMBUKBIFXPFKHRCADCVEKYDXAFCLECLPCLFCNXCNYCOPCOUKMFCDFCRCHRDHRKCUCCUPCYPCZKCSKDKKDJFDOPNLGXCDDDMECSECVEGPGQEERNEEKETBEURXEUFKPFJDFIMFRFXFOXFUGMDGEKGELDEMGHSGHCGIPGRDGTQGWPGNFGNSGYDHTGHNLHKDHUFISKISJINRIDRIRRIQDIEPILSILPILRITLJMDJPYJODKZTKESKWDKGSLAKLVLLVRLBPLSLLRDLYDLTLLTTLULLUCLUFMOPMKDMKNMGAMGFMWKMYRMVRMVPMLFMTLMTPMROMURMXVMXNMXPMDCMDLMCFMNTMADMAFMZEMZNMZMMMKNADNPRANGTWDNZDNIONICNGNKPWNOKOMRPKRPABPGKPYGPEIPENPESPHPPLNPLZPTEGWEQARXRERHDRONROLRUBRURRWFSVCWSTSARRSDCSDSCRSLLSGDSKKSITSBDSOSZARZALKRHKRWKROSSPSURESPESAESBLKRSHPSDDSDGSDPSRDSRGSZLSEKCHFSYPSTDTJRTJSTZSTHBTPETOPTTDTNDTRYTRLTMTTMMUSDUSNUSSUGXUGSUAHUAKAEDUYUUYPUYIUZSVUVVEFVEBVNDVNNCHECHWXOFYDDYERYUNYUDYUMYURZRNZRZZMWZMKZWDZWRZWL

Plan currency

billingPeriodstringdailyweeklymonthlyquarterlyyearlyone-time

Billing period

featuresArray<string>

Plan features

limitationsobject

Plan limitations

isActiveboolean

Is plan active

metadataobject

Plan metadata

sortOrdernumber

Sort order

Parameters

idstring<uuid>requiredpath

UUID of the plugin to update

Response

200OKPlugin_1

Plugin updated successfully.

Response fields application/json
deletedAtstring<date-time>
Example
2018-11-21T06:20:32.232Z
createdAtstring<date-time>

The creation timestamp of the entity.

Example
2018-11-21T06:20:32.232Z
updatedAtstring<date-time>

The last update timestamp of the entity.

Example
2018-11-21T06:20:32.232Z
idstring
isActivebooleanfalse

Plugin is active or not

isArchivedbooleanfalse
archivedAtstring<date-time>
Example
2018-11-21T06:20:32.232Z
namestringrequired

Plugin name

descriptionstring

Plugin description

typestringDESKTOPWEBMOBILErequired

Type of the plugin

statusstringACTIVEINACTIVEDEPRECATEDARCHIVEDrequired

Status of the plugin

categoryIdstring

Plugin category ID

categoryobject

Plugin category

versionsArray<string>required

Versions of the plugin

authorstring

Plugin author

licensestring

Plugin license

homepagestring

Homepage URL

repositorystring

Repository URL

uploadedByUser

User who uploaded the plugin

Show child attributes
deletedAtstring<date-time>
Example
2018-11-21T06:20:32.232Z
createdAtstring<date-time>

The creation timestamp of the entity.

Example
2018-11-21T06:20:32.232Z
updatedAtstring<date-time>

The last update timestamp of the entity.

Example
2018-11-21T06:20:32.232Z
idstring
isActivebooleantrue
isArchivedbooleanfalse
archivedAtstring<date-time>
Example
2018-11-21T06:20:32.232Z
tenantIdstring
thirdPartyIdstring
firstNamestring
lastNamestring
emailstring
phoneNumberstring
usernamestring
timeZonestring
timeFormatstring1224
hashstring
refreshTokenstring
imageUrlstring
preferredLanguagestringenbgherufreszhdeptitnlplar
preferredComponentLayoutstringCARDS_GRIDTABLE
uiPreferencesobject
codestring
codeExpireAtstring<date-time>
emailVerifiedAtstring<date-time>
lastLoginAtstring<date-time>
emailTokenstring
roleIdstring
imageIdstring
defaultTeamIdstring
lastTeamIdstring
defaultOrganizationIdstring
lastOrganizationIdstring
uploadedAtstring<date-time>

Upload date

requiresSubscriptionbooleanfalserequired

Is subscription plan enabled

isFeaturedbooleanfalserequired

Whether the plugin is featured

isVerifiedbooleanfalserequired

Whether the plugin is verified by Gauzy

lastDownloadedAtstring<date-time>

Last downloaded date

pluginTenantsArray<string>

Plugin tenants for this plugin

settingsArray<string>

Plugin settings

subscriptionsArray<string>

Plugin subscriptions

subscriptionPlansArray<string>

Plugin subscription plans

pluginTagsArray<string>

Plugin tag relationships

400Bad Request

Invalid input provided. Check the response body for error details.

401Unauthorized

Unauthorized access.

404Not Found

Plugin record not found.

Authorization

api_key
Bearer
Copyright © 2023-Present Ever Co. LTD.Docs by Sourcey
Stack OverflowWebsiteDemo
↑↓ navigate↵ selectesc close