Custom Scripts

Update Custom Script App Version

Changed on

Updates the InDesign app version configuration for a registered custom script. Allows customers to specify version strategies: use latest version, fix to a major version, or fix to a specific major and minor version.

put/v3/scripts/{script_name}/app-version

Request

  • Base URL: https://indesign.adobe.io
  • URL: https://indesign.adobe.io/v3/scripts/{script_name}/app-version
  • Auth: HTTP bearer and API key in header x-api-key

Path parameters

script_namestring required

Name of the custom script to update

Request body

appVersionStrategy'latest_version' | 'fixed_major_version' | 'fixed_major_and_minor_version' required

Strategy for determining the InDesign app version to use. latest_version uses the most recent version, fixed_major_version locks to a major version, fixed_major_and_minor_version locks to a specific version.

majorAppVersionstring

Major version of the InDesign app. Required when appVersionStrategy is fixed_major_version or fixed_major_and_minor_version.

minorAppVersionstring

Minor version of the InDesign app. Required when appVersionStrategy is fixed_major_and_minor_version.

Example request

{
  "appVersionStrategy": "fixed_major_and_minor_version",
  "majorAppVersion": "20",
  "minorAppVersion": "1"
}

Response

App version configuration updated successfully

messagestring

Example response

{
  "message": "App version configuration updated successfully"
}

Changes

  • 2102fcb68cd8Revision changes
    • warning

      deleted the header request parameter Authorization

    • warning

      deleted the header request parameter x-api-key

  • b5e698cb3edbRevision changes
    • breaking

      removed the enum value FIXED_MAJOR_AND_MINOR_VERSION of the request property

    • breaking

      removed the enum value FIXED_MAJOR_VERSION of the request property

    • breaking

      removed the enum value LATEST_VERSION of the request property

    • info

      added the new fixed_major_and_minor_version enum value to the request property

    • info

      added the new fixed_major_version enum value to the request property

    • info

      added the new latest_version enum value to the request property