Skip to main content

Update Addons Settings

POST 
/api/v1/user/settings/addons/:addon_key

Update addons by sending below payload.

Note: This update will overwrite the entire addons settings. All addon keys must be must be supplied along with their corresponding target state for added and enabled.

Note: All addons that support event hooks can be updated using this API

Pre-requisite: Addon must be available for the user account. Contact Support if addon is not available for the account.

REQUEST PAYLOAD​

{
  "key": "addons",
  "value": {
    "STORYBOARD": {
      "added": true,
      "enabled": true
    }
  }
}
  • added specifies whether the user has added this available addon to their account
  • enabled specifies whether this addon has been activated by user

Event hooks & disposition​

Addons that support event hooks (e.g. FACE_RECOGNITION, PRINT_EXPORT) can also carry a settings.event-hooks block specifying which events trigger processing (file-saved, file-data-updated) and a disposition describing what to do with the result.

For PRINT_EXPORT, the disposition accepts the output keys output_mode (add_conversion | add_new_asset), conversion_name (default print_ready), inherit_metadata, plus the print parameters format (tiff|jpeg|pdf|pdfx), cmyk_profile, rendering_intent, dpi (72–1200), target_size, and allow_upscale. Example:

{
  "key": "addons",
  "value": {
    "PRINT_EXPORT": {
      "added": true,
      "enabled": true,
      "settings": {
        "event-hooks": {
          "file-saved": { "enabled": true, "content_types": ["image/*"] },
          "disposition": {
            "output_mode": "add_conversion",
            "conversion_name": "print_ready",
            "format": "tiff",
            "cmyk_profile": "USWebCoatedSWOP",
            "rendering_intent": "relative_colorimetric",
            "dpi": 300
          }
        }
      }
    }
  }
}
ParametersTypeDescription
keystringSet toaddons
valueJSONTo add the available addon to the profile, set added to true. To enable an addon that has been added, set enabled to true. An addon has to be both added and enabled for it to be part of the processing pipeline.

Request​

Responses​

Successful operation