In this section: Watchlist
Watchlist
Cards a member is tracking to apply for, with notes and status.
add_to_watchlist
Add a card to the member's watchlist -- considering it, not yet applied for, or holding it and still tracking it (its offer, a second copy, another household member's application). Requires wallet-change access.
| Scope | Quota |
|---|---|
miles:write | standard |
| Name | Type | Required | Description |
|---|---|---|---|
card_name | string | required | The card to watch. Must resolve to a real card in Miles' catalog; an unmatched name is refused rather than stored. |
cardholder | string | Which household member is considering the card, by name (an id works too). Pass it whenever the member names a person: on an account with household members, an unassigned entry has no single eligibility answer. Editable later via update_watchlist_entry. | |
notes | string | The member's own free text on why the card is being watched, written as they said it. Not the place for the member's own decision deadline (use update_watchlist_entry's decide_by). Ignored when the card is already on the watchlist; change an existing note with update_watchlist_entry. |
get_watchlist
Cards the member is considering -- not yet in their wallet.
| Scope | Quota |
|---|---|
miles:read | standard |
No parameters.
remove_from_watchlist
Remove a card from the member's watchlist. Requires wallet-change access. Use lookup_card_name to identify the entry by name; if multiple entries match, use entry_id on retry.
| Scope | Quota |
|---|---|
miles:write | standard |
| Name | Type | Required | Description |
|---|---|---|---|
lookup_card_name | string | Identify the entry by card name, e.g. Venture X. If more than one entry matches, retry with entry_id. | |
entry_id | string | Identify the entry exactly by the w_N id get_watchlist keys its entries by, e.g. w_2. Use on retry when lookup_card_name is ambiguous. |
update_watchlist_entry
Edit a watched card's cardholder, its notes, the date the member means to decide by, or any combination. Requires wallet-change access.
| Scope | Quota |
|---|---|
miles:write | standard |
| Name | Type | Required | Description |
|---|---|---|---|
cardholder | string | New household member for the entry, by name (an id works too); the empty string unassigns it. Omit to leave unchanged. | |
notes | string | New note text. Replaces the stored note rather than appending to it, so send the whole new text; the empty string clears it. Omit to leave unchanged. | |
decide_by | string | The member's own deadline for deciding whether to apply, written YYYY-MM-DD -- never the offer's expiry or an eligibility date. The empty string clears it; omitting it (or sending null) leaves it unchanged. | |
lookup_card_name | string | Identify the entry by card name, e.g. Venture X. If more than one entry matches, retry with entry_id. | |
entry_id | string | Identify the entry exactly by the w_N id get_watchlist keys its entries by, e.g. w_2. Use on retry when lookup_card_name is ambiguous. |