Sign in

v1

latestOpenAPI 3.0.12026-07-22120163333.7 KB
Leads

Preview Routing

Returns the assignees that would be selected by routing rules for a hypothetical lead matching the supplied name, email and other attributes. Useful for previewing routing before creating the lead.

Notes:

  • firstName and email are required.
  • The response lists one entry per role matched by routing.
post/v1.0/leads/assignee

Headers

Authorizationstring required

Bearer [access_token]

Content-Typestring required

application/json

Request body

firstNamestring required

The first name of the lead

lastNamestring

The last name of the lead

emailstring required

The email address associated with the lead

phonestring

The phone number associated with the lead. (No more than 20 characters per phone）

birthdaystring

The birthday of the lead(pattern:MMM d, yyyy)

Example request

{
  "firstName": "Bob",
  "lastName": "Li",
  "email": "123456789@gmail.com",
  "phone": "1234567890",
  "birthday": "Jun 5, 2001"
}

Response

Assignee matches for the supplied lead info.

leadIdinteger

leadId

leadUserIdinteger

leadUserId

firstNamestring

lead firstName

lastNamestring

lead lastName