MEmendix
components

Creates a new release for a component.

Creates a new release in Draft state for a specific component. This allows Marketplace component publishers to prepare a new version of their component.

Authorization: The user must have permission to create releases for the component. The user is a developer of the component and meets user group rules.

Parameters:

  • The componentId: The corresponding component must exist in Marketplace.

Response: Returns HTTP 201 Created with a Location header containing the URI of the created release.

post/components/{componentId}/releases

Request

  • Base URL
    https://marketplace-api.mendix.com/v1
  • Auth
    API key in header Authorization

Path parameters

componentIdinteger required
Example:12345

This is the numeric ID of the component.

Request body

versionNumberstring required

The versionNumber is the version number of the release. It must be unique across all releases (in any state) and must follow the semantic versioning format: major.minor.patch (for example, 2.0.0).

mendixVersionstring required

The mendixVersion is the Mendix Studio Pro version the release is built on. It must follow the semantic versioning format: major.minor.patch (for example, 11.0.0).

releaseNotesstring required

The releaseNotes contains human-readable information about the release. This field is required and must be a non-empty string describing the changes in this release.

publishManuallyboolean

The publishManually is a boolean flag that controls the publishing behavior after a source file upload. If true, the release remains in Draft and must be published manually. If false (default), the release may be automatically submitted for processing and transition to InReview or Published depending on Marketplace rules.

Example request

{
  "versionNumber": "2.0.0",
  "mendixVersion": "10.6.0",
  "releaseNotes": "Bug fixes and performance improvements.",
  "publishManually": true
}

Response

The release was successfully created and it is in Draft state. The Location header contains the URI of the new release.

Changes

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