WIwithallo
Inboxes

Create inbox

Changed on

Creates an inbox for the caller, or for a teammate with user_id in the body. Every source line must be accessible to the inbox owner. Up to 50 inboxes per user. Size limits (name over 80 characters, emoji over 16, more than 100 sources or 10 conditions per source) return 400 INVALID_REQUEST_BODY with field_errors. A menu path not listed by the line's menu_options, or a null source, condition or digit, returns 400 INVALID_INBOX_SOURCE. Menu conditions are only accepted on a line whose menu_options list is not empty, with paths from that list; on other lines use a whole-line source (empty conditions). For a teammate, the inbox must hold at least one line of the caller's workspace.

post/v2/api/inboxes

Request

  • Base URL
    https://api.withallo.com
  • URL
    https://api.withallo.com/v2/api/inboxes
  • Auth
    API key in header Authorization

Request body

namestring required

Required and non-blank.

emojistring nullable
notifications_mutedboolean
user_idstring

Create the inbox for this teammate (usr-*). The caller must be an admin or manager of that teammate's workspace.

Example request

{
  "name": "Sales",
  "emoji": "💼",
  "sources": [
    {
      "allo_number": "+33612345678",
      "conditions": [
        {
          "node_id": "node-3",
          "digits": [
            "1"
          ]
        }
      ]
    }
  ],
  "filters": {
    "types": [
      "INBOUND_CALL"
    ],
    "user_ids": [],
    "contact_ids": [],
    "contact_list_ids": [],
    "tag_keys": [
      "porting"
    ]
  },
  "user_id": "usr-abc123"
}

Response

Inbox created

Example response

{
  "data": {
    "id": "inb-abc123",
    "name": "Sales",
    "emoji": "💼",
    "sources": [
      {
        "allo_number": "+33612345678",
        "conditions": [
          {
            "node_id": "node-3",
            "digits": [
              "1"
            ]
          }
        ]
      }
    ],
    "filters": {
      "types": [
        "INBOUND_CALL"
      ],
      "user_ids": [],
      "contact_ids": [],
      "contact_list_ids": [],
      "tag_keys": [
        "porting"
      ]
    }
  }
}

Changes