Queue Gift
queue_giftUse it when the user asks to send someone a gift, and on a campaign flow's gift step,
where the card counts as that step for the prospect and the step's product, price
ceiling and note fill whatever you leave out. Queued cards show in
get_pending_approvals under the gift bucket.
An approved gift is charged to the payment card the agent's owner saved for gift purchases
under Settings → Billing; with none saved, approving orders nothing and links there to add one.
That payment card is charged the order's actual total, at most max_price_usd, plus about
$3.30 + 2.9% in fees on top.
A dict with success true, gift_id (the card's gift id) and status (the card's
status). On a flow step, nothing is queued and success is false with an error
sentence when the prospect already has a gift in progress for the step (the error
names it) or has since moved off the step (reason is then 'stale_enactment').
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| agent_id | Yes | ID of the agent (campaign) the prospect is tracked on. | |
| gift_note | No | The note sent with the gift, at most 240 characters. | |
| product_url | No | Link to the product page of the gift to buy. | |
| prospect_id | Yes | The prospect's `id` — the outreach_prospects primary key, as returned on every query_prospects row and shown on a flow roster line. | |
| on_behalf_of | No | An agency client's email, from list_agency_clients, to run this call in that client's account: their agents, settings, connected accounts, and credits. Omit it to act on your own account. | |
| max_price_usd | No | The most the item may cost including tax and shipping, in whole US dollars. Pass a budget the user names for the gift as is, even one they call all-in, and tell them the fees come on top of it: a lower limit can make the order fail for the item they picked, so lowering it is their call. | |
| shipping_address | No | The recipient's name, US shipping address and phone number; pass only the fields you know. |