list_outreach_messages(brand_id, bucket, direction_path_id?, q?, limit?, offset?)
Lists outreach messages in one inbox bucket. Review and scheduled rows include subject and body. Sent, failed, and held rows include subject and status and do not include the body. Held rows include why they are held. Search matches subject and store name. Email and phone are not included. get_outreach_message returns one body from any bucket. Sending stays in the app.
Parameters
- brand_idstringRequired
- Brand the user confirmed.
- bucketstringRequired
- One of review, held, scheduled, sent, or failed.
- direction_path_idstringOptional
- Limit the list to one direction.
- qstringOptional
- Matches subject and store name. Does not match an email address.
- limitnumberOptional
- Page size. Capped at the inbox page maximum.
- offsetnumberOptional
- Page offset.
Returns
- messagesarray
- Each row includes message_id, subject, status, send_state, scheduled_at, sent_at, failure_cause, direction_path_id, direction_title, candidate_organization_name, revision, and app_link. body_text is included for review and scheduled. hold_reason is included for held.
- bucket_totalsobject
- Counts by inbox bucket.
- direction_summariesarray
- Per direction: path_id, strategy_id, title, review_count, failed_count, drafting, autopilot_on, scheduled_count, and held_count.
- totalnumber
- Rows matching this list.
- limitnumber
- Page size used.
- offsetnumber
- Page offset used.
- has_nextboolean
- Whether another page exists.