packages

Update package (marketplace content item)

Use the PUT method to edit a newly posted package (content item).

Note the following:

  • This operation applies only to newly created content items that have not been published yet.
  • This operation cannot be used to edit new versions of already existing packages (content items).
  • Only the creator of a package is able to edit it and thus use this operation.
put/packages/{packageId}

Request

  • Base URL
    https://pmp-demo.privateplatform.mendix.com/marketplaceservice/v1
  • Auth
    • HTTP basic
    • or API key in header Authorization

Path parameters

packageIdinteger required

Request body

namestring required

Package name.

descriptionstring required

Package description.

studioProVersionstring required

Studio pro version that package support.

appContentTypeNamestring required

Package content type name.

ownerGroupNamestring

Package owner group name.

licensestring required

License name for package.

logoFilestring required

Base64EncodedContent string of package version logo file.

visibilitystring

Package is visible to all or only specific groups.

versionMajorinteger

Package first version major number.

versionMinorinteger

Package first version minor number.

versionPatchinteger

Package first version patch number.

releaseNotesstring required

Package release note text.

documentationstring

Package documentation text.

Example request

{
  "studioProVersion": "9.24.3",
  "versionMajor": 1
}

Response

Package response

idinteger
namestring
appContentTypeNamestring
ownerUserNamestring
ownerGroupNamestring
statusstring
visibilitystring
downloadsinteger

Changes

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