Link a schedule to a release

Request

This request uses the POST method, which links a run configuration to a specified release by providing the release ID. A successful request returns the updated runConfiguration object with the linked release details.

For basic authorization, replace this with your API token in the header request in the Authorization: Bearer {your_api_token} format. The token must be valid and have sufficient permissions to modify run configurations.

The request data is provided as a JSON object.

You need to provide the following required parameters:

• id (Path Parameter): The unique identifier of the run configuration you want to link to the release. This is included in the URL path.
• releaseId (Request Body): A string that specifies the unique identifier of the release to link.

Response

A successful response returns the updated run configuration object, including the details of the linked release. The response is provided in JSON format.

{
  "id": 12345,
  "name": "Daily Smoke Test",
  "build": {
    "id": "67890",
    "name": "Build 1.2.3"
  },
  "status": "linked",
  "updatedAt": "2025-01-17T12:00:00Z"
}

Refer to the following table about the response body properties:

Try it!

1. Provide the required parameters and values below (click the dropdown and plus icons):
2. Select the language in Language.
3. Enter your user name or API credentials.
4. Review your API call and click Try it!