st.syncInbox

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

Unlike st.syncConversation, which watches a single person's conversation, st.syncInbox starts tracking all incoming 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. History predating the moment you enable it is not imported.

Constraints

⏺️ Root Start: allowed.

⬆️ Parent Actions: N/A.

⬇️ Child Actions: N/A.

Parameters

{
  "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:

{
  "actionType": "st.syncInbox",
  "label": "enableInbox",
  "success": true
}

• label – included only if specified in the action parameters.