Update settings

PATCH/settings

Costs 2 rate-limit points · Rate limits

Change settings, as the settings pages do: send any subset of the sections GET /settings returns (general, email, download_page, download_limits, order_conditions, shopify_sync, watermark, customer_accounts, eu_withdrawal) with only the fields to change. Answers with every setting after the save.

Deep partial: untouched fields keep their value. email.domain.dkim_verified is read-only. The same checks as the dashboard run (email copy is spam-checked, the download button text cannot be blank).

Also searched aschange settingsturn off the download emailset download limitenable watermarkingchange order tagsupdate email subjectset the download page colours

Request body

generalobject
Show 6 child attributesHide child attributes
- app_enabledboolean, nullable
- default_localestring
- app_localestring
- multi_language_enabledboolean
- ignore_orders_beforeobject
  Show 2 child attributesHide child attributes
  - datestring, nullable
    ISO 8601 date or time.
  - order_numberinteger, nullable
- branding_hiddenboolean, nullable
emailobject
Show 16 child attributesHide child attributes
- enabledboolean, nullable
- from_namestring, nullable
- from_addressstring, nullable
- reply_tostring, nullable
- report_addressstring, nullable
- subjectstring, nullable
  Example: Your downloads are ready
- bodystring, nullable
- buttonobject
  Show 4 child attributesHide child attributes
  - textstring, nullable
    Example: Download now
  - text_colorstring, nullable
  - background_colorstring, nullable
  - border_radiusinteger, nullable
- footer_textstring, nullable
- font_familystring, nullable
- logo_sizestring
- colorsobject
  Show 2 child attributesHide child attributes
  - textstring, nullable
  - backgroundstring, nullable
- cssstring, nullable
- product_updateobject
  Show 2 child attributesHide child attributes
  - subjectstring, nullable
  - bodystring, nullable
- merchant_notificationsobject
  Show 4 child attributesHide child attributes
  - promotionsboolean, nullable
  - usageboolean, nullable
  - licence_exhaustionboolean, nullable
  - licence_exhaustion_thresholdinteger, nullable
- domainobject
  Show 3 child attributesHide child attributes
  - custom_addressboolean, nullable
  - namestring, nullable
  - dkim_verifiedboolean
download_pageobject
Show 16 child attributesHide child attributes
- hoststring, nullable
  One of filemonkstorefrontcustomer_accountnull
- path_prefixstring, nullable
- require_loginboolean, nullable
- textsobject
  Show 25 child attributesHide child attributes
  - thanksstring, nullable
  - buttonstring, nullable
  - store_linkstring, nullable
  - orders_linkstring, nullable
  - orders_indexstring, nullable
  - custom_downloadsstring, nullable
  - custom_downloads_readystring, nullable
  - licence_labelstring
  - licence_type_labelstring
  - licence_buttonstring, nullable
  - licence_errorstring
  - login_titlestring, nullable
  - login_messagestring, nullable
  - login_buttonstring, nullable
  - total_labelstring, nullable
  - files_labelstring, nullable
  - downloadingstring, nullable
  - processingstring, nullable
  - processing_buttonstring, nullable
  - preorderstring, nullable
  - watermarkingstring, nullable
  - generic_errorstring, nullable
  - copy_buttonstring, nullable
  - copiedstring, nullable
  - not_availablestring, nullable
- colorsobject
  Show 5 child attributesHide child attributes
  - textstring, nullable
  - backgroundstring, nullable
  - sectionstring, nullable
  - button_textstring, nullable
  - button_backgroundstring, nullable
- show_priceboolean, nullable
- show_imageboolean, nullable
- show_store_linkboolean, nullable
- show_orders_linkboolean, nullable
- pdf_viewerboolean
- hide_file_extensionsboolean, nullable
- price_formatstring, nullable
- logo_sizeinteger, nullable
- cssstring, nullable
- store_urlstring, nullable
- default_viewstring, nullable
download_limitsobject
Show 4 child attributesHide child attributes
- showboolean, nullable
  Whether the download page shows the buyer the limits. Display only: the limits apply either way.
- per_file_countinteger, nullable
  How many times each file can be downloaded per order. null means unlimited.
- daysinteger, nullable
  How many days after the order the files stay downloadable. null means unlimited.
- messagesobject
  Show 3 child attributesHide child attributes
  - limit_reachedstring, nullable
  - countstring, nullable
  - daysstring, nullable
order_conditionsobject
Show 9 child attributesHide child attributes
- check_statusboolean, nullable
- status_typestring, nullable
- financial_statusstring, nullable
- fulfillment_statusstring, nullable
- shipment_statusstring, nullable
- revoke_on_mismatchboolean, nullable
- refunded_order_protectionboolean, nullable
- fraud_protectionboolean, nullable
- process_orders_on_updateboolean
shopify_syncobject
Show 5 child attributesHide child attributes
- add_order_tagsboolean, nullable
- order_tagsstring, nullable
- mark_line_items_fulfilledboolean
- skip_fulfillment_for_tagsstring, nullable
- add_tracking_infoboolean, nullable
watermarkobject
Show 7 child attributesHide child attributes
- enabledboolean
- all_filesboolean, nullable
- textstring
- stylestring
- layerstring
- opacityinteger
- fontobject
  Show 3 child attributesHide child attributes
  - sizeinteger
  - colorstring
  - namestring
customer_accountsobject
Show 3 child attributesHide child attributes
- button_textstring, nullable
- product_downloads_subtitlestring, nullable
- order_statusobject
  Show 4 child attributesHide child attributes
  - thanks_textstring, nullable
  - button_textstring, nullable
  - thank_you_page_buttonboolean, nullable
  - order_status_page_buttonboolean, nullable
eu_withdrawalobject
Show 4 child attributesHide child attributes
- enabledboolean
- scopestring
  One of eu_onlyall_customers
- consent_textstring, nullable
- button_textstring, nullable

Returns

generalobject
Show 6 child attributesHide child attributes
- app_enabledboolean, nullable
  Example: true
- default_localestring, nullable
  Example: en
- app_localestring, nullable
  Example: fr
- multi_language_enabledboolean, nullable
  Example: true
- ignore_orders_beforeobject
  Show 2 child attributesHide child attributes
  - dateany
  - order_numberany
- branding_hiddenboolean, nullable
  Example: false
emailobject
Show 16 child attributesHide child attributes
- enabledboolean, nullable
  Example: true
- from_namestring, nullable
  Example: Example Store
- from_addressstring, nullable
  Example: alerts@filemonk.io
- reply_tostring, nullable
  Example: owner@example.com
- report_addressstring, nullable
  Example: owner@example.com
- subjectstring, nullable
  Example: Your {{shop.name}} {{order.name}} content
- bodystring, nullable
  Example: Thanks for purchasing from {{shop.name}}! Click the butto…
- buttonobject
  Show 4 child attributesHide child attributes
  - textstring, nullable
    Example: Access downloads
  - text_colorstring, nullable
    Example: #fff
  - background_colorstring, nullable
    Example: #202223
  - border_radiusinteger, nullable
    Example: 5
- footer_textstring, nullable
  Example: Facing trouble accessing your content? Contact us right a…
- font_familystring, nullable
  Example: sans-serif
- logo_sizestring, nullable
  Example: 200
- colorsobject
  Show 2 child attributesHide child attributes
  - textstring, nullable
    Example: #202223
  - backgroundstring, nullable
    Example: #ffffff
- cssany
- product_updateobject
  Show 2 child attributesHide child attributes
  - subjectstring, nullable
    Example: Update to {{product_variant.title}} in your order {{order…
  - bodystring, nullable
    Example: Your most recent purchase for {{product_variant.title}} h…
- merchant_notificationsobject
  Show 4 child attributesHide child attributes
  - promotionsboolean, nullable
    Example: true
  - usageboolean, nullable
    Example: true
  - licence_exhaustionboolean, nullable
    Example: false
  - licence_exhaustion_thresholdinteger, nullable
    Example: 80
- domainobject
  Show 3 child attributesHide child attributes
  - custom_addressboolean, nullable
    Example: false
  - namestring, nullable
    Example: example-store
  - dkim_verifiedboolean, nullable
    Example: false
download_pageobject
Show 16 child attributesHide child attributes
- hoststring, nullable
  Example: storefront
- path_prefixstring, nullable
  Example: /apps/filemonk
- require_loginany
- textsobject
  Show 25 child attributesHide child attributes
  - thanksstring, nullable
    Example: Thank you for purchasing from our store! Click on any of …
  - buttonstring, nullable
    Example: Download
  - store_linkstring, nullable
    Example: Visit store
  - orders_linkstring, nullable
    Example: My orders
  - orders_indexstring, nullable
    Example: My orders
  - custom_downloadsstring, nullable
    Example: Custom products
  - custom_downloads_readystring, nullable
    Example: Your digital content will be available here when it's ready.
  - licence_labelstring, nullable
    Example: Licence key
  - licence_type_labelstring, nullable
    Example: Key
  - licence_buttonstring, nullable
    Example: View
  - licence_errorstring, nullable
    Example: No licence key available. Contact store.
  - login_titlestring, nullable
    Example: Customer Login Required
  - login_messagestring, nullable
    Example: You need to be logged in with the correct account to acce…
  - login_buttonstring, nullable
    Example: Log In
  - total_labelstring, nullable
    Example: Total
  - files_labelstring, nullable
    Example: files
  - downloadingstring, nullable
    Example: Downloading...
  - processingstring, nullable
    Example: Processing order. Please wait.
  - processing_buttonstring, nullable
    Example: Processing...
  - preorderstring, nullable
    Example: This product is currently in preorder and will be availab…
  - watermarkingstring, nullable
    Example: Watermarking is not complete, please wait or reload the p…
  - generic_errorstring, nullable
    Example: Something went wrong.
  - copy_buttonstring, nullable
    Example: Copy
  - copiedstring, nullable
    Example: Copied to clipboard
  - not_availablestring, nullable
    Example: Not Available
- colorsobject
  Show 5 child attributesHide child attributes
  - textstring, nullable
    Example: #202223
  - backgroundstring, nullable
    Example: #f6f7f7
  - sectionstring, nullable
    Example: #ffffff
  - button_textstring, nullable
    Example: #FFF
  - button_backgroundstring, nullable
    Example: #1B76FF
- show_priceboolean, nullable
  Example: true
- show_imageboolean, nullable
  Example: true
- show_store_linkboolean, nullable
  Example: true
- show_orders_linkboolean, nullable
  Example: true
- pdf_viewerboolean, nullable
  Example: false
- hide_file_extensionsboolean, nullable
  Example: false
- price_formatstring, nullable
  Example: {{currency_symbol}}{{amount}}
- logo_sizeinteger, nullable
  Example: 100
- cssany
- store_urlstring, nullable
  Example: example-store.myshopify.com
- default_viewstring, nullable
  Example: files
download_limitsobject
Show 4 child attributesHide child attributes
- showboolean, nullable
  Example: false
- per_file_countany
- daysany
- messagesobject
  Show 3 child attributesHide child attributes
  - limit_reachedstring, nullable
    Example: Sorry! This file is no longer available to download.
  - countstring, nullable
    Example: Maximum downloads per file:
  - daysstring, nullable
    Example: Available to download until
order_conditionsobject
Show 9 child attributesHide child attributes
- check_statusboolean, nullable
  Example: true
- status_typestring, nullable
  Example: fulfillment
- financial_statusstring, nullable
- fulfillment_statusstring, nullable
  Example: fulfilled
- shipment_statusstring, nullable
- revoke_on_mismatchboolean, nullable
  Example: false
- refunded_order_protectionboolean, nullable
  Example: false
- fraud_protectionboolean, nullable
  Example: false
- process_orders_on_updateboolean, nullable
  Example: false
shopify_syncobject
Show 5 child attributesHide child attributes
- add_order_tagsboolean, nullable
  Example: false
- order_tagsstring, nullable
  Example: filemonk_order
- mark_line_items_fulfilledboolean, nullable
  Example: false
- skip_fulfillment_for_tagsany
- add_tracking_infoboolean, nullable
  Example: true
watermarkobject
Show 7 child attributesHide child attributes
- enabledboolean, nullable
  Example: true
- all_filesboolean, nullable
  Example: true
- textstring, nullable
  Example: Licensed to {{order.customer_name}} ({{order.email_or_pho…
- stylestring, nullable
  Example: center
- layerstring, nullable
  Example: above
- opacityinteger, nullable
  Example: 30
- fontobject
  Show 3 child attributesHide child attributes
  - sizeinteger, nullable
    Example: 30
  - colorstring, nullable
    Example: #ff0018
  - namestring, nullable
    Example: Courier New Bold
customer_accountsobject
Show 3 child attributesHide child attributes
- button_textstring, nullable
  Example: Download files
- product_downloads_subtitlestring, nullable
  Example: Downloads available
- order_statusobject
  Show 4 child attributesHide child attributes
  - thanks_textstring, nullable
    Example: Thanks for your purchase! Click the button below to acces…
  - button_textstring, nullable
    Example: Access downloads
  - thank_you_page_buttonboolean, nullable
    Example: true
  - order_status_page_buttonboolean, nullable
    Example: true
eu_withdrawalobject
Show 4 child attributesHide child attributes
- enabledboolean, nullable
  Example: false
- scopestring, nullable
  Example: eu_only
- consent_textstring, nullable
  Example: I request immediate access to this digital content and ac…
- button_textstring, nullable
  Example: Confirm and download

Errors

401

Missing or invalid API key.

422

The request failed validation, or sent a key the action does not take (code: "unknown_parameters" with unknown and accepted). Nothing was saved.

429

Rate limited. Cost-weighted per API key, shared with API v1: a read costs 1 point, a write 2, 40 points per fixed 60-second window. Every response carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset (Unix time the window ends); a 429 adds Retry-After (seconds), retry_after, retryable: true and a next_step in the body. A 429 did nothing: wait retry_after seconds, then send the same request again. The budget is per key, so every tool or script using the key shares it; prefer one list call with per_page over many single reads.

Every error has the same shape: see Errors.

PATCH/settings

curl -X PATCH "https://app.filemonk.io/api/v2/external/settings" \
  -H "X-Auth-Token: $FILEMONK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "email": {
      "subject": "Your downloads are ready",
      "button": {
        "text": "Download now"
      }
    },
    "download_limits": {
      "per_file_count": 5
    }
  }'

const res = await fetch("https://app.filemonk.io/api/v2/external/settings", {
  method: "PATCH",
  headers: {
    "X-Auth-Token": process.env.FILEMONK_API_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "email": {
      "subject": "Your downloads are ready",
      "button": {
        "text": "Download now"
      }
    },
    "download_limits": {
      "per_file_count": 5
    }
  }),
});
const data = await res.json();

import os
import requests

res = requests.patch(
    "https://app.filemonk.io/api/v2/external/settings",
    headers={"X-Auth-Token": os.environ["FILEMONK_API_KEY"]},
    json={
        "email": {
            "subject": "Your downloads are ready",
            "button": {
                "text": "Download now"
            }
        },
        "download_limits": {
            "per_file_count": 5
        }
    },
)
data = res.json()

require "net/http"
require "json"

uri = URI("https://app.filemonk.io/api/v2/external/settings")
req = Net::HTTP::Patch.new(uri, "X-Auth-Token" => ENV["FILEMONK_API_KEY"], "Content-Type" => "application/json")
req.body = {
  email: {
    subject: "Your downloads are ready",
    button: {
      text: "Download now"
    }
  },
  download_limits: {
    per_file_count: 5
  }
}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)

Response

{
  "general": {
    "app_enabled": true,
    "default_locale": "en",
    "app_locale": "fr",
    "multi_language_enabled": true,
    "ignore_orders_before": {
      "date": null,
      "order_number": null
    },
    "branding_hidden": false
  },
  "email": {
    "enabled": true,
    "from_name": "Example Store",
    "from_address": "alerts@filemonk.io",
    "reply_to": "owner@example.com",
    "report_address": "owner@example.com",
    "subject": "Your {{shop.name}} {{order.name}} content",
    "body": "Thanks for purchasing from {{shop.name}}! Click the button below to access the digital content for your order {{order.name}}.",
    "button": {
      "text": "Access downloads",
      "text_color": "#fff",
      "background_color": "#202223",
      "border_radius": 5
    },
    "footer_text": "Facing trouble accessing your content? Contact us right away.",
    "font_family": "sans-serif",
    "logo_size": "200",
    "colors": {
      "text": "#202223",
      "background": "#ffffff"
    },
    "css": null,
    "product_update": {
      "subject": "Update to {{product_variant.title}} in your order {{order.name}}",
      "body": "Your most recent purchase for {{product_variant.title}} has been updated. Click the link below to access your updated content."
    },
    "merchant_notifications": {
      "promotions": true,
      "usage": true,
      "licence_exhaustion": false,
      "licence_exhaustion_threshold": 80
    },
    "domain": {
      "custom_address": false,
      "name": "example-store",
      "dkim_verified": false
    }
  },
  "download_page": {
    "host": "storefront",
    "path_prefix": "/apps/filemonk",
    "require_login": null,
    "texts": {
      "thanks": "Thank you for purchasing from our store! Click on any of the products below to download your content.",
      "button": "Download",
      "store_link": "Visit store",
      "orders_link": "My orders",
      "orders_index": "My orders",
      "custom_downloads": "Custom products",
      "custom_downloads_ready": "Your digital content will be available here when it's ready.",
      "licence_label": "Licence key",
      "licence_type_label": "Key",
      "licence_button": "View",
      "licence_error": "No licence key available. Contact store.",
      "login_title": "Customer Login Required",
      "login_message": "You need to be logged in with the correct account to access your digital orders. Please click the button below to log in or switch to the appropriate account.",
      "login_button": "Log In",
      "total_label": "Total",
      "files_label": "files",
      "downloading": "Downloading...",
      "processing": "Processing order. Please wait.",
      "processing_button": "Processing...",
      "preorder": "This product is currently in preorder and will be available for download on {{date}}.",
      "watermarking": "Watermarking is not complete, please wait or reload the page to check again.",
      "generic_error": "Something went wrong.",
      "copy_button": "Copy",
      "copied": "Copied to clipboard",
      "not_available": "Not Available"
    },
    "colors": {
      "text": "#202223",
      "background": "#f6f7f7",
      "section": "#ffffff",
      "button_text": "#FFF",
      "button_background": "#1B76FF"
    },
    "show_price": true,
    "show_image": true,
    "show_store_link": true,
    "show_orders_link": true,
    "pdf_viewer": false,
    "hide_file_extensions": false,
    "price_format": "{{currency_symbol}}{{amount}}",
    "logo_size": 100,
    "css": null,
    "store_url": "example-store.myshopify.com",
    "default_view": "files"
  },
  "download_limits": {
    "show": false,
    "per_file_count": null,
    "days": null,
    "messages": {
      "limit_reached": "Sorry! This file is no longer available to download.",
      "count": "Maximum downloads per file: ",
      "days": "Available to download until"
    }
  },
  "order_conditions": {
    "check_status": true,
    "status_type": "fulfillment",
    "financial_status": "",
    "fulfillment_status": "fulfilled",
    "shipment_status": "",
    "revoke_on_mismatch": false,
    "refunded_order_protection": false,
    "fraud_protection": false,
    "process_orders_on_update": false
  },
  "shopify_sync": {
    "add_order_tags": false,
    "order_tags": "filemonk_order",
    "mark_line_items_fulfilled": false,
    "skip_fulfillment_for_tags": null,
    "add_tracking_info": true
  },
  "watermark": {
    "enabled": true,
    "all_files": true,
    "text": "Licensed to {{order.customer_name}} ({{order.email_or_phone}}), order {{order.name}}. Please don't share this file.",
    "style": "center",
    "layer": "above",
    "opacity": 30,
    "font": {
      "size": 30,
      "color": "#ff0018",
      "name": "Courier New Bold"
    }
  },
  "customer_accounts": {
    "button_text": "Download files",
    "product_downloads_subtitle": "Downloads available",
    "order_status": {
      "thanks_text": "Thanks for your purchase! Click the button below to access your files.",
      "button_text": "Access downloads",
      "thank_you_page_button": true,
      "order_status_page_button": true
    }
  },
  "eu_withdrawal": {
    "enabled": false,
    "scope": "eu_only",
    "consent_text": "I request immediate access to this digital content and acknowledge that I lose my right of withdrawal once the download begins.",
    "button_text": "Confirm and download"
  }
}

{
  "errors": [
    "Invalid API key"
  ]
}

{
  "errors": [
    "access.download_limit_count must be an integer of at least 0"
  ],
  "field_errors": {
    "access.download_limit_count": [
      "must be an integer of at least 0"
    ]
  }
}

{
  "errors": [
    "You have exceeded the rate limit of 40 points per 60 seconds. Read requests cost 1 point(s) and write requests cost 2 point(s). Please retry after 12 second(s)."
  ],
  "code": "rate_limited",
  "retry_after": 12,
  "error": "Rate limit exceeded",
  "message": "You have exceeded the rate limit of 40 points per 60 seconds. Read requests cost 1 point(s) and write requests cost 2 point(s). Please retry after 12 second(s)."
}