Add Applicants

Add Buyer

This endpoint allows you to add a buyer to a credit application in the system. It is typically used when you need to include additional parties involved in a credit application process.

Request

  • Method: POST

  • Endpoint: {{url}}/api/method/emotive_app.api.crm.credit_app.add_buyer

Request Body

The request body must be sent in JSON format and should include the following parameters:

  • application_id (string): The unique identifier for the credit application to which the buyer is being added.

  • party_name (string): The name of the buyer being added.

  • role (string): The role of the buyer in the application process (e.g., "Co Buyer 1").

Example Request Body:

{
  "application_id": "C-2024-08-00014",
  "party_name": "Allen Dobbins",
  "role": "Co Buyer 1"
}

Response

The response will provide confirmation of the buyer's addition to the specified credit application. The structure of the response typically includes:

  • status (string): Indicates whether the operation was successful or if there was an error.

  • message (string): A descriptive message providing additional context about the operation's result.

  • buyer_id (string): The unique identifier for the newly added buyer, if applicable.

Example Response:

{
  "status": "success",
  "message": "Buyer added successfully.",
  "buyer_id": "B-2024-08-00001"
}

Ensure that the request body is correctly formatted to avoid errors and receive the expected response.

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

Request Method

  • POST

Endpoint

  • {{url}}/api/method/emotive_app.api.crm.credit_app.add_buyer

Example Request

{
    "application_id": "C-2024-08-00014",
    "party_name": "Allen Dobbins",
    "role": "Co Buyer 1"
}

Response Explanation

A successful response returns HTTP status 200 and an empty JSON object.


Example Response

{}
Body Params
string
required
Defaults to C-2026-01-00004

Unique credit application ID (format: C-YYYY-MM-#####)

string
required
Defaults to Co Buyer 1

Role of the buyer being added (see Role Values below)

string
required
Defaults to 2026-00039

Party ID or applicant ID to be added

Headers
string
required
Defaults to <Token>
Responses

403

Forbidden

404

Not Found

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