REST API Reference

Back Next

Installing and uninstalling bundles

Use this resource to install and uninstall bundles.

To install a bundle on the organization, use the following URI:

/api/v2/bundleObjectLicense

With this URI, use the following attribute in a bundleObjectLicense object:

Field	Type	Required	Description
bundleObjectId	String	Yes	The ID of the bundle.

Returns the success response if the request is successful. Returns the error object if errors occur.

To uninstall a bundle from the organization, use the following URI:

/api/v2/bundleObjectLicense?bundleObjectId=<bundleId>&updateOption=<updateOption>

Use the following bundleObjectLicense Delete URI attributes:

Field	Type	Required	Description
bundleObjectId	String	Yes	The ID of the bundle.
updateOption	String		Defines what happens if objects in the bundle are used. Use one of the following options: DELETE_EXISTING_OBJECTS. Deletes the objects that use the bundle object. UPDATE_EXISTING_OBJECTS. Updates the object that uses the bundle object. EXCEPTION_IF_IS_USED. Returns a message when a bundle object is used and cancels the uninstallation.

Returns the success response if the request is successful. Returns the error object if errors occur.