How an agent checks a mailing address, sends a printed letter or postcard and follows it to the door. What the service is and what it costs is on Services.
Check whether 1 Main St, Reno NV 89501 is a deliverable address.The client calls stack_check_mailing_address and returns deliverable or undeliverable with the standardised address. From code: stack.post.checkAddress('acct_123', address, { passportToken }). A check is one action.
Send a letter from the assistant account to Anna Berg, 1 Main St, Reno NV 89501, confirming her order.The client calls stack_send_letter. From code or the terminal:
const letter = await stack.post.send('acct_123', {
to: { name: 'Anna Berg', line1: '1 Main St', city: 'Reno', state: 'NV', postal_code: '89501' },
sender_name: 'Acme Ops',
use_type: 'operational',
content: { text: 'Your order is confirmed.' },
}, { passportToken });
// letter.id, letter.state, letter.held_centsnpx @getstackrun/cli post acct_123 send --use-type operational --sender-name "Acme Ops" \
--to-name "Anna Berg" --to-line1 "1 Main St" --to-city Reno --to-state NV --to-postal-code 89501 \
--text "Your order is confirmed."await stack.post.send('acct_123', {
kind: 'postcard',
to: { name: 'Anna Berg', line1: '1 Main St', city: 'Reno', state: 'NV', postal_code: '89501' },
sender_name: 'Acme',
use_type: 'marketing',
front: { text: 'Hello' },
back: { text: 'See you soon' },
}, { passportToken });The tool is stack_send_postcard. Each side takes text of at most 1,200 characters. The size is 4x6 or 6x9.
Where is the letter to Anna Berg now?The client calls stack_list_letters or stack_get_letter. The states are submitting, sent, in_transit, delivered, returned, failed, cancelled and tracking_stopped. Tracking stops 60 days after sending: a letter neither delivered nor returned by then is tracking_stopped. Reads are free.
A letter cannot be cancelled once it is sent, and its price is shown after sending, not before.
Every field is on Post. Every tool is in the tool reference. The return address is set up in Street address.