API
  1. Emotive Collection
  2. Lending
  3. Log a Call

Log Outgoing Call

This endpoint logs an outgoing call made to a customer contact from a Lending Account. It creates an Emotive Call Log record with the call reason, call outcome, call time and note, the same as the Log a Call screen.

Endpoint

POST {{url}}/api/resource/Emotive Call Log

Example Request

{
  "type": "Outgoing",
  "start_time": "2026-09-23 04:31:19",
  "end_time": "2026-09-23 04:31:19",
  "activity_code": "BCELL",
  "result_code": "BICC",
  "reference_document_type": "Contact",
  "reference_document_name": "Austin A Billins-2025-01143",
  "to": "5676754323",
  "caller": "[email protected]",
  "call_made_from_doctype": "LMS Lending Accounts",
  "call_made_from_document": "LA-015793",
  "note": "Outgoing call",
  "status": "Completed",
  "is_manual": 1
}

Request Body

Send the call details as a JSON object with the fields at the top level (do not wrap them in doc).

FieldTypeRequiredDescription
typestringYesCall direction. Use Outgoing.
start_timestringYesCall start date and time. See Date and time format.
end_timestringYesCall end date and time. Must be the same as or later than start_time.
activity_codestringYesCall Reason code. See Call Reason and Call Outcome.
result_codestringYesCall Outcome code for the selected Call Reason. See Call Reason and Call Outcome.
reference_document_typestringYesAlways send Contact. If omitted, it defaults to Lead.
reference_document_namestringYesContact ID of the Buyer, Co Buyer or Co Signer who was called. See Selecting the contact.
tostringYesPhone number that was called. Use the signer's primary_mobile_no or primary_phone.
callerstringYesEmail ID of the Emotive user who made the call. Must be an existing user.
call_made_from_doctypestringYesSend LMS Lending Accounts.
call_made_from_documentstringYesLending Account ID the call was made from, for example LA-015793.
notestringNoNote about the call.
statusstringYesSend Completed.
is_manualintegerYesSend 1 for a manually logged call.

Do not send from or call_receiver. They are used only for incoming calls.

Date and time format

start_time and end_time use the format YYYY-MM-DD HH:mm:ss in 24-hour time, in the site's time zone.

  • Example: 2026-09-23 16:05:00 for 4:05 PM on 23 September 2026.
  • Do not send T, Z or a time zone offset.
  • end_time must not be earlier than start_time.

Call Reason and Call Outcome

The Call Reason is an Activity Code record. For an outgoing call, only Activity Codes with Activity Type Call and Direction Outbound or Both are valid.

Each Call Reason has its own list of allowed Call Outcomes. Send a result_code from the list for the selected activity_code.

Call Reason and Call Outcome mapping for outgoing calls

Call Reason (activity_code)Allowed Call Outcomes (result_code)
BCELL – Calling buyer cell numberLMM – Left voicemail
BCELD – Buyer cell disconnected
BCELC – Buyer cell contact made
BIPM – Buyer incoming promise made
BICC – Buyer incoming
BPCO – Calling buyer POEBPCO – Buyer POE comment only
BPOC – Buyer POE callBPCO – Buyer POE comment only
BPLM – Buyer POE left message
BPPM – Buyer POE promise made
BPTT – Buyer POE talked to
CALL – CallCONTACT MADE
NO CONTACT
LEFT MESSAGE
LEFT VOICEMAIL
AUTHORIZED WORK TO START
PAYMENT MADE
PROMISE TO PAY

Send the code exactly as shown, including spaces, for example "result_code": "CONTACT MADE".

Call Reasons and Call Outcomes are configured per site, so the list can differ between environments. To get the current values, use Supporting APIs 1 and 2.

Selecting the contact (reference_document_name)

reference_document_name is the Contact ID of the person being called on the Lending Account: the Buyer, a Co Buyer or the Co Signer. For example, when logging a call with the Co Buyer, send the Co Buyer's Contact ID.

To find the Contact ID, call Supporting APIs 3 and look in the signers list. Each entry in data.signers has a party_role and a contact. Use the contact of the entry whose party_role matches the person being called:

party_rolePerson
BuyerBuyer (primary borrower)
Co Buyer 1First co-buyer
Co Buyer 2Second co-buyer
Co SignerCo-signer

Example from Lending Account LA-015793:

"signers": [
  {
    "party_role": "Buyer",
    "customer": "2025-01143",
    "contact": "Austin A Billins-2025-01143",
    "full_name": "Austin A Billins1 Sr.",
    "primary_phone": "5676754323",
    "primary_mobile_no": "5676754323"
  }
]

To log a call with this Buyer, send "reference_document_name": "Austin A Billins-2025-01143".

to is the phone number of the same signer. Use their primary_mobile_no or primary_phone from Supporting APIs 3.

Response

The response returns the created Emotive Call Log record wrapped inside a data object.

  • name – Unique ID of the call log record
  • owner, creation, modified, modified_by, docstatus, idx – System metadata
  • type, start_time, end_time, activity_code, result_code, caller, to, note, status, is_manual – Call details as sent in the request
  • reference_document_type, reference_document_name – Contact who was called
  • call_made_from_doctype, call_made_from_document – Lending Account the call was logged from
  • additional_context – Snapshot of the Lending Account's amounts due, days past due, next due and last paid at the time the call was logged
  • is_ai_generated_summary – Whether the call summary was generated by AI (0 for manually logged calls)
  • doctype – Always Emotive Call Log

Example Response

{
  "data": {
    "name": "4p574mbaq6",
    "owner": "[email protected]",
    "creation": "2026-09-23 05:02:18.259309",
    "modified": "2026-09-23 05:02:18.259309",
    "modified_by": "[email protected]",
    "docstatus": 0,
    "idx": 0,
    "from": "",
    "status": "Completed",
    "start_time": "2026-09-23 04:31:19",
    "reference_document_type": "Contact",
    "reference_document_name": "Austin A Billins-2025-01143",
    "activity_code": "BCELL",
    "result_code": "BICC",
    "is_manual": 1,
    "note": "Outgoing call from API",
    "call_made_from_doctype": "LMS Lending Accounts",
    "call_made_from_document": "LA-015793",
    "to": "5676754323",
    "type": "Outgoing",
    "call_receiver": "",
    "caller": "[email protected]",
    "end_time": "2026-09-23 04:31:19",
    "is_ai_generated_summary": 0,
    "additional_context": "Due with Fees: $ 0.00 · Due without Fees: $ 0.00 (0 payments due) · Days Past Due: 0 · Next Due: $ 1,000.00 (10-22-2026)\nLast Paid: N/A",
    "doctype": "Emotive Call Log"
  }
}

Status Codes

CodeMeaning
200OK

After the call is logged

  • The call appears in the Lending Account's activity timeline.
  • A snapshot of the account's balances at the time of the call is saved on the call log.
  • Because is_manual is 1, the Lending Account is marked as worked in the collection queue.
  • The contact's last contacted date is updated on the Lending Account.

Supporting APIs

📘

Get valid values before logging a call

Use these APIs to get valid values for activity_code, result_code, reference_document_name and to before logging the call.

1. Get Call Reasons

Returns the Call Reasons that can be used for outgoing calls.

GET {{url}}/api/resource/Activity Code?filters=[["activity_type","=","Call"],["direction","in",["Outbound","Both"]]]&fields=["code","description"]&limit_page_length=0

Use data[].code as activity_code.

2. Get Call Outcomes for a Call Reason

Returns the Call Outcomes allowed for the selected Call Reason.

GET {{url}}/api/resource/Activity Code/{activity_code}

Use data.result_codes[].code as result_code.

3. Get the contact from the Lending Account

Returns the Buyer, Co Buyers and Co Signer on the Lending Account, with each person's Contact ID and primary phone numbers.

GET {{url}}/api/resource/LMS Lending Accounts/{lending_account_id}

Use data.signers[].contact of the person being called as reference_document_name. See Selecting the contact.

Use data.signers[].primary_mobile_no or data.signers[].primary_phone of the same person as to.

Updated 11 days ago

Did this page help you?

Updated 11 days ago

Did this page help you?