Skip to content
Docs
Open Escouade
Documentation contents

Docs › Mail › Tools

open_workspace

View as .md

Open Escouade Mail.

Opens an Escouade Mail workbench in this conversation. Call it once, when no workbench is open. Then use navigate_workspace with the instance_id the view provides: audiences, contacts, campaigns and performance change within the same workbench. Accepts {} for the conversation panel.

Access

  • Key: an Escouade Mail key with send or read or approve or manage_inboxes.
  • Space: any space, verified or not.
  • Changes nothing: yes, it only reads.
  • Safe to replay: use an idempotency_key where the tool offers one.
  • View: the assistant can display it as a view of the Escouade Mail app.

Parameters

ParameterTypeRequiredDescription
pageone of jour, valider, fils, campagnes, audiences, contacts, boites, domaines, blocages, espace, performancesnoSection to display. jour (today) by default. performances with campaign_id shows that campaign’s results.
argumentsobjectnoRead arguments for the page: query to search for a contact, email for their record, campaign_id, audience_id, thread_id or message_id to open a detail. Sends nothing.

Call it

Terminal
curl -s https://api.subagent.fr/v1/open_workspace \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer sak_…' \
  -d '{}'

The full page in French, with the response fields and every refusal the tool can return: /mail/docs/reference/open_workspace.