Save a search and alert on new works
save_search_alertUse this when a buyer wants to hear about works listed later that match what they are looking for. It saves the search — the buyer’s words in query and the same filters as search_artworks — and tells the buyer by e-mail, or your own system by webhook, when a work that matches it is listed: only works that meet everything asked, never near matches, at most one alert a day, for 180 days. An e-mail alert starts only when the buyer confirms it from the one e-mail Fold sends to ask; ask the buyer before giving Fold their address. Every alert e-mail has one-click unsubscribe. A webhook alert starts once webhook_url answers a signed verification event by echoing its challenge. Works flagged as mature content are left out unless include_mature is true, which only the buyer’s own request should set. Answers with search_alert_id and manage_token, shown once: get_search_alert reads the alert and cancel_search_alert ends it.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| wall | No | Only works whose size suits this wall, as search_artworks’ wall reads it. | |
| No | The buyer’s e-mail address, which they gave for this alert. Fold sends it one e-mail to confirm, and nothing else until they do. | ||
| query | No | What the buyer is looking for, in their words, as for search_artworks. | |
| style | No | Any of these styles. | |
| colors | No | Every one of these among the colours the seller confirmed for the work. | |
| framed | No | Framed (true) or unframed (false), as the seller stated. | |
| medium | No | Any of these media; a family such as painting or print includes its members. | |
| signed | No | Signed by the artist, as the seller stated. | |
| edition | No | unique: one of a kind; edition: one impression of an edition. | |
| subject | No | Any of these subjects. | |
| ships_to | No | Where the buyer wants it delivered. Fold delivers to the 50 US states and DC. | |
| orientation | No | Any of: portrait (taller than wide), landscape (wider than tall), square. | |
| webhook_url | No | Your https endpoint for search_alert.new_works events, signed as Standard Webhooks specifies. It must echo the verification event’s data.challenge. | |
| max_width_in | No | Width at most this, in inches. | |
| min_width_in | No | Width at least this, in inches. | |
| max_height_in | No | Height at most this, in inches. | |
| max_price_usd | No | Highest acceptable price, in US dollars. | |
| min_height_in | No | Height at least this, in inches. | |
| min_price_usd | No | Lowest acceptable price, in US dollars. | |
| ready_to_hang | No | Ready to hang, as the seller stated. | |
| include_mature | No | Also announce works their sellers flagged as mature content. Only when the buyer asked. |