Change or remove the alert email

Send only alert_email: an address (trimmed, at most 254 characters) or null (or an empty string) to stop alert emails. A new address gets a new unsubscribe link, so links in emails sent to the old address stop working. An address that used the unsubscribe link stays unsubscribed for this catalog, even when saved again (then alert_email_unsubscribed_at is set and a warning says so). The answer is the catalog (no webhook_secret) with alert_email_unsubscribed_at, plus warnings when the plan sends no alerts (Free) or email alerts are off.

patch/v1/catalogs/{id}

Request

  • Base URL: https://api.recallsapi.com
  • URL: https://api.recallsapi.com/v1/catalogs/{id}
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

idstring required

Request body

alert_emailstring email nullable required

Response

The updated catalog

idstring
namestring
alert_emailstring nullable
alert_email_unsubscribed_atstring date-time nullable

When this address used the unsubscribe link in an alert email of this catalog; no alert emails go to it, even if it is saved again

webhook_urlstring nullable
min_confidence'exact' | 'strong' | 'possible'
created_atstring date-time
warningsstring[]

Changes

No recorded changes to this operation across all 1 revision of this API.