v1

latestOpenAPI 3.0.12026-07-22120163333.7 KB

Lead Routing

Lead Routing Rules

Returns the routing rules configured on the caller's team for the given business type. Caller must have MANAGE_LEAD_DISTRIBUTION or MANAGE_LEAD_DISTRIBUTION_DEPARTMENT permission.

get/v1.0/routing/rule/list/{type}

Path parameters

typeinteger required

Routing business type.

Query parameters

roleIdinteger

Role ID. Required when type = 4 (ASSISTANT_LEAD).

Headers

Authorizationstring required

Bearer [access_token]

Response

Routing rules for the given business type.

idinteger

Rule id

namestring

Rule name

sourceNamestring

Lead source name

sourceMatchTypeinteger

Lead source name

tagNamesstring[]

Lead tag name list

tagMatchTypeinteger

Tag match type

groupNamesstring[]

Lead segment name list

groupMatchTypeinteger

Group match type

phonestring

Phone setting

priceMininteger

Price min

priceMaxinteger

Price max

leadTypestring

lead type

leadTypeFiltersstring

multi lead type

ruleSwitchboolean

Rule switch

updateTimeinteger

Update time

Example response

[
  {
    "locationRule": {
      "state": "NL"
    },
    "tagNames": [
      "Hot Lead",
      "Zillow"
    ],
    "groupNames": [
      "First-Time Buyers",
      "Downtown Area"
    ],
    "phone": "'With'、'Without'、 ''",
    "leadType": "Other(-1),Seller(1),Buyer(2),B&S(3),Renter(5)",
    "leadTypeFilters": "[{\"type\":\"one_of\",\"ids\":\"1,2,3\"},{\"type\":\"all\",\"ids\":\"1,2,3\"}]",
    "activeHours": {
      "activeDays": [
        1,
        2,
        3,
        4,
        5
      ]
    }
  }
]