v2

latestOpenAPI 3.0.02026-08-08112115411.4 KB

Leads

Update installments for a lead

Replaces the lead's installment schedule. The request body is a JSON array of installment objects (id, dueTime, description, value, isFailed). dueTime is an ISO 8601 string. Requires lead installments on the account plan.

post/leads/{id}/installments

Path parameters

idstring required

Lead ID

Request body

idstring

dueTimestring required

descriptionstring

valuestring required

isFailedboolean required

Example request

[
  {
    "id": "1-installments",
    "dueTime": "2026-01-01T00:00:00+0000",
    "description": "Q1 payment",
    "value": "1000"
  }
]

Response

Updated installments

Example response

{
  "installments": [
    {
      "id": "1-installments",
      "dueTime": "2026-01-01T00:00:00+0000",
      "description": "Q1 payment",
      "value": {
        "currency": "USD",
        "amount": 1000
      },
      "failedTime": "2026-01-01T12:00:00+0000",
      "isPaid": true
    }
  ]
}