API to send estimate by estimate id

http
POST https://services.leadconnectorhq.com/invoices/estimate/{estimateId}/send

Authorization

NameTypeRequiredExampleDescription
AuthorizationstringYesBearer token generated from the Leadway portal. See Authentication.
VersionstringYes2021-07-28API version.

Path parameters

NameTypeRequiredExampleDescription
estimateIdstringYes5f9d6d8b1b2d2c001f2d9e4bEstimate Id

Body

NameTypeRequiredExampleDescription
altIdstringYes6578278e879ad2646715ba9cAccount Id or Agency Id
altTypestringYesPossible values: 'account'
actionstringYesPossible values: 'sms_and_email', 'send_manually', 'email', 'sms'
liveModebooleanYesTruelivemode for estimate
userIdstringYes6578278e879ad2646715ba9cPlease ensure that the UserId corresponds to an authorized personnel, either by an employee ID or agency ID, to access this account. This account will serve as the primary channel for all future communications and updates.
sentFromobjectNosender details for invoice, valid only if invoice is not sent manually
estimateNamestringNoEstimateestimate name

Responses

201 - Created
  • altId (string, required): Account Id or Agency Id Example: 6578278e879ad2646715ba9c

  • altType (string, required): Possible values: 'account'

  • _id (string, required): Unique identifier Example: 67ac9a51106ee8311e911XXXX

  • liveMode (boolean, required): Indicates if it is in live mode Example: True

  • deleted (boolean, required): Indicates if deleted Example: False

  • name (string, required): Name Example: Estimate Name

  • currency (string, required): Currency code Example: USD

  • businessDetails (object, required): Business details associated with the estimate

  • items (array[], required): An array of items

  • discount (object, required): Discount details for the estimate template

  • title (string): Title Example: ESTIMATE

  • estimateNumberPrefix (string): Estimate number prefix Example: EST-

  • attachments (object[]): Attachments

    • id (string, required): Id of the file selected Example: 6241712be68f7a98102ba272

    • name (string, required): Name of the file Example: Electronics.pdf

    • url (string, required): URL of the file Example: https://example.com/digital-delivery

    • type (string, required): Type of the file

    • size (number, required): Size of the file Example: 10000

  • updatedBy (string): User Id of who last updated Example: 3HIpOF9NIc5ltriQXXXX

  • total (number, required): Total amount Example: 1222.03

  • createdAt (string, required): Timestamp when created Example: 2025-02-12T13:17:47.416Z

  • updatedAt (string, required): Timestamp when last updated Example: 2025-02-12T13:17:47.416Z

  • __v (number, required): Version number Example: 0

  • automaticTaxesEnabled (boolean, required): Indicates if automatic taxes are enabled for this estimate Example: False

  • termsNotes (string): Terms and conditions for the estimate, supports HTML markup Example: <p>All services are subject to availability.</p>

  • companyId (string, required): Company identifier associated with the estimate Example: COMP12345

  • contactDetails (object, required): Contact details for the estimate

  • issueDate (string, required): Date when the estimate was issued Example: 2023-06-15T00:00:00.000Z

  • expiryDate (string, required): Date when the estimate expires Example: 2023-07-15T00:00:00.000Z

  • sentBy (string): User who sent the estimate Example: user@example.com

  • automaticTaxesCalculated (boolean, required): Indicates if automatic taxes were calculated Example: True

  • meta (object, required): Additional metadata associated with the estimate

  • estimateActionHistory (string[], required): History of actions taken on the estimate

  • sentTo (object, required): Recipient details for the estimate

  • frequencySettings (object, required): Frequency settings for recurring estimates

  • lastVisitedAt (string, required): Timestamp when the estimate was last visited Example: 2023-06-20T08:30:00.000Z

  • totalamountInUSD (number, required): Total amount in USD Example: 1500.75

  • autoInvoice (object): Auto-invoice settings for the estimate

  • traceId (string, required): Trace ID for logging and debugging Example: 010c7a01-857f-4619-970d-xyxyxyxy

json
{
  "altId": "6578278e879ad2646715ba9c",
  "altType": "account",
  "_id": "67ac9a51106ee8311e911XXXX",
  "liveMode": true,
  "deleted": false,
  "name": "Estimate Name",
  "currency": "USD",
  "businessDetails": {
    "logoUrl": "your_image-url",
    "name": "Business name",
    "address": {
      "addressLine1": "address line 1",
      "city": "Test City",
      "state": "State Name",
      "countryCode": "US",
      "postalCode": "12345"
    },
    "phoneNo": "+1 1234567890",
    "website": "www.example.com",
    "customValues": [
      {
        "name": "Test",
        "fieldKey": "{{custom_values.test}}",
        "id": "5DYTWoiQvWiIJZXX44XXX",
        "value": "Test's Custom Value"
      }
    ]
  },
  "items": [
    {
      "taxes": [],
      "taxInclusive": false,
      "_id": "67ac9a51106ee8311e911XXXX",
      "description": "<p>Futuristic anti-gravity racing</p>",
      "currency": "USD",
      "productId": "67ac9a51106ee8311e911XXXX",
      "priceId": "67ac9a51106ee8311e911XXXX",
      "amount": 9.99,
  // truncado: 86 lineas mas
}
400 - Bad Request
json
{}
401 - Unauthorized
json
{}
422 - Unprocessable Entity
json
{}

Example

curl -X POST 'https://services.leadconnectorhq.com/invoices/estimate/YOUR_estimateId/send' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Version: 2021-07-28' \
  -H 'Content-Type: application/json' \
  -d '{
  "altId": "6578278e879ad2646715ba9c",
  "altType": "account",
  "action": "sms_and_email",
  "liveMode": true,
  "userId": "6578278e879ad2646715ba9c",
  "estimateName": "Estimate"
}'

Last updated October 26, 2026

Was this page helpful?