Get Routing configuration

Request

GET /v2/mailboxes/10/routing HTTP/1.1
Authorization: Bearer oauth_token

Response

HTTP/1.1 200 OK
Content-Type: application/hal+json

{
  "state" : "enabled",
  "assignmentLimit" : 10,
  "assignmentMethod" : "round_robin",
  "userIds" : [ 1, 2, 3 ],
  "rotation" : [ {
    "userId" : 1,
    "conversationsCount" : 10,
    "eligible" : false,
    "reason" : "at_capacity"
  }, {
    "userId" : 2,
    "conversationsCount" : 2,
    "eligible" : false,
    "reason" : "away"
  }, {
    "userId" : 3,
    "conversationsCount" : 0,
    "eligible" : true
  }, {
    "userId" : 4,
    "conversationsCount" : 1,
    "eligible" : false,
    "reason" : "not_in_rotation"
  } ],
  "_links" : {
    "self" : {
      "href" : "..."
    }
  }
}

Path Parameters

/v2/mailboxes/{mailboxId}/routing

Response fields

Path Type Description
state String Routing configuration state, one of enabled or disabled
assignmentLimit Number Maximum number of conversations that can be assigned. Always specified for enabled routing. Minimum 1, maximum 100
assignmentMethod String Method for assigning conversations, one of round_robin or balanced. Always specified for enabled routing
userIds Array List of users included in the rotation. Always specified for enabled routing. Can be empty for disabled routing
rotation Array List of users in the rotation with their current state
rotation[].userId Number User ID in the rotation
rotation[].conversationsCount Number Number of active conversations currently assigned to the user in this mailbox
rotation[].eligible Boolean Whether the user is eligible to receive new conversations through routing
rotation[].reason String Reason why the user is not eligible, if applicable
↑Back to top