Zoho TeamInbox

Shared team inbox from Zoho. Send email from a team inbox, find, assign, follow, archive and trash conversations, add contacts, and post new messages to a webhook.

Actions

Action	What it does
Archive a conversation	Archive a conversation, taking it out of the open view.
Assign a conversation	Assign a conversation to a member of its team.
Create a contact	Add a contact to a team.
Create a webhook rule	Create a rule that posts an inbox's matching conversations to a webhook URL when messages arrive or are sent.
Delete a rule	Delete one of a team's rules.
Follow a conversation	Follow a conversation so its updates notify you.
List inboxes	List a team's inboxes with their settings and members.
List rules	List a team's rules, including webhook rules.
List sender addresses	List the From addresses of a workspace.
List team members	List a team's members with their roles and the zuid a conversation is assigned to.
List teams	List the teams in a workspace, optionally only shared teams.
List unassigned conversations	List one page of an inbox's unassigned conversations, newest first.
List workspaces	List the TeamInbox organisations you belong to, with their ids and which one is your default.
Move a conversation to trash	Move a conversation to trash, marking it for deletion.
Search conversations	Search a workspace's conversations by text or subject, optionally only in some inboxes and including trash or spam.
Send an email	Send a new email from a team inbox.

Archive a conversation

Archive a conversation, taking it out of the open view.

Inputs

Workspaceworkspace_idtextRequired: The TeamInbox organisation to work in.
TeamteamtextRequired: The shared team to work in.
Inboxinbox_idtextRequired: The team's inbox.
Conversation IDthread_idtextRequired: The conversation's id: the thread_id from 'Send an email', or the entityId from 'List unassigned conversations' or 'Search conversations'.
Channelchanneltext: Optional. The conversation's channel; Mail unless it came from chat.One of: 1 (Mail), 2 (Telegram), 3 (WhatsApp), 4 (Discussion), 5 (Instagram), 6 (Facebook). Default: 1.

Outputs

The conversation that was changed.

archivedtrue/false: True after archiving.
assignee_zuidtext: Who the conversation was assigned to.
followingtrue/false: True after following.
status_codenumber: TeamInbox's status code.
status_descriptiontext: TeamInbox's status description.
thread_idtext: The conversation's id.
trashedtrue/false: True after moving to trash.

Example output

{
  "archived": true,
  "status_code": 200,
  "status_description": "success",
  "thread_id": "1727700000000100001"
}

Assign a conversation

Assign a conversation to a member of its team.

Inputs

Workspaceworkspace_idtextRequired: The TeamInbox organisation to work in.
TeamteamtextRequired: The shared team to work in.
Inboxinbox_idtextRequired: The team's inbox.
Conversation IDthread_idtextRequired: The conversation's id: the thread_id from 'Send an email', or the entityId from 'List unassigned conversations' or 'Search conversations'.
Assigneeassignee_zuidtextRequired: The team member to assign it to.
Channelchanneltext: Optional. The conversation's channel; Mail unless it came from chat.One of: 1 (Mail), 2 (Telegram), 3 (WhatsApp), 4 (Discussion), 5 (Instagram), 6 (Facebook). Default: 1.

Outputs

The conversation that was changed.

archivedtrue/false: True after archiving.
assignee_zuidtext: Who the conversation was assigned to.
followingtrue/false: True after following.
status_codenumber: TeamInbox's status code.
status_descriptiontext: TeamInbox's status description.
thread_idtext: The conversation's id.
trashedtrue/false: True after moving to trash.

Example output

{
  "assignee_zuid": "812345678",
  "status_code": 200,
  "status_description": "success",
  "thread_id": "1727700000000100001"
}

Create a contact

Add a contact to a team.

Inputs

Workspaceworkspace_idtextRequired: The TeamInbox organisation to work in.
TeamteamtextRequired: The shared team to work in.
NamenametextRequired: The contact's name.
Emailemailtext: Optional. The contact's email address.
Mobilemobiletext: Optional. The contact's mobile number.
Descriptiondescriptiontext: Optional. Notes about the contact.
Facebook profile URLfacebook_profile_urltext: Optional. A full https:// address.
Instagram profile URLinstagram_profile_urltext: Optional. A full https:// address.

Outputs

The contact that was created.

contact_idtext: The new contact's id.
emailtext: The contact's email address, if one was given.
nametext: The contact's name.

Example output

{
  "contact_id": "4000000099999",
  "email": "sam@example.com",
  "name": "Sam Lee"
}

Create a webhook rule

Create a rule that posts an inbox's matching conversations to a webhook URL when messages arrive or are sent. Text conditions match when the field contains the text.

Inputs

Workspaceworkspace_idtextRequired: The TeamInbox organisation to work in.
TeamteamtextRequired: The shared team to work in.
Inboxinbox_idtextRequired: The team's inbox.
NamenametextRequired: The rule's name.
Webhook URLwebhook_urltextRequired: The http(s) URL TeamInbox should post to.
EventseventslistRequired: When the rule runs. Choose one or more.One or more of: 5 (Inbound message), 6 (Inbound reply), 2 (Outbound message), 3 (Outbound reply).
Matchmatchtext: Optional. How the conditions combine.One of: all (All conditions must match), any (Any condition may match). Default: all.
Assigned toassignee_zuidtext: Optional. Only conversations assigned to this member.
From containsfrom_containstext: Optional.
To containsto_containstext: Optional.
Cc containscc_containstext: Optional.
Subject containssubject_containstext: Optional.
Message containsbody_containstext: Optional.

Outputs

The rule that was created.

eventslist: The event codes the rule fires on.
nametext: The rule's name.
rule_idtext: The new rule's id.
webhook_urltext: The URL the rule posts to.

Example output

{
  "events": [
    "5"
  ],
  "name": "Post new mail",
  "rule_id": "4000000055555",
  "webhook_url": "https://hooks.example.com/ti"
}

Delete a rule

Delete one of a team's rules.

Inputs

Workspaceworkspace_idtextRequired: The TeamInbox organisation to work in.
TeamteamtextRequired: The shared team to work in.
Rule IDrule_idtextRequired: The rule_id from 'Create a webhook rule'.

Outputs

The rule that was deleted.

deletedtrue/false: True once deleted.
rule_idtext: The deleted rule's id.

Example output

{
  "deleted": true,
  "rule_id": "4000000055555"
}

Follow a conversation

Follow a conversation so its updates notify you.

Inputs

Workspaceworkspace_idtextRequired: The TeamInbox organisation to work in.
TeamteamtextRequired: The shared team to work in.
Inboxinbox_idtextRequired: The team's inbox.
Conversation IDthread_idtextRequired: The conversation's id: the thread_id from 'Send an email', or the entityId from 'List unassigned conversations' or 'Search conversations'.
Channelchanneltext: Optional. The conversation's channel; Mail unless it came from chat.One of: 1 (Mail), 2 (Telegram), 3 (WhatsApp), 4 (Discussion), 5 (Instagram), 6 (Facebook). Default: 1.

Outputs

The conversation that was changed.

archivedtrue/false: True after archiving.
assignee_zuidtext: Who the conversation was assigned to.
followingtrue/false: True after following.
status_codenumber: TeamInbox's status code.
status_descriptiontext: TeamInbox's status description.
thread_idtext: The conversation's id.
trashedtrue/false: True after moving to trash.

Example output

{
  "following": true,
  "status_code": 200,
  "status_description": "success",
  "thread_id": "1727700000000100001"
}

List inboxes

List a team's inboxes with their settings and members.

Inputs

Workspaceworkspace_idtextRequired: The TeamInbox organisation to work in.
TeamteamtextRequired: The shared team to work in.

Outputs

countnumber: How many inboxes were returned.
inboxeslist: The inboxes.

Example output

{
  "count": 1,
  "inboxes": [
    {
      "id": "4000000067890",
      "name": "support@acme.example",
      "team_id": "4000000012345"
    }
  ]
}

List rules

List a team's rules, including webhook rules.

Inputs

Workspaceworkspace_idtextRequired: The TeamInbox organisation to work in.
TeamteamtextRequired: The shared team to work in.

Outputs

countnumber: How many rules were returned.
ruleslist: The rules.

Example output

{
  "count": 1,
  "rules": [
    {
      "actions": [
        {
          "type": "11",
          "value": "https://hooks.example.com/ti"
        }
      ],
      "rule_name": "Post to webhook"
    }
  ]
}

List sender addresses

List the From addresses of a workspace. By default only enabled, verified ones; pick an inbox to keep only those it can send from.

Inputs

Workspaceworkspace_idtextRequired: The TeamInbox organisation to work in.
Inboxinbox_idtext: Optional. Only addresses this inbox may send from.
Teamteamtext: Optional. Only used to pick the inbox above.
Usable addresses onlyusable_onlytrue/false: Optional. Keep only enabled, verified addresses. On by default.Default: true.

Outputs

countnumber: How many sender addresses were returned.
sender_addresseslist: The sender addresses.

Example output

{
  "count": 1,
  "sender_addresses": [
    {
      "accessible_inboxes": [
        "4000000067890"
      ],
      "is_enabled": true,
      "is_verified": true,
      "name": "Acme Support",
      "source": "support@acme.example"
    }
  ]
}

List team members

List a team's members with their roles and the zuid a conversation is assigned to.

Inputs

Workspaceworkspace_idtextRequired: The TeamInbox organisation to work in.
TeamteamtextRequired: The shared team to work in.

Outputs

countnumber: How many team members were returned.
memberslist: The team members.

Example output

{
  "count": 1,
  "members": [
    {
      "email": "priya@example.com",
      "name": "Priya Shah",
      "role_id": "1",
      "role_name": "Admin",
      "zuid": "812345678"
    }
  ]
}

List teams

List the teams in a workspace, optionally only shared teams.

Inputs

Workspaceworkspace_idtextRequired: The TeamInbox organisation to work in.
Shared teams onlyshared_onlytrue/false: Optional. Leave out personal teams.Default: false.

Outputs

countnumber: How many teams were returned.
teamslist: The teams.

Example output

{
  "count": 1,
  "teams": [
    {
      "description": "Customer support",
      "member_count": 3,
      "name": "Support",
      "team_id": "4000000012345",
      "team_type": 2
    }
  ]
}

List unassigned conversations

List one page of an inbox's unassigned conversations, newest first. Pass next_start as the start index to get the next page.

Inputs

Workspaceworkspace_idtextRequired: The TeamInbox organisation to work in.
TeamteamtextRequired: The shared team to work in.
Inboxinbox_idtextRequired: The team's inbox.
Page sizelimitnumber: Optional. How many to return, 1 to 100. Default 20.From 1 to 100.
Start indexstart_indexnumber: Optional. The next_start of the previous page.At least 0.

Outputs

countnumber: How many conversations were returned.
has_moretrue/false: Whether another page is available.
next_startnumber: The start index of the next page, when there is one.
threadslist: The conversations.
total_countnumber: The count TeamInbox reports for the inbox view.

Example output

{
  "count": 1,
  "has_more": false,
  "next_start": null,
  "threads": [
    {
      "archived": false,
      "createdTime": "1727700000000",
      "entityId": "1727700000000100001",
      "following": false,
      "from": "customer@example.com",
      "inboxId": "4000000067890",
      "read": false,
      "subject": "Order 1042 has not arrived",
      "summary": "Hi, my order has not arrived yet...",
      "teamId": "4000000012345",
      "threadCount": 1
    }
  ],
  "total_count": 1
}

List workspaces

List the TeamInbox organisations you belong to, with their ids and which one is your default. Useful as a connection check.

Inputs

None.

Outputs

countnumber: How many workspaces were returned.
default_workspace_idtext: The id of the default workspace (or the first one), for chaining.
workspaceslist: The workspaces.

Example output

{
  "count": 1,
  "default_workspace_id": "60012345678",
  "workspaces": [
    {
      "is_default": true,
      "name": "Acme Support",
      "soid": "60012345678"
    }
  ]
}

Move a conversation to trash

Move a conversation to trash, marking it for deletion.

Inputs

Workspaceworkspace_idtextRequired: The TeamInbox organisation to work in.
TeamteamtextRequired: The shared team to work in.
Inboxinbox_idtextRequired: The team's inbox.
Conversation IDthread_idtextRequired: The conversation's id: the thread_id from 'Send an email', or the entityId from 'List unassigned conversations' or 'Search conversations'.
Channelchanneltext: Optional. The conversation's channel; Mail unless it came from chat.One of: 1 (Mail), 2 (Telegram), 3 (WhatsApp), 4 (Discussion), 5 (Instagram), 6 (Facebook). Default: 1.

Outputs

The conversation that was changed.

archivedtrue/false: True after archiving.
assignee_zuidtext: Who the conversation was assigned to.
followingtrue/false: True after following.
status_codenumber: TeamInbox's status code.
status_descriptiontext: TeamInbox's status description.
thread_idtext: The conversation's id.
trashedtrue/false: True after moving to trash.

Example output

{
  "status_code": 200,
  "status_description": "success",
  "thread_id": "1727700000000100001",
  "trashed": true
}

Search conversations

Search a workspace's conversations by text or subject, optionally only in some inboxes and including trash or spam.

Inputs

Workspaceworkspace_idtextRequired: The TeamInbox organisation to work in.
Containscontainstext: Text to look for. Fill in this or Subject.
Subjectsubjecttext: Text the subject contains. Fill in this or Contains.
Inbox IDsinbox_idslist: Optional. Only search these inboxes.
Include trashinclude_trashtrue/false: Optional. Also search conversations in trash.Default: false.
Include spaminclude_spamtrue/false: Optional. Also search conversations marked spam.Default: false.

Outputs

countnumber: How many conversations were returned.
threadslist: The conversations.

Example output

{
  "count": 1,
  "threads": [
    {
      "archived": false,
      "createdTime": "1727700000000",
      "entityId": "1727700000000100001",
      "following": false,
      "from": "customer@example.com",
      "inboxId": "4000000067890",
      "read": false,
      "subject": "Order 1042 has not arrived",
      "summary": "Hi, my order has not arrived yet...",
      "teamId": "4000000012345",
      "threadCount": 1
    }
  ]
}

Send an email

Send a new email from a team inbox. It starts a new conversation whose id later steps can follow, assign, archive or trash.

Inputs

Workspaceworkspace_idtextRequired: The TeamInbox organisation to work in.
TeamteamtextRequired: The shared team to work in.
Inboxinbox_idtextRequired: The team's inbox.
Fromfrom_addresstextRequired: An enabled, verified address the inbox can send from.
TotolistRequired: One or more recipient email addresses.
SubjectsubjecttextRequired: The subject line.
Bodybodytext: Optional. The message; HTML is allowed.
Cccclist: Optional. Email addresses to copy in.
Bccbcclist: Optional. Email addresses to blind-copy in.
Archive after sendingarchivetrue/false: Optional. Send and archive the conversation at once.Default: false.

Outputs

The conversation the email started.

archivedtrue/false: Whether the conversation was archived on sending.
assigneetext: Who the conversation is assigned to, if anyone.
channelIdtext: The channel's id.
createdTimetext: When it was sent (milliseconds since 1970).
entityIdtext: The conversation's id, as TeamInbox names it.
followingtrue/false: Whether you follow the conversation.
fromtext: The sender.
inboxIdtext: The inbox's id.
messageIdtext: The message's id, as TeamInbox names it.
message_idtext: The sent message's id.
tdetailsobject: Message details, as TeamInbox sends them.
teamIdtext: The team's id.
thread_idtext: The new conversation's id (entityId), for later steps.
typetext: The conversation type.
updatedTimetext: When it last changed (milliseconds since 1970).

Example output

{
  "archived": false,
  "entityId": "1727700000000100001",
  "following": true,
  "from": "support@acme.example",
  "inboxId": "4000000067890",
  "messageId": "1727700000000200001",
  "message_id": "1727700000000200001",
  "tdetails": {
    "FROM": "support@acme.example",
    "SUBJECT": "Your order has shipped",
    "TO": "customer@example.com"
  },
  "teamId": "4000000012345",
  "thread_id": "1727700000000100001"
}

ActionsCopy Anchor Link

Archive a conversationCopy Anchor Link

Inputs

Outputs

Assign a conversationCopy Anchor Link

Inputs

Outputs

Create a contactCopy Anchor Link

Inputs

Outputs

Create a webhook ruleCopy Anchor Link

Inputs

Outputs

Delete a ruleCopy Anchor Link

Inputs

Outputs

Follow a conversationCopy Anchor Link

Inputs

Outputs

List inboxesCopy Anchor Link

Inputs

Outputs

List rulesCopy Anchor Link

Inputs

Outputs

List sender addressesCopy Anchor Link

Inputs

Outputs

List team membersCopy Anchor Link

Inputs

Outputs

List teamsCopy Anchor Link

Inputs

Outputs

List unassigned conversationsCopy Anchor Link

Inputs

Outputs

List workspacesCopy Anchor Link

Inputs

Outputs

Move a conversation to trashCopy Anchor Link

Inputs

Outputs

Search conversationsCopy Anchor Link

Inputs

Outputs

Send an emailCopy Anchor Link

Inputs

Outputs

On this page

Actions

Archive a conversation

Assign a conversation

Create a contact

Create a webhook rule

Delete a rule

Follow a conversation

List inboxes

List rules

List sender addresses

List team members

List teams

List unassigned conversations

List workspaces

Move a conversation to trash

Search conversations

Send an email