Commands

tracee inbox

Comments, DMs and mentions: draft, reply, close.

list

List conversations. Comments, direct messages and mentions from every connected channel, each sorted as lead, question, complaint, praise, spam or other; the ones waiting on the team first.

tracee inbox list [--view <view>] [--platforms <platforms>] [--channel-id <channel_id>] [--query <query>] [--limit <limit>]
  • --viewstring

    The view

    Available options:needs_replydraftsleadsquestionscomplaintsalldonespam

  • --platformsstring[]

    Only these networks, e.g. ["instagram", "facebook"]; all by default Repeat the flag or separate values with commas.

    up to 20 itemseach up to 30 characters

  • --channel-idstring

    One channel, from GET /api/v1/connections

    uuid

  • --querystring

    The query

    up to 200 characters

  • --limitinteger

    The limit

    1–100

Example
tracee inbox list --view needs_reply --limit 20
Calls GET /api/v1/inbox

settings

Get auto-draft settings.

tracee inbox settings

Calls GET /api/v1/inbox/settings

auto

Set auto-draft. mode=draft writes a reply to every new conversation of those intents and leaves it for a person; off stops. Sending on its own is a person's choice in the app.

tracee inbox auto --mode <mode> [--intents <intents>] [--instruction <instruction>]
  • --modestringrequired

    Available options:offdraftreply

  • --intentsstring[]

    Which conversations it handles Repeat the flag or separate values with commas.

    Available options:leadquestioncomplaintpraiseother

  • --instructionstring

    What every reply should keep in mind

    up to 600 characters

--data <json|@file|-> sends the whole body instead of flags.

Example
tracee inbox auto --mode draft
Calls PUT /api/v1/inbox/settings

sync

Read every channel's inbox now. It also refreshes every 10 minutes on its own.

tracee inbox sync

Calls POST /api/v1/inbox/sync

close

Mark conversations handled.

tracee inbox close --thread-ids <thread_ids>
  • --thread-idsstring[]required

    The thread ids. From GET /api/v1/inbox Repeat the flag or separate values with commas.

    up to 100 itemseach uuid

--data <json|@file|-> sends the whole body instead of flags.

Example
tracee inbox close --thread-ids $THREAD_ID
Calls POST /api/v1/inbox/close

reopen

Reopen conversations.

tracee inbox reopen --thread-ids <thread_ids>
  • --thread-idsstring[]required

    The thread ids. From GET /api/v1/inbox Repeat the flag or separate values with commas.

    up to 100 itemseach uuid

--data <json|@file|-> sends the whole body instead of flags.

Example
tracee inbox reopen --thread-ids $THREAD_ID
Calls POST /api/v1/inbox/reopen

spam

Mark conversations as spam.

tracee inbox spam --thread-ids <thread_ids>
  • --thread-idsstring[]required

    The thread ids. From GET /api/v1/inbox Repeat the flag or separate values with commas.

    up to 100 itemseach uuid

--data <json|@file|-> sends the whole body instead of flags.

Example
tracee inbox spam --thread-ids $THREAD_ID
Calls POST /api/v1/inbox/spam

get

Get a conversation. Every message, the post it is on, any draft, and whether Tracee can answer there.

tracee inbox get <thread_id>
  • <thread_id>argumentrequired

    The thread id. From GET /api/v1/inbox

    uuid

Example
tracee inbox get $THREAD_ID
Calls GET /api/v1/inbox/{thread_id}

draft

Write reply drafts. Three replies in the brand's voice to their latest message. The first is saved as the conversation's draft unless save=false. Nothing is sent.

tracee inbox draft <thread_id> [--instruction <instruction>] [--save]
  • <thread_id>argumentrequired

    The thread id. From GET /api/v1/inbox

    uuid

  • --instructionstring

    What to say

    up to 600 characters

  • --save / --no-saveboolean

    Keep the first as the draft (default true)

--data <json|@file|-> sends the whole body instead of flags.

Example
tracee inbox draft $THREAD_ID \
  --instruction "Thank them and offer a quick demo"
Calls POST /api/v1/inbox/{thread_id}/draft

save-draft

Save your own draft.

tracee inbox save-draft <thread_id> --text <text>
  • <thread_id>argumentrequired

    The thread id. From GET /api/v1/inbox

    uuid

  • --textstringrequired

    1–10,000 characters

--data <json|@file|-> sends the whole body instead of flags.

Example
tracee inbox save-draft $THREAD_ID \
  --text "Thanks so much, glad it helped!"
Calls PUT /api/v1/inbox/{thread_id}/draft

discard-draft

Discard the draft.

tracee inbox discard-draft <thread_id>
  • <thread_id>argumentrequired

    The thread id. From GET /api/v1/inbox

    uuid

Example
tracee inbox discard-draft $THREAD_ID
Calls DEL /api/v1/inbox/{thread_id}/draft

reply

Send a reply. Waits for a person's approval when the workspace requires approval to publish.

tracee inbox reply <thread_id> --text <text> [--close]
  • <thread_id>argumentrequired

    The thread id. From GET /api/v1/inbox

    uuid

  • --textstringrequired

    1–10,000 characters

  • --close / --no-closeboolean

    Mark the conversation handled once sent

--data <json|@file|-> sends the whole body instead of flags.

Example
tracee inbox reply $THREAD_ID \
  --text "Thanks so much, glad it helped!" \
  --close
Calls POST /api/v1/inbox/{thread_id}/reply