Hiver API

Inbox

An Inbox is an entity that has conversations & users. Most common form of an Inbox is a shared mailbox (https://hiverhq.com/shared-inbox) which manages emails. The APIs only manage the shared mailbox. We plan to add other type of inboxes in the APIs soon. It can have tags to help manage the conversations better.

Following is an example of an Inbox object

Plain text

     {
      "id": "101",
      "display_name": "Customer Support",
      "channel_type": "email",
      "email": "info@hiver.com",
      "inbox_type": "user",
      "is_authorised": false,
      "source_user": {
        "id": "765676",
        "email": "info@hiver.com"
      },
      "created_at": 176878888,
      "updated_at": 176878888
    }

Following is an example of an Inbox User object

Plain text

     {
      "id": "456",
      "first_name": "Phoebe",
      "last_name": "Buffay",
      "email": "p.buffay@friends.com",
      "phone_number": "+19876543444",
      "is_joined": false
    }

Following is an example of an Inbox Tag object

Plain text

     {
      "id": "56789",
      "name": "Priority",
      "color_code": "#ce93d8",
      "type": "user",
      "created_at": 1708945347
    }

Sections

Inbox

On this page