1. Overview

Chime service API description

1.1. Version information

Version : 1.0

1.2. URI scheme

Host : api.chime.me
BasePath : /

1.3. Tags

  • Alerts : Operations about alerts

  • Calls : Operations about calls

  • Leads : Operations about leads

  • Members : Operations about team member

  • Notes : Operations about lead notes

  • Tasks : Operations about tasks

  • TeamFeatures: Operations about team features

  • Webhooks: Operations about webhooks

  • LogType : Operations about lead log call,log email,log text

  • Listing : Operations about listing

2. Getting Started

The simple REST API enables developers to quickly integrate their applications.
API services is actively developing to provide more complete functionality.

2.1. Authentication

   In order to ensure data security, Chime has built-in support for OAuth 2.0 which is extremely useful when setting up integrations between third-party applications and Chime without passwords being required. To obtain an OAuth2.0 access_token please refer to Chime OAuth 2.0.

You should set access token, and content type to json through the API call service

Header Value

Content-type

application/json

Authorization

Bearer [access_token]

Note
   Rate limiting will be applied on June 15, 2021 for all those not using a vendorKey. If a vendorKey is not implemented before July 15, 2021, API access will not be available. Please complete the application (see link above) to apply for a security key BEFORE July 15, 2021 to ensure your connected services will not be affected.
   Once rate limiting starts (June 15, 2021), only ten calls per minute are allowed without a valid vendorKey. If the limit is exceeded, an error will be returned. The endpoints can be called again after one minute with the same limit of 10 calls per minute.

3. Pagination

List methods that return a collection of resources are paginated using offset and limit query parameters.

GET /v1.0/leads?offset=0&limit=10

Response contains "_metadata" section that includes total number of records available and pagination parameters used in the request:

{
  "_metadata": {
    "collection": "leads",
    "limit": 1,
    "offset": 0,
    "total": 1
  },
  "leads": [
    {
      "lead": {
        "leadId": 666756701809678,
        "leadUserId": 342981796596581,
        "firstName": "Kunkun",
        "lastName": "An",
        ...
      }
    }
    ...
  ]
}

4. Rate Limiting

The returned HTTP headers of any API request show your current rate limit status:

> curl -i -X GET --header 'Accept: application/json' --header 'Content-Type: application/json' --header 'Authorization: token eyJhbGciOiJIUzI1NiJ9.eyJleHQiOjMxNDc2NzM4OTM5NjYsInVzZXJfaWQiOjEwMDAwMDAwNTE0LCJzY29wZSI6IjUiLCJpYXQiOjE1NzA4NzM4OTM5NjZ9.wrnaQhzW7a7p34Y10uOvM36BDYmPcEqBq_Tt6j_1h' 'https://api.chime.me/v1.0/me'
HTTP/1.1 200
Date: Sat, 21 Oct 2017 04:16:29 GMT
X-RateLimit-Limit: 20
X-RateLimit-Remaining: 18
X-RateLimit-Reset: 23000
Header Name Description

X-RateLimit-Limit

The maximum number of requests you have allowed in the limited time.
(default: 500/minute)

X-RateLimit-Remaining

The number of requests remaining in the current rate limit window.

X-RateLimit-Reset

The time at which the current rate limit window resets in UTC epoch seconds.
(default: 60000 millisecond)

If you exceed the rate limit, an error response returns:

HTTP/1.1 429
Date: Sat, 21 Oct 2017 07:52:24 GMT
Status: 429 Too Many Requests
X-RateLimit-Limit: 20
X-RateLimit-Remaining: 0
X-RateLimit-Reset: 21000
{"message":"Too Many Requests"}

5. Resources

5.1. Calls

Operations about calls

5.1.1. Search for calls

GET /v1.0/calls
Parameters
Type Name Description Schema Default

Header

Authorization
required

token [access_token]

string

"token "

Header

Content-Type
required

Request Content Type

string

"application/json"

Query

leadId
optional

Finds calls related to a lead ID

integer(int64)

Query

limit
optional

Number of results to return

integer(int32)

Query

offset
optional

Specifies the number of rows to skip, before starting to return results

integer(int32)

Responses
HTTP Code Description Schema

200

OK

CallListResponse

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

5.1.2. Retrieve a call by Id

GET /v1.0/calls/{callId}
Parameters
Type Name Description Schema Default

Header

Authorization
required

token [access_token]

string

"token "

Header

Content-Type
required

Request Content Type

string

"application/json"

Path

callId
required

The ID of the call

integer(int64)

Responses
HTTP Code Description Schema

200

OK

CallResponse

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

5.2. Communication

Communication Controller

5.2.1. Search for call history

GET /v1.0/communication/call
Parameters
Type Name Description Schema Default

Header

Authorization
required

token [access_token]

string

"token "

Header

Content-Type
required

Request Content Type

string

"application/json"

Query

leadId
required

ID of Lead

integer(int64)

Query

limit
required

limit default Value 10, max value 1000

integer(int32)

Query

offset
required

offset default Value 0

integer(int32)

Responses
HTTP Code Description Schema

200

OK

< CallResponse > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

5.2.2. Search for email history

GET /v1.0/communication/email
Parameters
Type Name Description Schema Default

Header

Authorization
required

token [access_token]

string

"token "

Header

Content-Type
required

Request Content Type

string

"application/json"

Query

leadId
required

ID of Lead

integer(int64)

Query

limit
required

limit default Value 10, max value 1000

integer(int32)

Query

offset
required

offset default Value 0

integer(int32)

Responses
HTTP Code Description Schema

200

OK

< EmailResponse > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

5.2.3. Search for text history

GET /v1.0/communication/text
Parameters
Type Name Description Schema Default

Header

Authorization
required

token [access_token]

string

"token "

Header

Content-Type
required

Request Content Type

string

"application/json"

Query

leadId
required

ID of Lead

integer(int64)

Query

limit
required

limit default Value 10, max value 1000

integer(int32)

Query

offset
required

offset default Value 0

integer(int32)

Responses
HTTP Code Description Schema

200

OK

< TextResponse > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

5.3. LeadRouting

Operations about lead routing

5.3.1. Get Assign Member List

GET /v1.0/routing/member/list/{type}
Parameters
Type Name Description Schema Default

Header

Authorization
required

token [access_token]

string

"token "

Header

Content-Type
required

Request Content Type

string

"application/json"

Path

type
required

Routing type:AGENT_LEAD(1), LENDER_LEAD(2), ASSISTANT_LEAD(4)

integer(int32)

Query

roleId
optional

roleId

integer(int32)

"-1"

Responses
HTTP Code Description Schema

200

OK

AssignMember

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

5.3.2. Get Assign Role List

GET /v1.0/routing/role/list
Parameters
Type Name Description Schema Default

Header

Authorization
required

token [access_token]

string

"token "

Header

Content-Type
required

Request Content Type

string

"application/json"

Responses
HTTP Code Description Schema

200

OK

AssignRole

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

5.3.3. Get Routing List

GET /v1.0/routing/rule/list/{type}
Parameters
Type Name Description Schema Default

Header

Authorization
required

token [access_token]

string

"token "

Header

Content-Type
required

Request Content Type

string

"application/json"

Path

type
required

Routing type:AGENT_LEAD(1), LENDER_LEAD(2), ASSISTANT_LEAD(4)

integer(int32)

Query

roleId
optional

Role id, This parameter is required when type == 4

integer(int32)

"-1"

Responses
HTTP Code Description Schema

200

OK

RoutingRule

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

5.3.4. Get default rule

GET /v1.0/routing/rule/supplement/{type}
Parameters
Type Name Description Schema Default

Header

Authorization
required

token [access_token]

string

"token "

Header

Content-Type
required

Request Content Type

string

"application/json"

Path

type
required

Routing type:AGENT_LEAD(1), LENDER_LEAD(2), ASSISTANT_LEAD(4)

integer(int32)

Query

roleId
optional

Role id, This parameter is required when type == 4

integer(int32)

"-1"

Responses
HTTP Code Description Schema

200

OK

SupplementRoutingRule

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

5.3.5. Edit default routing rule

PUT /v1.0/routing/rule/supplement/{type}
Parameters
Type Name Description Schema Default

Header

Authorization
required

token [access_token]

string

"token "

Header

Content-Type
required

Request Content Type

string

"application/json"

Path

type
required

Routing type:AGENT_LEAD(1), LENDER_LEAD(2), ASSISTANT_LEAD(4)

integer(int32)

Body

supplementRoutingRule
required

Supplement rule info that needs to be updatedstore

SupplementRoutingRuleRequest

Responses
HTTP Code Description Schema

200

OK

string

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

5.3.6. Edit routing rule

PUT /v1.0/routing/rule/{type}
Parameters
Type Name Description Schema Default

Header

Authorization
required

token [access_token]

string

"token "

Header

Content-Type
required

Request Content Type

string

"application/json"

Path

type
required

Routing type:AGENT_LEAD(1), LENDER_LEAD(2), ASSISTANT_LEAD(4)

integer(int32)

Body

routingRule
required

Lead info that needs to be updated

RoutingRuleRequest

Responses
HTTP Code Description Schema

200

OK

string

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

5.4. Leads

Operations about leads

5.4.1. Edit a lead from brokermint

PUT /v1.0/brokermint/lead
Parameters
Type Name Description Schema Default

Header

Authorization
required

token [access_token]

string

"token "

Header

Content-Type
required

Request Content Type

string

"application/json"

Path

leadId
required

The ID of the lead to update.

integer(int64)

Body

contacts
required

Lead info that needs to be updated

Contacts

Responses
HTTP Code Description Schema

200

OK

string

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

5.4.2. Update a transaction from brokermint

PUT /v1.0/brokermint/transaction
Description

Update a transaction from brokermint for a lead.

Parameters
Type Name Description Schema Default

Header

Authorization
required

token [access_token]

string

"token "

Header

Content-Type
required

Request Content Type

string

"application/json"

Body

incomingTransaction
required

Lead transaction that needs to be placed

IncomingTransaction

Responses
HTTP Code Description Schema

200

OK

string

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

5.4.3. Create a new lead

POST /v1.0/leads
Description

     Please note that if you do not set "assignedId" and "stage" for a lead,the system will assign the lead acquiescently.

Parameters
Type Name Description Schema Default

Header

Authorization
required

token [access_token]

string

"token "

Header

Content-Type
required

Request Content Type

string

"application/json"

Body

hideVendorId
optional

hideVendorId

integer(int64)

Body

lead
required

Lead info that needs to be added in

LeadRequest

Responses
HTTP Code Description Schema

200

OK
Example: {leadId: 651095960136641}

string

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

5.4.4. Search for leads

GET /v1.0/leads
Parameters
Type Name Description Schema Default

Header

Authorization
required

token [access_token]

string

"token "

Header

Content-Type
required

Request Content Type

string

"application/json"

Query

allTags
optional

Search for lead with all tag names.

string

Query

anyTags
optional

Search for lead with any tag names.

string

Query

assignedUserId
optional

Search for contacts by user that is assigned to them.

integer(int64)

Query

contacted
optional

Search for contacts by if they have or have not been contacted.

boolean

Query

desc
optional

Descending sort(true) or ascending sort(false)

boolean

Query

email
optional

Precise search for lead by email address.

string

Query

groupIds
optional

Search for lead by group ids.

integer(int64)

Query

groups
optional

Search for lead by group names.

string

Query

limit
optional

Quantitative limitation of responded leads, range: [1, 100]

integer(int32)

Query

offset
optional

Start index of the responded leads

integer(int32)

Query

phone
optional

Precise search for lead by phone number.
Example: 3479033333

string

Query

querySubGroup
optional

query sub group leads or not

boolean

Query

scrollId
optional

Scroll ID for the search. You can then use the scroll ID to retrieve the next batch of results for the request.

string

Query

sort
optional

The sort order can be one of the following: Default, LastContact, LastCall, LastEmail, LastActivity, CreateTime, Inquries, DeleteTime, AssignTime, Score, Activity, Communication, HasDrip, HasAlert, Task, Lender, ActivitySearch, ActivityViews, ActivityFavorites, DripStatus, DripOpenRate, AlertFrequency, AlertOpenRate, SCOREV2 or SmartPlanStatus

string

Query

source
optional

Search for lead by source name.

string

Query

stage
optional

Search for lead by pipeline stage names.

string

Responses
HTTP Code Description Schema

200

OK

LeadListResponse

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

5.4.5. Search for leads by create time

GET /v1.0/leads/createTime
Parameters
Type Name Description Schema Default

Header

Authorization
required

token [access_token]

string

"token "

Header

Content-Type
required

Request Content Type

string

"application/json"

Query

allTags
optional

Search for lead with all tag names.

string

Query

anyTags
optional

Search for lead with any tag names.

string

Query

contacted
optional

Search for contacts by if they have or have not been contacted.

boolean

Query

email
optional

Precise search for lead by email address.

string

Query

groups
optional

Search for lead by group names.

string

Query

leadCreateTime
optional

Minimum create time of the responded leads, parsed according to time zone set as UCT-7

string

"2000-01-01 00:00:00"

Query

limit
optional

Quantitative limitation of the responded leads, range: [1, 100]

integer(int32)

"25"

Query

offset
optional

Start index of the responded leads

integer(int32)

"0"

Query

phone
optional

Precise search for lead by phone number.
Example: 3479033333

string

Query

scrollId
optional

Scroll ID for the search. You can then use the scroll ID to retrieve the next batch of results for the request.

string

Query

source
optional

Search for lead by source name.

string

Query

stage
optional

Search for lead by stage names.

string

Responses
HTTP Code Description Schema

200

OK

LeadListResponse

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

5.4.6. Search for leads by update time

GET /v1.0/leads/updateTime
Parameters
Type Name Description Schema Default

Header

Authorization
required

token [access_token]

string

"token "

Header

Content-Type
required

Request Content Type

string

"application/json"

Query

allTags
optional

Search for lead with all tag names.

string

Query

anyTags
optional

Search for lead with any tag names.

string

Query

contacted
optional

Search for contacts by if they have or have not been contacted.

boolean

Query

email
optional

Precise search for lead by email address.

string

Query

groups
optional

Search for lead by group names.

string

Query

leadUpdateTime
optional

Minimum update time of the responded leads, parsed according to time zone set as UCT-7

string

"2000-01-01 00:00:00"

Query

limit
optional

Quantitative limitation of the responded leads, range: [1, 100]

integer(int32)

"25"

Query

offset
optional

Start index of the responded leads

integer(int32)

"0"

Query

phone
optional

Precise search for lead by phone number.
Example: 3479033333

string

Query

scrollId
optional

Scroll ID for the search. You can then use the scroll ID to retrieve the next batch of results for the request.

string

Query

source
optional

Search for lead by source name.

string

Query

stage
optional

Search for lead by stage names.

string

Responses
HTTP Code Description Schema

200

OK

LeadListResponse

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

5.4.7. Retrieve a lead by Id

GET /v1.0/leads/{leadId}
Parameters
Type Name Description Schema Default

Header

Authorization
required

token [access_token]

string

"token "

Header

Content-Type
required

Request Content Type

string

"application/json"

Path

leadId
required

The ID of the lead to get.

integer(int64)

Responses
HTTP Code Description Schema

200

OK

LeadResponse

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

5.4.8. Edit a lead

PUT /v1.0/leads/{leadId}
Parameters
Type Name Description Schema Default

Header

Authorization
required

token [access_token]

string

"token "

Header

Content-Type
required

Request Content Type

string

"application/json"

Path

leadId
required

The ID of the lead to update.

integer(int64)

Body

request
required

Lead info that needs to be updated

EditLeadRequest

Responses
HTTP Code Description Schema

200

OK

string

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

5.4.9. Delete a lead

DELETE /v1.0/leads/{leadId}
Parameters
Type Name Description Schema Default

Header

Authorization
required

token [access_token]

string

"token "

Header

Content-Type
required

Request Content Type

string

"application/json"

Path

leadId
required

The ID of the lead to trash.

integer(int64)

Query

reason
required

The reason to trash this lead

string

Responses
HTTP Code Description Schema

200

OK

string

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/json

Produces
  • application/json

5.4.10. Search for activities

GET /v1.0/leads/{leadId}/activities
Parameters
Type Name Description Schema Default

Header

Authorization
required

token [access_token]

string

"token "

Header

Content-Type
required

Request Content Type

string

"application/json"

Path

leadId
required

leadId

integer(int64)

Query

curPage
optional

The page number of the returning data. One page has 100 data. Default value is 0.

integer(int32)

"0"

Responses
HTTP Code Description Schema

200

OK

< LeadActivity > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

5.4.11. Add activity

POST /v1.0/leads/{leadId}/activity
Description

Add activity to a lead.

Parameters
Type Name Description Schema Default

Header

Authorization
required

token [access_token]

string

"token "

Header

Content-Type
required

Request Content Type

string

"application/json"

Path

leadId
required

leadId

integer(int64)

Body

leadActivity
required

Lead activity

LeadActivity

Responses
HTTP Code Description Schema

200

OK

string

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

5.4.12. Assign a lead

POST /v1.0/leads/{leadId}/assignment
Description

Place assignee to a lead.

Parameters
Type Name Description Schema Default

Header

Authorization
required

token [access_token]

string

"token "

Header

Content-Type
required

Request Content Type

string

"application/json"

Path

leadId
required

leadId

integer(int64)

Body

assigneeRequest
required

Lead assignees

< LeadAssigineeRequest > array

Responses
HTTP Code Description Schema

200

OK

string

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

5.4.13. Place an inquiry

POST /v1.0/leads/{leadId}/inquiry
Description

Place an inquiry for a lead.

Parameters
Type Name Description Schema Default

Header

Authorization
required

token [access_token]

string

"token "

Header

Content-Type
required

Request Content Type

string

"application/json"

Path

leadId
required

leadId

integer(int64)

Body

inquiry
required

Lead inquiry that needs to be placed

LeadInquiry

Responses
HTTP Code Description Schema

200

OK

string

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

5.4.14. Place a property

POST /v1.0/leads/{leadId}/property
Description

Place a property for a lead.

Parameters
Type Name Description Schema Default

Header

Authorization
required

token [access_token]

string

"token "

Header

Content-Type
required

Request Content Type

string

"application/json"

Path

leadId
required

leadId

integer(int64)

Body

property
required

Lead property that needs to be placed

LeadProperty

Responses
HTTP Code Description Schema

200

OK

string

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

5.4.15. Add a transaction

POST /v1.0/leads/{leadId}/transaction
Description

Add a transaction for a lead.

Parameters
Type Name Description Schema Default

Header

Authorization
required

token [access_token]

string

"token "

Header

Content-Type
required

Request Content Type

string

"application/json"

Path

leadId
required

leadId

integer(int64)

Body

leadTransaction
required

Lead transaction that needs to be placed

LeadTransaction

Responses
HTTP Code Description Schema

200

OK

string

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

5.4.16. query transaction by leadId AND transactionId

GET /v1.0/leads/{leadId}/transaction/{transactionId}
Parameters
Type Name Description Schema Default

Header

Authorization
required

token [access_token]

string

"token "

Header

Content-Type
required

Request Content Type

string

"application/json"

Path

leadId
required

leadId

integer(int64)

Path

transactionId
required

transactionId

integer(int64)

Responses
HTTP Code Description Schema

200

OK

LeadTransaction

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

5.4.17. Update a transaction

PUT /v1.0/leads/{leadId}/transaction/{transactionId}
Description

Update a transaction for a lead.

Parameters
Type Name Description Schema Default

Header

Authorization
required

token [access_token]

string

"token "

Header

Content-Type
required

Request Content Type

string

"application/json"

Path

leadId
required

leadId

integer(int64)

Path

transactionId
required

transactionId

integer(int64)

Body

leadTransaction
required

Lead transaction that needs to be placed

LeadTransaction

Responses
HTTP Code Description Schema

200

OK

string

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

5.4.18. query transactions by leadId

GET /v1.0/leads/{leadId}/transactions
Parameters
Type Name Description Schema Default

Header

Authorization
required

token [access_token]

string

"token "

Header

Content-Type
required

Request Content Type

string

"application/json"

Path

leadId
required

leadId

integer(int64)

Responses
HTTP Code Description Schema

200

OK

< LeadTransaction > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

5.5. Members

Operations about team member

5.5.1. Get current user’s info

GET /v1.0/me
Parameters
Type Name Description Schema Default

Header

Authorization
required

token [access_token]

string

"token "

Header

Content-Type
required

Request Content Type

string

"application/json"

Responses
HTTP Code Description Schema

200

OK

UserResponse

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

5.5.2. Get team members

GET /v1.0/members
Parameters
Type Name Description Schema Default

Header

Authorization
required

token [access_token]

string

"token "

Header

Content-Type
required

Request Content Type

string

"application/json"

Query

limit
optional

Quantitative limitation of responded members

integer(int32)

Query

offset
optional

Start index of the responded members

integer(int32)

Responses
HTTP Code Description Schema

200

OK

MemberListResponse

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

5.5.3. Get member by account

GET /v1.0/members/{account}
Description

Get team member by member account.

Parameters
Type Name Description Schema Default

Header

Authorization
required

token [access_token]

string

"token "

Header

Content-Type
required

Request Content Type

string

"application/json"

Path

account
required

The account (email) of the team member to get

string

Responses
HTTP Code Description Schema

200

OK

UserResponse

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

5.5.4. Get user by Id

GET /v1.0/users/{userId}
Caution

operation.deprecated

Parameters
Type Name Description Schema Default

Header

Authorization
required

token [access_token]

string

"token "

Header

Content-Type
required

Request Content Type

string

"application/json"

Path

userId
required

The ID of the user to get

integer(int64)

Responses
HTTP Code Description Schema

200

OK

UserResponse

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

5.5.5. Edit a user

PUT /v1.0/users/{userId}
Parameters
Type Name Description Schema Default

Header

Authorization
required

token [access_token]

string

"token "

Header

Content-Type
required

Request Content Type

string

"application/json"

Path

userId
required

userId

integer(int64)

Body

userRequest
required

user info that needs to be updated

UserRequest

Responses
HTTP Code Description Schema

200

OK

string

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

5.6. Notes

Operations about lead notes

5.6.1. Add a note

POST /v1.0/notes
Parameters
Type Name Description Schema Default

Header

Authorization
required

token [access_token]

string

"token "

Header

Content-Type
required

Request Content Type

string

"application/json"

Body

leadNote
required

LeadNote info that needs to be added in

NoteRequest

Responses
HTTP Code Description Schema

200

OK
Example: {noteId: 12345}

string

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

5.6.2. Search for notes

GET /v1.0/notes
Parameters
Type Name Description Schema Default

Header

Authorization
required

token [access_token]

string

"token "

Header

Content-Type
required

Request Content Type

string

"application/json"

Query

includeSystemNote
optional

Include System note or not

boolean

Query

leadId
required

ID of Lead

integer(int64)

Responses
HTTP Code Description Schema

200

OK

< NoteResponse > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

5.6.3. Get note by Id

GET /v1.0/notes/{noteId}
Parameters
Type Name Description Schema Default

Header

Authorization
required

token [access_token]

string

"token "

Header

Content-Type
required

Request Content Type

string

"application/json"

Path

noteId
required

ID of Note

integer(int64)

Responses
HTTP Code Description Schema

200

OK

NoteResponse

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

5.6.4. Edit a note

PUT /v1.0/notes/{noteId}
Parameters
Type Name Description Schema Default

Header

Authorization
required

token [access_token]

string

"token "

Header

Content-Type
required

Request Content Type

string

"application/json"

Path

noteId
required

The ID of the note to update

integer(int64)

Body

leadNote
required

LeadNote info that needs to be updatedstore

NoteRequest

Responses
HTTP Code Description Schema

200

OK

string

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json;charset=UTF-8

5.6.5. Delete a note

DELETE /v1.0/notes/{noteId}
Parameters
Type Name Description Schema Default

Header

Authorization
required

token [access_token]

string

"token "

Header

Content-Type
required

Request Content Type

string

"application/json"

Path

noteId
required

The ID of the note to delete

integer(int64)

Responses
HTTP Code Description Schema

200

OK

string

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/json

Produces
  • application/json;charset=UTF-8

5.7. Tasks & Appointments

Operations about tasks and appointments

5.7.1. Get appointments of lead

GET /v1.0/appts
Parameters
Type Name Description Schema Default

Header

Authorization
required

token [access_token]

string

"token "

Header

Content-Type
required

Request Content Type

string

"application/json"

Query

leadId
required

Lead id

integer(int64)

Responses
HTTP Code Description Schema

200

OK

Appointment

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

5.7.2. Add a new task

POST /v1.0/tasks
Parameters
Type Name Description Schema Default

Header

Authorization
required

token [access_token]

string

"token "

Header

Content-Type
required

Request Content Type

string

"application/json"

Body

leadTask
required

LeadTask info that needs to be added in

TaskRequest

Responses
HTTP Code Description Schema

200

OK

string

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

5.7.3. Get tasks of lead

GET /v1.0/tasks
Parameters
Type Name Description Schema Default

Header

Authorization
required

token [access_token]

string

"token "

Header

Content-Type
required

Request Content Type

string

"application/json"

Query

leadId
required

The ID of the lead to get tasks

integer(int64)

Responses
HTTP Code Description Schema

200

OK

TaskResponse

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

5.7.4. Get task by Id

GET /v1.0/tasks/{taskId}
Parameters
Type Name Description Schema Default

Header

Authorization
required

token [access_token]

string

"token "

Header

Content-Type
required

Request Content Type

string

"application/json"

Path

taskId
required

The ID of the task to get

integer(int64)

Responses
HTTP Code Description Schema

200

OK

TaskResponse

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

5.7.5. Update a new task

PUT /v1.0/tasks/{taskId}
Parameters
Type Name Description Schema Default

Header

Authorization
required

token [access_token]

string

"token "

Header

Content-Type
required

Request Content Type

string

"application/json"

Path

taskId
required

The ID of the Task to update

integer(int64)

Body

leadTask
required

LeadTask info that needs to be updated

TaskRequest

Responses
HTTP Code Description Schema

200

OK

string

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

5.7.6. Delete a task

DELETE /v1.0/tasks/{taskId}
Parameters
Type Name Description Schema Default

Header

Authorization
required

token [access_token]

string

"token "

Header

Content-Type
required

Request Content Type

string

"application/json"

Path

taskId
required

The ID of the Task to delete

integer(int64)

Responses
HTTP Code Description Schema

200

OK

string

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/json

Produces
  • application/json

5.8. TeamFeatures

Operations about team feature

5.8.1. Search lead pond

GET /v1.0/team-features/lead-pond/{id}
Parameters
Type Name Description Schema Default

Header

Authorization
required

token [access_token]

string

"token "

Header

Content-Type
required

Request Content Type

string

"application/json"

Path

id
required

id

integer(int64)

Responses
HTTP Code Description Schema

200

OK

LeadPond

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

5.8.2. list lead pond

GET /v1.0/team-features/lead-ponds
Parameters
Type Name Description Schema Default

Header

Authorization
required

token [access_token]

string

"token "

Header

Content-Type
required

Request Content Type

string

"application/json"

Responses
HTTP Code Description Schema

200

OK

< LeadPond > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

5.8.3. add new custom field

POST /v1.0/teamFeatures/custom-field
Parameters
Type Name Description Schema Default

Header

Authorization
required

token [access_token]

string

"token "

Header

Content-Type
required

Request Content Type

string

"application/json"

Body

customAttribute
required

customAttribute

CustomAttribute

Responses
HTTP Code Description Schema

200

OK

string

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

5.8.4. Search custom field

GET /v1.0/teamFeatures/listCustomField
Parameters
Type Name Description Schema Default

Header

Authorization
required

token [access_token]

string

"token "

Header

Content-Type
required

Request Content Type

string

"application/json"

Responses
HTTP Code Description Schema

200

OK

< CustomAttribute > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

5.8.5. Search existing tag

GET /v1.0/teamFeatures/listTag
Parameters
Type Name Description Schema Default

Header

Authorization
required

token [access_token]

string

"token "

Header

Content-Type
required

Request Content Type

string

"application/json"

Responses
HTTP Code Description Schema

200

OK

< UserLeadTag > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

5.9. Webhooks

Use webhooks to be notified about events that happen in a chime account
supported webhook events:
1, Agent List List id: 1
Scope: ​UserResponse
2, Lead Information
List id: 2
Scope: ​LeadResponse
3, Lead Activity
List id: 3
Scope: ​LeadActivity 4, Listing Alert
List id: 4
Scope: ​Alert

5.9.1. add a new webhook

POST /v1.0/webhook
Parameters
Type Name Description Schema Default

Header

Authorization
required

token [access_token]

string

"token "

Header

Content-Type
required

Request Content Type

string

"application/json"

Body

webhookRequest
required

webhook info that needs to be added in

WebhookRequest

Responses
HTTP Code Description Schema

200

OK

WebhookResponse

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

5.9.2. Delete a webhook

DELETE /v1.0/webhook/{subscribeId}
Parameters
Type Name Description Schema Default

Header

Authorization
required

token [access_token]

string

"token "

Header

Content-Type
required

Request Content Type

string

"application/json"

Path

subscribeId
required

The subscribeId of the webhook to delete

integer(int64)

Responses
HTTP Code Description Schema

200

OK

string

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/json

Produces
  • application/json

5.9.3. get all webhook from current team

GET /v1.0/webhooks
Parameters
Type Name Description Schema Default

Header

Authorization
required

token [access_token]

string

"token "

Header

Content-Type
required

Request Content Type

string

"application/json"

Responses
HTTP Code Description Schema

200

OK

string

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

5.10. Agent Organization

Operations agent organization

5.10.1. Get User Organization

GET /v1.0/org
Parameters
Type Name Description Schema Default

Header

Authorization
required

token [access_token]

string

"token "

Header

Content-Type
required

Request Content Type

string

"application/json"

Responses
HTTP Code Description Schema

200

OK

OrganizationInfo

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

5.11. Broker

Operations about broker team

5.11.1. Create team under the broker account

POST /v1.0/broker/team
Parameters
Type Name Description Schema Default

Header

Authorization
required

token [access_token]

string

"token "

Header

Content-Type
required

Request Content Type

string

"application/json"

Body

brokerTeam
required

brokerTeam

BrokerTeam

Responses
HTTP Code Description Schema

200

OK

string

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

5.11.2. Remove team from the broker account

DELETE /v1.0/broker/team/{id}
Parameters
Type Name Description Schema Default

Header

Authorization
required

token [access_token]

string

"token "

Header

Content-Type
required

Request Content Type

string

"application/json"

Path

id
required

id

integer(int64)

Responses
HTTP Code Description Schema

200

OK

string

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/json

Produces
  • application/json

5.12. Listing

Listing data Controller

5.12.1. getByUserId

GET /v1.0/listing
Parameters
Type Name Description Schema Default

Header

Authorization
required

token [access_token]

string

"token "

Header

Content-Type
required

Request Content Type

string

"application/json"

Query

agentListings
optional

agentListings

boolean

"false"

Query

limit
optional

limit

integer(int32)

"25"

Query

listingId
required

listingId

string

Query

mlsListingIds
optional

mlsListingIds

string

Query

nextPageKey
optional

nextPageKey

string

Query

officeListings
optional

officeListings

boolean

"false"

Query

openHouse
optional

openHouse

boolean

"false"

Query

showCondition
optional

showCondition

boolean

"false"

Query

soldListingId
required

soldListingId

string

Query

street
optional

street

string

Query

userId
optional

userId

integer(int64)

"0"

Responses
HTTP Code Description Schema

200

OK

string

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

5.13. LogType

Operations about lead log call/log email/log text

5.13.1. Add a log call/email/text

POST /v1.0/logType
Parameters
Type Name Description Schema Default

Header

Authorization
required

token [access_token]

string

"token "

Header

Content-Type
required

Request Content Type

string

"application/json"

Body

request
required

logType info that needs to be added in

LogTypeRequest

Responses
HTTP Code Description Schema

200

OK

string

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

5.13.2. Search for log call/email/text

GET /v1.0/logType
Parameters
Type Name Description Schema Default

Header

Authorization
required

token [access_token]

string

"token "

Header

Content-Type
required

Request Content Type

string

"application/json"

Query

leadId
required

ID of Lead

integer(int64)

Query

limit
required

limit default Value 10, max value 1000

integer(int32)

Query

logType
required

query type value: logCall,logEmail,logText

string

Query

offset
required

offset default Value 0

integer(int32)

Responses
HTTP Code Description Schema

200

OK

< LogTypeResponse > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

5.13.3. Get log call/email/text by Id

GET /v1.0/logType/{logTypeId}
Parameters
Type Name Description Schema Default

Header

Authorization
required

token [access_token]

string

"token "

Header

Content-Type
required

Request Content Type

string

"application/json"

Path

logTypeId
required

ID of Log type

integer(int64)

Responses
HTTP Code Description Schema

200

OK

LogTypeResponse

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

5.13.4. Delete a log type

DELETE /v1.0/logType/{logTypeId}
Parameters
Type Name Description Schema Default

Header

Authorization
required

token [access_token]

string

"token "

Header

Content-Type
required

Request Content Type

string

"application/json"

Path

logTypeId
required

The ID of the log type to delete

integer(int64)

Responses
HTTP Code Description Schema

200

OK

string

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/json

Produces
  • application/json;charset=UTF-8

5.14. System Logs

query lead system logs

5.14.1. Search for system logs

GET /v1.0/systemLogs
Parameters
Type Name Description Schema Default

Header

Authorization
required

token [access_token]

string

"token "

Header

Content-Type
required

Request Content Type

string

"application/json"

Query

endTime
optional

the timestamp of end

integer(int64)

"-1"

Query

leadId
required

ID of Lead

integer(int64)

Query

pageNumber
optional

page number, fist is 0

integer(int64)

"0"

Query

pageSize
optional

ID of Lead

integer(int64)

"100"

Query

startTime
optional

the timestamp of start

integer(int64)

"-1"

Responses
HTTP Code Description Schema

200

OK

< SystemLogResponse > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/json

6. Definitions

6.1. ActiveHours

Name Description Schema

activeDays
optional

Active day list, between 1 and 7

< integer(int32) > array

hoursEnd
optional

Active hours end, between 0 and 23

integer(int32)

hoursStart
optional

Active hours start, between 0 and 23

integer(int32)

6.2. AgentInfo

Name Description Schema

companyAddress
optional

Agent company Address

string

companyName
optional

Agent Company Name

string

licenseId
optional

Agent license Id

string

mlsAgentId
optional

MLS Agent Id

string

position
optional

Agent position

string

6.3. Appointment

Name Description Schema

address
optional

The location of the appointment

string

allDay
optional

Whether the appointment time is all day
Example : false

boolean

assignRoleType
optional

The user role of the appointment assigned to

integer(int32)

assignToUid
optional

The user’s Id of the appointment assigned to

integer(int64)

createTime
optional

The create time of the appointment

string(date-time)

creatorId
optional

The user ID of this appointment creator

integer(int64)

deadline
optional

The start time of the appointment

integer(int64)

deleteFlag
optional

If the appointment is deleted or not
Example : false

boolean

descr
optional

The description of the appointment

string

endTime
optional

The end time of the appointment

integer(int64)

finishFlag
optional

If the appointment is finished or not
Example : false

boolean

finishTime
optional

The finish time of the task

integer(int64)

id
optional

The Id of the appointment

integer(int64)

lastUpdate
optional

The last update time of the appointment

string(date-time)

leadId
optional

The lead(Id) associated with the appointment

integer(int64)

overdue
optional

If the appointment is overdue or not
Example : false

boolean

6.4. AssignMember

Name Description Schema

id
optional

Member id

integer(int64)

name
optional

Member name

string

type
optional

Member type
Example : "Agent(1), Lender(2), Pond(3);"

integer(int32)

6.5. AssignRole

Name Description Schema

id
optional

Role id

integer(int64)

name
optional

Role name

string

6.6. BrokerTeam

Name Description Schema

email
required

Team admin email

string

firstName
required

Team admin first name

string

lastName
required

Team admin last name

string

phone
required

Team admin phone

string

seatLimit
required

Team seat limit

integer(int32)

teamName
required

Team Name

string

6.7. CallListResponse

Name Schema

_metadata
optional

MetaData

calls
optional

< CallResponse > array

6.8. CallResponse

Name Description Schema

agentId
optional

The related Agent ID

integer(int64)

callingOutcome
optional

The outcome of the call
Example : "Talked"

string

createTime
optional

The createTime of the call

string

dialerCallRecordId
optional

The Id of the call record

integer(int64)

direction
optional

Outbound or Inbound call
Example : "Outbound"

string

duration
optional

The duration of the call

integer(int32)

elapsedTime
optional

The connection time of the call

string

endTime
optional

The end time of the call

string

id
optional

The Id of the call

integer(int64)

isMachineAnswered
optional

If the call is answered by machine
Example : false

boolean

leadId
optional

The lead(Id) associated with the call

integer(int64)

leadPhoneNumber
optional

The phone number of the lead

string

note
optional

The note of the call

string

price
optional

The price of the call

number(double)

rateScore
optional

The rateScore of the call

integer(int32)

recordingSwitch
optional

If record this call or not
Example : false

boolean

showUserNumber
optional

The phone number showed for the lead who received this call

string

startTime
optional

The start time of the call

string

status
optional

The status of the call

string

updateTime
optional

The updateTime of the call

string

userId
optional

The Id of the user

integer(int64)

userPhoneNumber
optional

The phone number of the user

string

6.9. Contacts

Name Schema

address
optional

string

bmPrivate
optional

boolean

city
optional

string

contactType
optional

string

email
optional

string

externalId
optional

string

firstName
optional

string

lastName
optional

string

leadSource
optional

string

phone
optional

string

state
optional

string

zip
optional

string

6.10. CustomAttribute

Name Description Schema

attributeName
required

The name of this custom field

string

attributeType
required

The type of the field
Example : "number、text、date"

string

value
required

The content of the field, It’s optional when adding a new custom field for team

string

6.11. CustomRole

Name Description Schema

assignee
optional

The user account of this custom role

string

assigneeId
optional

The user id of this custom role

integer(int64)

role
required

The name of this custom role

string

roleId
required

The ID of this custom role

integer(int32)

6.12. EditLeadRequest

Name Description Schema

assignedUserId
optional

Id of the agent assigned to this contact
Example : 10000000514

integer(int64)

birthday
optional

The birthday of the lead(pattern:MMM d, yyyy)
Example : "Jun 5, 2001"

string

buyHouse
optional

Buy a house, Yes or No.
Example : "Yes"

string

buyingTimeFrame
optional

buying time frame, 1-3, 3-6, 6-12, 12+, Just Looking, Refinancing.
Example : "6-12"

string

city
optional

The city associated with the lead
Example : "Washington DC"

string

customAttributeList
optional

User customized field

< CustomAttribute > array

emails
optional

A list of email addresses associated with the lead

< string > array

firstName
optional

The first/given name of the lead
Caution: Max limit 30 characters. If you exceed the limit, the import will succuss, but only import 30 characters in front.
Example : "Bob"

string

fthb
optional

first time home buyer, Yes or No.
Example : "Yes"

string

groups
optional

The groups the lead is in
Caution: Max limit 30 characters.If you exceed the limit,the import will success , but only import 30 characters in front.

< string > array

houseToSell
optional

House to Sell, Yes or No.
Example : "Yes"

string

inquiry
optional

The inquiry of the lead

LeadInquiry

isPrivate
optional

The lead is private or not
Example : false

boolean

lastName
optional

The last/family name of the lead
Caution: Max limit 30 characters. If you exceed the limit, the import will succuss, but only import 30 characters in front.
Example : "Li"

string

leadFamilyMemberList
optional

A list of family members associated with the lead. You can add up to 4 family members.

< LeadFamilyMember > array

leadTransaction
optional

LeadTransaction

leadType
optional

Type of lead, expressed by ID. Type ID : Other (-1), Seller (1), Buyer (2), Buyer & Seller (3), Renter (5)
Example : -1

integer(int32)

mortgage
optional

Mortgage, Yes or No.
Example : "Yes"

string

phones
optional

A list of phone numbers associated with the lead. (No more than 20 characters per phone)

< string > array

preQual
optional

Pre-qual, Yes or No.
Example : "Yes"

string

property
optional

The property of the lead.

LeadProperty

referredBy
optional

The referee of the lead
Example : "Jeremy Kelly"

string

sellingTimeFrame
optional

selling time frame, 1-3, 3-6, 6-12, 12+, Just Looking, Refinancing.
Example : "1-3"

string

source
optional

The source of the lead
Example : "Open House"

string

stage
optional

The stage the lead is in, less than 20 characters
Example : "Pending"

string

state
optional

The state associated with the lead
Example : "Washington DC"

string

streetAddress
optional

The streetAddress associated with the lead
Example : "The White House,1600 Pennsylvania Avenue NW"

string

tags
optional

The tags associated with the lead. All existing tags will be updated based on this call
Caution: Max limit 64 characters.If you exceed the limit,the import will success , but only import 64 characters in front.

< string > array

tagsAdd
optional

The tags associated with the lead. All existing tags will be retained, only add new tags base on this call
Caution: Max limit 64 characters. If you exceed the limit, the import will success, but only import 64 characters in front.

< string > array

unsubscription
optional

Unsubscription the email
Example : false

boolean

withBuyerAgent
optional

With buyer Agent, Yes or No.
Example : "Yes"

string

withListingAgent
optional

With listing agent, Yes or No.
Example : "Yes"

string

zipCode
optional

ZipCode
Example : "20500"

string

6.13. EmailResponse

Name Description Schema

agentId
optional

The related Agent ID

integer(int64)

direction
optional

Outbound or Inbound email
Example : "Outbound"

string

emailEventTime
optional

The event time of the email

string

emailSubject
optional

The subject of the email

string

emailType
optional

Manual or Auto email
Example : "Auto"

string

eventType
optional

Sent, Opened or Bounced event
Example : "Sent"

string

id
optional

The ID of the email

integer(int64)

leadId
optional

The lead(Id) associated with the email

integer(int64)

6.14. EnterpriseInfo

Name Description Schema

groupId
optional

Group ID

integer(int64)

groupName
optional

Group Name

string

profileId
optional

Permission Profile ID

integer(int64)

profileName
optional

Permission Profile Name

string

visibleOrgInfoList
optional

Visible Sub Org Info

< VisibleOrgInfo > array

6.15. IncomingTransaction

Name Schema

acceptanceDate
optional

Timestamp

address
optional

string

agentId
optional

integer(int64)

agentName
optional

string

city
optional

string

closedAt
optional

Timestamp

closingDate
optional

Timestamp

expirationDate
optional

Timestamp

id
optional

integer(int64)

price
optional

number

representing
optional

string

state
optional

string

status
optional

string

transactionType
optional

string

zip
optional

string

6.16. LeadActivity

Name Description Schema

created
required

created time in milliseconds
Example : 1518078026000

integer(int64)

link
required

Url for web page
Example : "https://chime.me"

string

listing
optional

Listing details

LeadProperty

pageName
optional

The page name of the lead’s submission(re-inquiry) page
Example : "Blog Registration"

string

picture
required

Preview picture url
Example : "https://chime.me/default.jpg"

string

scheduledDate
optional

Scheduled date about this showing request

string

text
required

Search Text
Example : "Search"

string

type
required

Type, Search, Browse, Favorite, Request, Submission
Example : "Search"

string

6.17. LeadAssigineeRequest

Name Description Schema

assiginee
optional

Account of assignee
Example : "info@chime-mail.me"

string

role
required

Role, Agent, Assistant, Lender
Example : "Agent"

string

6.18. LeadFamilyMember

Name Description Schema

birthday
optional

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

string

emails
optional

A list of email addresses associated with the lead

< string > array

firstName
required

The first name of the family member

string

lastName
optional

The last name of the family member

string

phones
optional

A list of phone numbers associated with the family member. (No more than 20 characters per phone)

< string > array

relationship
optional

The relationship of this family member to primary lead. Example: Husband

string

6.19. LeadInquiry

Name Description Schema

address
optional

string

bathroomsMax
optional

string

bathroomsMin
optional

Bath Rooms
Example : "1"

string

bedroomsMax
optional

integer(int32)

bedroomsMin
optional

Bed Rooms
Example : 1

integer(int32)

buyerRequest
optional

< string > array

cityForEmailShow
optional

string

cityForShow
optional

string

citys
optional

< string > array

countys
optional

< string > array

createTime
optional

string(date-time)

defaultValue
optional

boolean

deleteFlag
optional

boolean

id
optional

integer(int64)

leadUserId
optional

integer(int64)

locationForNotification
optional

string

locations
optional

Locations

< Location > array

locationsOfHomePage
optional

string

modifyByAgent
optional

boolean

priceMax
optional

Price range higher end
Example : 10000000

integer(int64)

priceMin
optional

Price range lower end
Example : 1

integer(int64)

priceRange
optional

string

propertyType
optional

Property types: Single Family Home, Multi-Family, Condo, Townhouse, Mobile Home, Manufactured Home, Vacant Land, Commercial.

< string > array

showStatus
optional

integer(int32)

sizeMax
optional

Square Feet Maximal
Example : 10000

integer(int32)

sizeMin
optional

Square Feet Minimal
Example : 10

integer(int32)

states
optional

< string > array

streetAddresses
optional

< string > array

updateByView
optional

Example : false

boolean

updateTime
optional

string(date-time)

zipcodes
optional

< string > array

6.20. LeadListResponse

Name Schema

_metadata
optional

MetaData

leads
optional

< LeadResponse > array

6.21. LeadPond

Name Description Schema

agentIds
optional

The accessible agent id of the lead pond, It’s a list with user ids

< integer(int64) > array

id
required

The id of this lead pond

integer(int64)

pondName
required

The name of this lead pond

string

pondOwnerId
required

The owner user id of the lead pond

integer(int64)

6.22. LeadProperty

Name Description Schema

autoListingId
optional

integer(int64)

bathrooms
optional

The bath rooms.
Example : 2.0

number(double)

bedrooms
optional

The bed rooms.
Example : 3

integer(int32)

city
optional

The city (Applies to lead routing).
Example : "New York"

string

county
optional

The county (Applies to lead routing).

string

deleteFlag
optional

boolean

floors
optional

The floors.
Example : 1

integer(int32)

id
optional

integer(int64)

label
optional

string

labelList
optional

string

labelType
optional

string

leadUserId
optional

integer(int64)

listingId
optional

string

listingStatus
optional

string

lotSize
optional

The lot size (acreage).
Example : 26.33

number(double)

mailAddress
optional

Mailing address
Example : false

boolean

note
optional

string

parkingSpace
optional

The parking space.
Example : 1

integer(int64)

pictureUrl
optional

string

price
optional

The price (Applies to lead routing).
Example : 100000

integer(int64)

priceMax
optional

The max price (Applies to lead routing).
Example : 10000000

integer(int64)

priceMin
optional

The min price (Applies to lead routing).
Example : 100000

integer(int64)

propertyType
optional

Property type: Single Family Home, Multi-Family, Condo, Townhouse, Mobile Home, Manufactured Home, Vacant Land, Commercial.
Example : "Single Family Home"

string

siteListingUrl
optional

string

squareFeet
optional

The square feet.
Example : 100

integer(int64)

state
optional

The state (Applies to lead routing).
Example : "California"

string

streetAddress
optional

The street address (Applies to lead routing).
Example : "22348 Regnart RD"

string

updateTime
optional

string

zipCode
optional

The zip code (Applies to lead routing).
Example : "25401"

string

6.23. LeadRequest

Name Description Schema

assignedUserId
optional

Id of the agent assigned to this contact
Example : 10000000514

integer(int64)

birthday
optional

The birthday of the lead(pattern:MMM d, yyyy)
Example : "Jun 5, 2001"

string

buyHouse
optional

Buy a house, Yes or No.
Example : "Yes"

string

buyingTimeFrame
optional

buying time frame, 1-3, 3-6, 6-12, 12+, Just Looking, Refinancing.
Example : "6-12"

string

city
optional

The city associated with the lead
Example : "Washington DC"

string

customAttributeList
optional

User customized field

< CustomAttribute > array

defaultInquiryParam
optional

boolean

emails
optional

A list of email addresses associated with the lead

< string > array

firstName
required

The first/given name of the lead
Caution: Max limit 30 characters. If you exceed the limit, the import will succuss, but only import 30 characters in front.
Example : "Bob"

string

fthb
optional

first time home buyer, Yes or No.
Example : "Yes"

string

groups
optional

The groups the lead is in
Caution: Max limit 30 characters.If you exceed the limit,the import will success , but only import 30 characters in front.

< string > array

houseToSell
optional

House to Sell, Yes or No.
Example : "Yes"

string

inquiry
optional

The inquiry of the lead

LeadInquiry

isPrivate
optional

The lead is private or not
Example : false

boolean

lastName
optional

The last/family name of the lead
Caution: Max limit 30 characters. If you exceed the limit, the import will succuss, but only import 30 characters in front.
Example : "Li"

string

leadAlert
optional

send new lead alert email. (Not supporting update)
Example : false

boolean

leadFamilyMemberList
optional

A list of family members associated with the lead. You can add up to 4 family members.

< LeadFamilyMember > array

leadTransaction
optional

LeadTransaction

leadType
optional

Type of lead, expressed by ID. Type ID : Other (-1), Seller (1), Buyer (2), Buyer & Seller (3), Renter (5)
Example : -1

integer(int32)

mortgage
optional

Mortgage, Yes or No.
Example : "Yes"

string

phones
optional

A list of phone numbers associated with the lead. (No more than 20 characters per phone)

< string > array

preQual
optional

Pre-qual, Yes or No.
Example : "Yes"

string

property
optional

The property of the lead.

LeadProperty

referredBy
optional

The referee of the lead
Example : "Jeremy Kelly"

string

sellingTimeFrame
optional

selling time frame, 1-3, 3-6, 6-12, 12+, Just Looking, Refinancing.
Example : "1-3"

string

source
optional

The source of the lead
Example : "Open House"

string

stage
optional

The stage the lead is in, less than 20 characters
Example : "Pending"

string

state
optional

The state associated with the lead
Example : "Washington DC"

string

streetAddress
optional

The streetAddress associated with the lead
Example : "The White House,1600 Pennsylvania Avenue NW"

string

tags
optional

The tags associated with the lead. All existing tags will be updated based on this call
Caution: Max limit 64 characters.If you exceed the limit,the import will success , but only import 64 characters in front.

< string > array

tagsAdd
optional

The tags associated with the lead. All existing tags will be retained, only add new tags base on this call
Caution: Max limit 64 characters. If you exceed the limit, the import will success, but only import 64 characters in front.

< string > array

unsubscription
optional

Unsubscription the email
Example : false

boolean

welcomeEmail
optional

send Welcome Email. (Not supporting update)
Example : false

boolean

withBuyerAgent
optional

With buyer Agent, Yes or No.
Example : "Yes"

string

withListingAgent
optional

With listing agent, Yes or No.
Example : "Yes"

string

zipCode
optional

ZipCode
Example : "20500"

string

6.24. LeadResponse

Name Description Schema

assignCompletionStatus
optional

Whether complete all lead assign process
Example : false

boolean

assignTime
optional

The assigned time of the lead

string

assignedUser
optional

The Username of the lead assigned to

string

assignedUserId
optional

The user Id of the lead assigned to

integer(int64)

birthday
optional

The birthday of the lead

string

buyHouse
optional

Buy a house, Yes or No.
Example : "Yes"

string

buyingTimeFrame
optional

buying time frame, 1-3, 3-6, 6-12, 12+, Just Looking, Refinancing.
Example : "6-12"

string

city
optional

The city associated with the lead

string

createTime
optional

The create time of the lead

string

customAttributes
optional

User customized field

< CustomAttribute > array

customRoleList
optional

< CustomRole > array

emails
optional

The email list of the lead

< string > array

facebook
optional

The Facebook account of the lead

string

firstName
optional

The first/given name of the lead

string

fthb
optional

first time home buyer, Yes or No
Example : "Yes"

string

groups
optional

The groups that the lead in

< string > array

houseToSell
optional

House to Sell, Yes or No
Example : "Yes"

string

lastName
optional

The last/family name of the lead

string

lastTouch
optional

The last touch time of the lead

string

lastUpdateTime
optional

The update time of the lead

string

lastVisit
optional

The last visit time of the lead

string

leadFamilyMemberList
optional

A list of family members associated with the lead

< LeadFamilyMember > array

leadId
optional

The Id of the lead

integer(int64)

leadInquiry
optional

LeadInquirys

LeadInquiry

leadPropertyList
optional

LeadPropertyList

< LeadProperty > array

leadSource
optional

The leadSource(Id) about the lead

integer(int32)

leadType
optional

Type of lead, expressed by ID. Type ID : Other (-1), Seller (1), Buyer (2), Buyer & Seller (3)

integer(int32)

leadUserId
optional

The user Id of the lead

integer(int64)

lenderUserId
optional

The user Id of the lead’s lender

integer(int64)

mortgage
optional

Mortgage, Yes or No.
Example : "Yes"

string

opportunity
optional

The opportunity type of the lead
Example : "High Interest"

string

phoneStatuses
optional

The status of the phone number
Type id: invaild number(1), vaild number(2), talked(3), DNC Number(4), DNC Contact(5)

< integer(int32) > array

phones
optional

The phone list of the lead

< string > array

pondId
optional

The Id of the lead’s pond

integer(int64)

pondName
optional

The Name of the lead’s pond

string

preQual
optional

Pre-qual, Yes or No
Example : "Yes"

string

privateFlag
optional

The lead is private or not
Example : false

boolean

referredBy
optional

The referee of the lead

string

score
optional

The score of the lead

integer(int32)

sellingTimeFrame
optional

selling time frame, 1-3, 3-6, 6-12, 12+, Just Looking, Refinancing.
Example : "1-3"

string

source
optional

The source of the lead

string

stage
optional

The stage of the lead

string

stageId
optional

The stageId of the lead

integer(int64)

state
optional

The state associated with the lead

string

streetAddress
optional

The streetAddress associated with the lead

string

tags
optional

The tags of the lead

< UserLeadTagVo > array

teamId
optional

The teamId of the lead’s team

integer(int64)

twitter
optional

The Twitter account of the lead

string

unsubscription
optional

Unsubscription the email
Example : false

boolean

withBuyerAgent
optional

With buyer Agent, Yes or No
Example : "Yes"

string

withListingAgent
optional

With listing agent, Yes or No.
Example : "Yes"

string

zipCode
optional

The zip code associated with the lead

string

6.25. LeadTransaction

Name Description Schema

agentRevenue
optional

The agent revenue of transaction
Example : 4000.0

number

agreementSignedDate
optional

integer(int64)

appointmentDate
optional

integer(int64)

appraisalDate
optional

integer(int64)

assignedAgent
optional

Lead’s assigned agent (not support updating)

integer(int64)

closeDate
optional

The closed date of transaction
Example : 1508580010000

integer(int64)

commissionRate
optional

The commission rate of transaction
Example : 3.0

number

contractDate
optional

integer(int64)

created
required

created time in milliseconds
Example : 1518078026000

integer(int64)

escrowDate
optional

integer(int64)

expectedCloseDate
optional

The expected close date of transaction
Example : 1508580010000

integer(int64)

expiration
optional

integer(int64)

gci
optional

The GCI of transaction
Example : 5000.0

number

homeInspectionDate
optional

integer(int64)

homePrice
optional

The home price of transaction
Example : 1000000.0

number

leadName
optional

Lead’s name whom the transaction is assigned to (not support updating)
Example : "Bob"

string

offerDate
optional

integer(int64)

teamRevenue
optional

The team revenue of transaction
Example : 1000.0

number

transactionId
optional

integer(int64)

transactionName
required

Property Address/Transaction Name
Example : "123 Main St"

string

transactionStatus
optional

The status of transaction
Example : "Pre-contract"

string

transactionType
optional

The type of Transaction
Example : "[\"Purchase\",\"Listing\"]"

string

updated
required

updated time in milliseconds (not support updating)
Example : 1518078026000

integer(int64)

6.26. Location

Name Description Schema

city
optional

The city (Applies to lead routing).
Example : "Palm Desert"

string

county
optional

The county (Applies to lead routing).

string

description
optional

Description of location.
Example : "other"

string

stateCode
optional

The state code of city (Applies to lead routing).
Example : "CA"

string

streetAddress
optional

The street address (Applies to lead routing).

string

zipCode
optional

The zip code (Applies to lead routing).
Example : "92211"

string

6.27. LocationRule

Name Description Schema

city
optional

City setting

string

county
optional

County setting

string

locationMatchType
optional

Location match type
Example : "MATCH_EXACTLY(1),EMPTY_OR_MATCH(2);"

integer(int32)

state
optional

State setting
Example : "NL"

string

streetAddress
optional

StreetAddress setting

string

zipcode
optional

Zipcode setting

string

6.28. LogTypeRequest

Name Description Schema

callingOutcome
optional

Talked,VoiceMessage,NoAnswer,BadNumber,DNCNumber,DNCContact
Example : "VoiceMessage"

string

content
required

log type content
Example : "example log content"

string

isPin
optional

Pin this activity or not
Example : false

boolean

leadId
required

The ID of the lead this log type is related to
Example : 563172647619608

integer(int64)

leadPhoneNumber
optional

The value of the lead phone number
Example : "586****860"

string

logType
required

values:logCall,logEmail,logText
Example : "logCall"

string

outboundOrInbound
optional

Outbound or inbound communication
Example : "'outbound','inbound'"

string

6.29. LogTypeResponse

Name Description Schema

agentId
optional

Operator’s agent id

integer(int64)

callingOutcome
optional

Calling Outcome value:Talked,VoiceMessage,NoAnswer,BadNumber,DNCNumber,DNCContact

string

createTime
optional

The create time of log type

string

id
optional

The Id of the log type

integer(int64)

isPin
optional

Pin this activity or not
Example : false

boolean

leadId
optional

The lead(Id) associated with the call/email/text

integer(int64)

leadPhoneNumber
optional

The lead phone number

string

outboundOrInbound
optional

Outbound or inbound communication

string

6.30. MemberListResponse

Name Schema

_metadata
optional

MetaData

members
optional

< UserResponse > array

6.31. MemberWeight

Name Description Schema

firstName
optional

Member first name, edit don’t need this param

string

lastName
optional

Member last name, edit don’t need this param

string

memberId
optional

Member id

integer(int64)

weight
optional

Member weight

integer(int32)

6.32. MetaData

Name Description Schema

collection
optional

The element of the array
Example : "note"

string

limit
optional

Quantitative limitation of responded elements
Example : 10

integer(int32)

offset
optional

Start index of the responded elements
Example : 0

integer(int64)

scrollId
optional

Scroll ID for the search. You can then use the scroll ID to retrieve the next batch of results for the request.

string

total
optional

The sum of retrieved elements
Example : 50

integer(int64)

6.33. MultiTeamInfo

Name Description Schema

multiTeamId
optional

Mult-Team ID

integer(int64)

multiTeamName
optional

Multi-Team Name

string

6.34. NoteRequest

Name Description Schema

content
required

Note content
Example : "example_note"

string

isPin
optional

Pin this note or not
Example : false

boolean

leadId
required

The ID of the lead this note is related to
Example : 563172647619608

integer(int64)

6.35. NoteResponse

Name Description Schema

content
optional

The content of the note

string

createTime
optional

The create time of the note

string

creatorId
optional

The user Id of the note’s creator

integer(int64)

creatorName
optional

The creator’s name of the note

string

deleteFlag
optional

If the note is deleted of not
Example : false

boolean

id
optional

The Id of the note

integer(int64)

isPin
optional

Pin this note or not
Example : false

boolean

lastEditorId
optional

The last user Id to edit the note

integer(int64)

lastEditorName
optional

The last editor’s name of the note

string

lastUpdate
optional

The last update time of the note

string

leadId
optional

The lead(Id) associated with the note

integer(int64)

systemNote
optional

Is system note or not
Example : false

boolean

6.36. OrganizationInfo

Name Description Schema

enterpriseInfo
optional

If the client is on the "Enterprise Package," the enterprise organization structure will be returned. Refer to "EnterpriseInfo."

EnterpriseInfo

multiTeamInfo
optional

If the client is on the "Multi-Team Package," the Multi-Team info will be returned.

MultiTeamInfo

orgType
optional

Organization type
Example : "SIGNAL_INSTANCE(1), MULTI_TEAM(2)"

integer(int64)

6.37. RoutingRule

Name Description Schema

activeHours
optional

Active hours setting

ActiveHours

groupMatchType
optional

Group match type
Example : "MATCH_EXACTLY(1),EMPTY_OR_MATCH(2);"

integer(int32)

groupNames
optional

Lead group name list

< string > array

id
optional

Rule id

integer(int64)

leadType
optional

lead type
Example : "Other(-1),Seller(1),Buyer(2),B&S(3),Renter(5)"

integer(int32)

locationRule
optional

Location rule

LocationRule

name
optional

Rule name

string

phone
optional

Phone setting
Example : "'With'、'Without'、 ''"

string

priceMax
optional

Price max

integer(int64)

priceMin
optional

Price min

integer(int64)

routingStrategy
optional

Active hours setting

RoutingStrategy

ruleSwitch
optional

Rule switch
Example : false

boolean

sourceMatchType
optional

Lead source name
Example : "MATCH_EXACTLY(1),EMPTY_OR_MATCH(2);"

integer(int32)

sourceName
optional

Lead source name

string

tagMatchType
optional

Tag match type
Example : "MATCH_EXACTLY(1),EMPTY_OR_MATCH(2);"

integer(int32)

tagNames
optional

Lead tag name list

< string > array

updateTime
optional

Update time

integer(int64)

6.38. RoutingRuleRequest

Name Description Schema

activeHours
optional

Active hours setting

ActiveHours

id
optional

Rule id

integer(int64)

routingStrategy
optional

Active hours setting

RoutingStrategy

6.39. RoutingStrategy

Name Description Schema

groupId
optional

Only lead pond are affected

integer(int64)

groupName
optional

Edit method don’t need this params

string

memberWeights
optional

Except for the lead pond type

< MemberWeight > array

strategyType
optional

Strategy type
Example : "Next Up(1), Blast Alert(2), Round Robin(3), Lead Pond(4)"

integer(int32)

touchMinutes
optional

Only next up and blast alert are affected

integer(int32)

6.40. SupplementRoutingRule

Name Description Schema

assigneeAgentId
optional

Only default assignee are affected

string

assigneeAgentName
optional

Only default assignee are affected

string

assigneeGroupId
optional

Only default assignee are affected

string

assigneeGroupName
optional

Only default assignee are affected

string

businessType
optional

Routing type
Example : "AGENT_LEAD(1), LENDER_LEAD(2), ASSISTANT_LEAD(4);"

integer(int32)

roleId
optional

Role id

integer(int32)

strategyType
optional

Strategy type
Example : "Next_Up(1), BLAST_ALERT(2), DEFAULT_ASSIGNEE(3);"

integer(int32)

touchMinutes
optional

Only next up and blast alert are affected

integer(int32)

updateTime
optional

Update time

integer(int64)

6.41. SupplementRoutingRuleRequest

Name Description Schema

assigneeAgentId
optional

Only default assignee are affected

integer(int64)

assigneeGroupId
optional

Only default assignee and routing type is AGENT_LEAD are affected

integer(int64)

roleId
optional

Role id, This parameter is required when type == 4

integer(int32)

strategyType
optional

Strategy type
Example : "Next_Up(1), BLAST_ALERT(2), DEFAULT_ASSIGNEE(3);"

integer(int32)

touchMinutes
optional

Only next up and blast alert are affected

integer(int32)

6.42. SystemLogResponse

Name Description Schema

agentId
optional

The id of the agent

integer(int64)

canSticky
optional

canSticky
Example : false

boolean

content
optional

content(JSON)

string

createTime
optional

The timestamp of the create time

integer(int64)

fromFirstName
optional

The first name of the FROM

string

fromId
optional

The id of the FROM

integer(int64)

fromLastName
optional

The last name of the FROM

string

fromType
optional

The type of the FROM

integer(int32)

id
optional

id

integer(int64)

leadFullName
optional

The full name of the lead

string

leadId
optional

The id of the lead

integer(int64)

sticky
optional

sticky
Example : false

boolean

timelineTime
optional

The timestamp of the timeline

integer(int64)

timelineType
optional

The type of the timeline

integer(int32)

toFirstName
optional

The first name of the TO

string

toId
optional

The id of the TO

integer(int64)

toLastName
optional

The last name of the TO

string

toType
optional

The type of the TO

integer(int32)

updateTime
optional

The timestamp of the update time

integer(int64)

6.43. TaskRequest

Name Description Schema

assignedRole
required

Role the task should be assigned to (Agent Or Assistant)
Example : "Agent"

string

content
required

Description of the task
Example : "Send an email to my lead"

string

deadline
required

Deadline of the task
Example : 1508580010000

integer(int64)

leadId
required

The ID of the lead this task is related to.
Example : 563172647619608

integer(int64)

type
required

The type of the task. Could be Other, Call, Email, Text
Example : "Call"

string

6.44. TaskResponse

Name Description Schema

assignedRole
optional

The role of the task assigned to

string

assignedUser
optional

The user of the task assigned to

string

assignedUserId
optional

The user’s Id of the task assigned to

integer(int64)

body
optional

The body of the task

string

content
optional

The content of the task

string

createTime
optional

The create time of the task

string

creatorId
optional

The creator’s Id of the task

integer(int64)

deadline
optional

The deadline of the task

string

deleteFlag
optional

If the task is deleted or not
Example : false

boolean

finishFlag
optional

If the task is finished or not
Example : false

boolean

finishTime
optional

The finish time of the task

string

id
optional

The Id of the task

integer(int64)

lastUpdate
optional

The last update time of the task

string

leadEmail
optional

The lead’s email associated with the task

string

leadFirstName
optional

The lead’s first name of the task

string

leadId
optional

The lead(Id) associated with the task

integer(int64)

leadLastName
optional

The lead’s last name of the task

string

leadName
optional

The lead’s name associated with the task

string

leadPhone
optional

The lead’s phone associated with the task

string

leadUserId
optional

The lead’s user Id associated with the task

integer(int64)

overdueFlag
optional

If the task is overdue or not
Example : false

boolean

pipelineId
optional

The pipeline(Id) of the associated lead

integer(int64)

queryId
optional

The queryId of the task

integer(int64)

queryInfo
optional

The queryInfo of the task

string

reminderType
optional

The reminder’s type of the task

integer(int32)

subject
optional

The subject of the task

string

teamId
optional

The team’s Id associated with the task

integer(int64)

type
optional

The type of the task

string

6.45. TextResponse

Name Description Schema

agentId
optional

The related Agent ID

integer(int64)

direction
optional

Outbound or Inbound text
Example : "Outbound"

string

id
optional

The ID of the text

integer(int64)

leadId
optional

The lead(Id) associated with the text

integer(int64)

textOutcome
optional

Text delivery status
Example : "Delivered"

string

textTime
optional

The sending time of the text

string

textType
optional

Manual or Auto text
Example : "Auto"

string

6.46. Timestamp

Name Schema

date
optional

integer(int32)

day
optional

integer(int32)

hours
optional

integer(int32)

minutes
optional

integer(int32)

month
optional

integer(int32)

nanos
optional

integer(int32)

seconds
optional

integer(int32)

time
optional

integer(int64)

timezoneOffset
optional

integer(int32)

year
optional

integer(int32)

6.47. UserLeadTag

Name Schema

createTime
optional

string(date-time)

creatorUserId
optional

integer(int64)

leadId
optional

integer(int64)

tagId
optional

integer(int64)

tagName
optional

string

updateTime
optional

string(date-time)

visibleType
optional

integer(int32)

6.48. UserLeadTagVo

Name Schema

createTime
optional

string

creatorUserId
optional

integer(int64)

leadId
optional

integer(int64)

tagId
optional

integer(int64)

tagName
optional

string

updateTime
optional

string

visibleType
optional

integer(int32)

6.49. UserRequest

Name Description Schema

agentInfo
optional

The agent infomation of the user

AgentInfo

email
optional

The email of the member
Example : "roseTest@chimeinc.com"

string

firstName
optional

The firstName of the member
Example : "Rose"

string

headPortrait
optional

The head portrait of the member
Example : "https://cdn.chime.me/image/fs/user-info/2019122/16/original_6e611e6d-0416-42e6-ba74-b077d55a1129.png"

string

lastName
optional

The lastName of the member
Example : "Bob"

string

phoneNumber
optional

The phone number of the member
Example : "19022342233"

string

timeZoneId
optional

The time zone of the member. timeZoneId: "America/Halifax",
"America/New_York",
"America/Chicago",
"America/Denver",
"America/Los_Angeles",
"America/Anchorage",
"America/Adak",
"US/Arizona",
"Asia/Hong_Kong"
Example : "America/Los_Angeles"

string

6.50. UserResponse

Name Description Schema

agentInfo
optional

The agent infomation of the user

AgentInfo

assignedLeadCount
optional

The count about assigned leads of the member

integer(int32)

email
optional

The email of the member

string

firstLetter
optional

The firstLetter of the member

string

firstName
optional

The firstName of the member

string

id
optional

The Id of the team’s member

integer(int64)

invitorUserId
optional

The user Id of the member invited by

integer(int64)

isAdmin
optional

If the member is admin or not
Example : false

boolean

lastName
optional

The lastName of the member

string

memberUserId
optional

The user Id of the member

integer(int64)

newLeadCount
optional

The count about new leads of the member

integer(int32)

phoneNumber
optional

The phone number of the member

string

role
optional

The role(Id) of the member

integer(int32)

roleName
optional

The role(name) of the member

string

status
optional

The status of the member

integer(int32)

timeZoneId
optional

The agent timezoneId

string

virtualNumber
optional

The virtual number of the member

string

6.51. VisibleOrgInfo

Name Description Schema

groupId
optional

Group ID

integer(int64)

groupName
optional

Group Name

string

parentId
optional

Parent Group ID

integer(int64)

6.52. WebhookRequest

Name Description Schema

callbackUrl
required

The url link that you receive information
Example : "http://xxx.test.com"

string

limit
optional

limitation of webhook notifications in 30 mins for each, max is 5000
Example : 100

integer(int32)

listId
required

The list that you want to subscribe.
ListId: agent info(1), lead info(2), lead activity(3), alert(4), transaction(5), call(6), email(7), text(8), note(9), task(10), appointment(11),changePipeline(12)

integer(int32)

6.53. WebhookResponse

Name Description Schema

callbackUrl
required

The url link that you receive information
Example : "http://xxx.test.com"

string

limit
optional

limitation of webhook notifications in 30 mins for each, max is 5000
Example : 100

integer(int32)

listId
required

The ID of the list to get
Example : 1

integer(int32)

subscribeId
required

the subscribe id
Example : 1234

integer(int64)

teamId
required

The ID of the team to get
Example : 13233324

integer(int64)