st.syncInbox

This action enables whole-inbox monitoring for your account so you can poll the inbox for messages across every conversation.

💡 Recommended first step for reading messages. See the Messaging overview for how it fits with the other messaging tools.

st.syncInbox starts tracking all threads in your inbox. Run it once per account. After it succeeds, new messages become available through the inbox polling endpoint — no need to sync each conversation individually.

💡 Only messages that arrive after inbox sync is enabled are captured. To get a person's earlier history, load it once with st.syncConversation and read it through inbox polling with personUrl.

This action only switches monitoring on: it records the setting and returns. It does not browse your inbox and does not open anyone's profile. The messages themselves are picked up afterwards by a sync that runs periodically, so the first ones appear on the next sync rather than the moment the action completes.

Note: When that sync finds new messages in a thread – including messages you send yourself – it opens the profile page of the other participant in that thread to resolve their public URL – but only when Linked API does not already know it, so a person is visited once, which is what fills personPublicUrl on the messages you poll or receive by webhook. Those visits are made from your own account, and such a visit is visible to the person whose profile is opened.

Constraints

⏺️ Root Start: allowed.

⬆️ Parent Actions: N/A.

⬇️ Child Actions: N/A.

Parameters

json
{
  "actionType": "st.syncInbox",
  "label": "enableInbox"
}
  • label (optional) – custom label for tracking this action in workflow completion.

This action takes no other parameters.

Result options

Successful enabling:

json
{
  "actionType": "st.syncInbox",
  "label": "enableInbox",
  "success": true
}
  • label – included only if specified in the action parameters.