WIwithallo
Inboxes

Update inbox

Changed on

Updates the fields sent and leaves the others unchanged. Use notifications_muted to mute or unmute the inbox, and favorite to star or unstar it. Sending sources replaces the whole list. For a teammate's inbox, send user_id in the body. 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). With user_id, an inbox with no source in a workspace the caller manages returns 404, and sources replaces only the lines in the caller's workspaces: the teammate's other-workspace lines are kept.

patch/v2/api/inboxes/{inbox_id}

Request

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

Path parameters

inbox_idstring required
Example:inb-abc123

Inbox ID (inb-*).

Request body

namestring

Cannot be blank.

emojistring nullable

"" clears the emoji. Absent or null keeps it.

notifications_mutedboolean
favoriteboolean

true stars the inbox (starring it again keeps its first favorited_at), false unstars it. Absent keeps it.

user_idstring

Update this teammate's inbox (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"
    ]
  },
  "favorite": true,
  "user_id": "usr-abc123"
}

Response

Inbox updated

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