Edit Promise

This request can edit or remove Promises.

   Click here to learn more about this request

If a lender issues a bit of good will towards a customer, they can use Promises to keep track of the customer's end of the deal:

• Promises help users keep track of agreements, and they can be automatically fulfilled by a determined set of criteria.
• Editing a promise requires its ID. To pull promise history, send a GET request.

For an example of how promises work within the UI, take a look at our Promises Overview article.

Database

For information on promises database tables, see the following articles:

• Database – Loan Promise Info (loan_promise_entity)
• Database – Loan Table (loan_entity)

Editing a Promise

{
     "Promises": {
          "results": [
               {
                    "id": 517,
                    "type": "loanpromise.type.payment",
                    "subject": "Edited API Demo Promise",
                    "note": "<b>This promise was edited via the API! <3</b>",
                    "amount": 25,
                    "dueDate": "7/17/2023",
                    "fulfilled": 0,
                    "__id": 517,
                    "__update": true
               }
          ]
     }
}

Deleting a Promise

{
    "Promises": {
        "results": [
            {
                "__id": 9284,
                "__destroy": true
            }
        ]
    }
}