Update Roles on Credit Application

This API is used to update roles for applicants within a specific credit application. It enables assigning or changing applicant roles (e.g., Buyer, Co Buyer 1, etc.) on an existing credit application record.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Request Method

  • POST

End Point

{{url}}/api/method/emotive_app.api.crm.credit_app.update_roles

Example Request

{
  "doctype": "Credit Application",
  "docname": "C-2024-08-00014",
  "new_roles": {
    "2024-CA-08-000019": "Buyer",
    "2024-CA-08-000035": "Co Buyer 1"
  }
}

Response Explanation

A successful response will return a confirmation message.


Response Body Parameters

  • message (string)
    Status message, typically "Ok" on success.

Example Response

{
  "message": "Ok"
}
Body Params
string
required
Defaults to Credit Application

Document type - must be "Credit Application"

string
required
Defaults to C-2024-08-00014

Unique identifier of the credit application

json
required
Defaults to { "2024-CA-08-000019":"Buyer", "2024-CA-08-000035":"Co Buyer 1" }

Object mapping applicant IDs to their new roles

Headers
string
required
Defaults to <Token>
Responses

400

Bad Request

403

Forbidden

409

Conflict

422

Unprocessable Entity

500

Internal Server Error

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json