# Update template PUT https://services.leadconnectorhq.com/invoices/template/{templateId} API to update an template by template id ## Authentication Send `Authorization: Bearer ` using any one of: - **Sub-Account token: OAuth access token or Private Integration Token.** Scopes: `invoices/template.write` - **Agency token: OAuth access token or Private Integration Token.** Scopes: `invoices/template.write` ## Parameters ### Header Parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `Version` | string | Yes | API Version | ### Path Parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `templateId` | string | Yes | Template Id | ## OpenAPI Specification ```json { "openapi": "3.0.0", "info": { "title": "LeadConnector API", "version": "v3" }, "servers": [ { "url": "https://services.leadconnectorhq.com" } ], "paths": { "/invoices/template/{templateId}": { "put": { "summary": "Update template", "operationId": "updateTemplate", "description": "API to update an template by template id", "parameters": [ { "name": "Version", "in": "header", "description": "API Version", "required": true, "schema": { "type": "string", "enum": [ "v3" ] } }, { "name": "templateId", "required": true, "in": "path", "description": "Template Id", "schema": { "example": "6578278e879ad2646715ba9c", "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateInvoiceTemplateDto" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateInvoiceTemplateResponseDto" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestDTO" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedDTO" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnprocessableDTO" } } } } }, "security": [ { "Location-Access": [ "invoices/template.write" ] }, { "Agency-Access": [ "invoices/template.write" ] } ] } } }, "components": { "securitySchemes": { "bearer": { "scheme": "bearer", "bearerFormat": "JWT", "name": "Authorization", "in": "header", "description": "Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.", "type": "http" }, "Location-Access": { "scheme": "bearer", "bearerFormat": "JWT", "name": "Authorization", "in": "header", "description": "Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.", "type": "http" }, "Location-Access-Only": { "scheme": "bearer", "bearerFormat": "JWT", "name": "Authorization", "in": "header", "description": "Use the Access Token generated with user type as Sub-Account.", "type": "http" }, "Agency-Access": { "scheme": "bearer", "bearerFormat": "JWT", "name": "Authorization", "in": "header", "description": "Use the Access Token generated with user type as Agency (OR) Private Integration Token of Agency.", "type": "http" }, "Agency-Access-Only": { "scheme": "bearer", "bearerFormat": "JWT", "name": "Authorization", "in": "header", "description": "Use the Access Token generated with user type as Agency.", "type": "http" } }, "schemas": { "UpdateInvoiceTemplateDto": { "type": "object", "properties": { "altId": { "type": "string", "description": "location Id / company Id based on altType", "example": "6578278e879ad2646715ba9c" }, "altType": { "type": "string", "description": "Alt Type", "enum": [ "location" ], "example": "location" }, "internal": { "type": "boolean" }, "name": { "type": "string", "description": "Name of the template", "example": "New Template" }, "businessDetails": { "type": "object", "properties": { "logoUrl": { "type": "string", "description": "Business Logo URL", "example": "https://example.com/logo.png" }, "name": { "type": "string", "description": "Business Name", "example": "ABC Corp." }, "phoneNo": { "type": "string", "description": "Business Phone Number", "example": "+1-214-559-6993" }, "address": { "description": "Business Address", "example": "9931 Beechwood, TX", "allOf": [ { "type": "object", "properties": { "addressLine1": { "type": "string", "description": "Address Line 1", "example": "9931 Beechwood" }, "addressLine2": { "type": "string", "description": "Address Line 2", "example": "Beechwood" }, "city": { "type": "string", "description": "City", "example": "St. Houston" }, "state": { "type": "string", "description": "State", "example": "TX" }, "countryCode": { "type": "string", "description": "Country Code", "example": "US" }, "postalCode": { "type": "string", "description": "Postal Code", "example": "559-6993" } }, "title": "AddressDto" } ] }, "website": { "type": "string", "description": "Business Website Link", "example": "wwww.example.com" }, "customValues": { "description": "Custom Values", "type": "array", "items": { "type": "string" } } }, "title": "BusinessDetailsDto" }, "currency": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Invoice Item Name", "example": "ABC Product" }, "description": { "type": "string", "description": "Invoice descriptions", "example": "ABC Corp." }, "productId": { "type": "string", "description": "Product Id", "example": "6578278e879ad2646715ba9c" }, "priceId": { "type": "string", "description": "Price Id", "example": "6578278e879ad2646715ba9c" }, "currency": { "type": "string", "description": "Currency", "example": "USD" }, "amount": { "type": "number", "description": "Product amount", "example": 999 }, "qty": { "type": "number", "description": "Product Quantity", "example": 1 }, "taxes": { "description": "Tax", "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string" }, "name": { "type": "string" }, "rate": { "type": "number" }, "calculation": { "type": "string", "enum": [ "exclusive" ] }, "description": { "type": "string" }, "taxId": { "type": "string" } }, "required": [ "_id", "name", "rate" ], "title": "ItemTaxDto" } }, "automaticTaxCategoryId": { "type": "string", "description": "Tax category id for calculating automatic tax", "example": "6578278e879ad2646715ba9c" }, "isSetupFeeItem": { "type": "boolean", "description": "Setupfee item, only created when 1st invoice of recurring schedule is generated" }, "type": { "type": "string", "description": "Price type of the item", "example": "one_time", "enum": [ "one_time", "recurring" ] }, "taxInclusive": { "type": "boolean", "description": "true if item amount is tax inclusive", "example": true, "default": false } }, "required": [ "name", "currency", "amount", "qty" ], "title": "InvoiceItemDto" } }, "discount": { "type": "object", "properties": { "value": { "type": "number", "description": "Discount Value", "example": 10, "default": 0 }, "type": { "type": "string", "description": "Discount type", "enum": [ "percentage", "fixed" ], "example": "percentage", "default": "percentage" }, "validOnProductIds": { "description": "Product Ids on which discount is applicable", "example": "[ '6579751d56f60276e5bd4154' ]", "type": "array", "items": { "type": "string" } } }, "required": [ "type" ], "title": "DiscountDto" }, "termsNotes": { "type": "string" }, "title": { "type": "string", "description": "Template title", "example": "New Template" }, "miscellaneousCharges": { "description": "miscellaneous charges for the invoice", "allOf": [ { "type": "object", "properties": { "charges": { "description": "charges for the processing fee", "items": { "type": "array" }, "type": "array" }, "collectedMiscellaneousCharges": { "type": "number", "description": "collected miscellaneous charges", "example": 10 }, "paidCharges": { "description": "paid miscellaneous charges", "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "name of the processing fee", "example": "Processing Fee" }, "charge": { "type": "number", "description": "charge for the processing fee", "example": 10 }, "amount": { "type": "number", "description": "amount of the processing fee", "example": 10 }, "_id": { "type": "string", "description": "id of the processing fee", "example": "673d01d7d547648a8dab6211" } }, "required": [ "name", "charge", "amount", "_id" ], "title": "ProcessingFeePaidChargeDto" } } }, "required": [ "charges" ], "title": "ProcessingFeeDto" } ] } }, "required": [ "altId", "altType", "name", "businessDetails", "currency", "items" ], "title": "UpdateInvoiceTemplateDto" }, "UpdateInvoiceTemplateResponseDto": { "type": "object", "properties": { "_id": { "type": "string", "description": "Template Id", "example": "6578278e879ad2646715ba9c" }, "altId": { "type": "string", "description": "Location Id or Agency Id", "example": "6578278e879ad2646715ba9c" }, "altType": { "type": "string", "enum": [ "location" ] }, "name": { "type": "string", "description": "Name of the Template", "example": "New Template" }, "businessDetails": { "description": "Business Details", "example": { "name": "Alex", "address": { "addressLine1": "9931 Beechwood", "city": "St. Houston", "state": "TX", "countryCode": "USA", "postalCode": "559-6993" }, "phoneNo": "+1-214-559-6993", "website": "www.example.com" }, "allOf": [ { "type": "object", "properties": { "logoUrl": { "type": "string", "description": "Business Logo URL", "example": "https://example.com/logo.png" }, "name": { "type": "string", "description": "Business Name", "example": "ABC Corp." }, "phoneNo": { "type": "string", "description": "Business Phone Number", "example": "+1-214-559-6993" }, "address": { "description": "Business Address", "example": "9931 Beechwood, TX", "allOf": [ { "type": "object", "properties": { "addressLine1": { "type": "string", "description": "Address Line 1", "example": "9931 Beechwood" }, "addressLine2": { "type": "string", "description": "Address Line 2", "example": "Beechwood" }, "city": { "type": "string", "description": "City", "example": "St. Houston" }, "state": { "type": "string", "description": "State", "example": "TX" }, "countryCode": { "type": "string", "description": "Country Code", "example": "US" }, "postalCode": { "type": "string", "description": "Postal Code", "example": "559-6993" } }, "title": "AddressDto" } ] }, "website": { "type": "string", "description": "Business Website Link", "example": "wwww.example.com" }, "customValues": { "description": "Custom Values", "type": "array", "items": { "type": "string" } } }, "title": "BusinessDetailsDto" } ] }, "currency": { "type": "string", "description": "Currency", "example": "USD" }, "discount": { "description": "Discount", "example": { "type": "percentage", "value": 0 }, "allOf": [ { "type": "object", "properties": { "value": { "type": "number", "description": "Discount Value", "example": 10, "default": 0 }, "type": { "type": "string", "description": "Discount type", "enum": [ "percentage", "fixed" ], "example": "percentage", "default": "percentage" }, "validOnProductIds": { "description": "Product Ids on which discount is applicable", "example": "[ '6579751d56f60276e5bd4154' ]", "type": "array", "items": { "type": "string" } } }, "required": [ "type" ], "title": "DiscountDto" } ] }, "items": { "description": "Invoice Items", "example": [ { "taxes": [], "_id": "c6tZZU0rJBf30ZXx9Gli", "productId": "c6tZZU0rJBf30ZXx9Gli", "priceId": "c6tZZU0rJBf30ZXx9Gli", "currency": "USD", "name": "Macbook Pro", "qty": 1, "amount": 999 } ], "type": "array", "items": { "type": "string" } }, "invoiceNumberPrefix": { "type": "string", "description": "prefix for invoice number", "example": "INV-" }, "total": { "type": "number", "description": "Total Amount", "example": 999 }, "createdAt": { "type": "string", "description": "created at", "example": "2023-12-12T09:27:42.355Z" }, "updatedAt": { "type": "string", "description": "updated at", "example": "2023-12-12T09:27:42.355Z" } }, "required": [ "_id", "altId", "altType", "name", "businessDetails", "currency", "items", "total", "createdAt", "updatedAt" ], "title": "UpdateInvoiceTemplateResponseDto" }, "BadRequestDTO": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "message": { "type": "string", "example": "Bad Request" } }, "title": "BadRequestDTO" }, "UnauthorizedDTO": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "message": { "type": "string", "example": "Invalid token: access token is invalid" }, "error": { "type": "string", "example": "Unauthorized" } }, "title": "UnauthorizedDTO" }, "UnprocessableDTO": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 422 }, "message": { "example": [ "Unprocessable Entity" ], "type": "array", "items": { "type": "string" } }, "error": { "type": "string", "example": "Unprocessable Entity" } }, "title": "UnprocessableDTO" } } } } ``` ## Code Examples **cURL** ```bash curl -L -X PUT 'https://services.leadconnectorhq.com/invoices/template/' \ -H 'Authorization: Bearer ' \ -H 'Version: v3' \ -H 'Content-Type: application/json' \ --data-raw '{ "altId": "6578278e879ad2646715ba9c", "altType": "location", "name": "New Template", "businessDetails": { "logoUrl": "https://example.com/logo.png", "name": "ABC Corp.", "phoneNo": "+1-214-559-6993", "address": "9931 Beechwood, TX", "website": "wwww.example.com", "customValues": [] }, "items": [ { "name": "ABC Product", "description": "ABC Corp.", "productId": "6578278e879ad2646715ba9c", "priceId": "6578278e879ad2646715ba9c", "currency": "USD", "amount": 999, "qty": 1, "taxes": [], "automaticTaxCategoryId": "6578278e879ad2646715ba9c", "type": "one_time", "taxInclusive": true } ], "discount": { "value": 10, "type": "percentage", "validOnProductIds": "[ '6579751d56f60276e5bd4154' ]" }, "title": "New Template", "miscellaneousCharges": { "charges": [ [] ], "collectedMiscellaneousCharges": 10, "paidCharges": [ { "name": "Processing Fee", "charge": 10, "amount": 10, "_id": "673d01d7d547648a8dab6211" } ] } }' ``` **Node.js** ```javascript const options = { method: 'PUT', headers: { Authorization: 'Bearer ', Version: 'v3', 'Content-Type': 'application/json' }, body: JSON.stringify({ "altId": "6578278e879ad2646715ba9c", "altType": "location", "name": "New Template", "businessDetails": { "logoUrl": "https://example.com/logo.png", "name": "ABC Corp.", "phoneNo": "+1-214-559-6993", "address": "9931 Beechwood, TX", "website": "wwww.example.com", "customValues": [] }, "items": [ { "name": "ABC Product", "description": "ABC Corp.", "productId": "6578278e879ad2646715ba9c", "priceId": "6578278e879ad2646715ba9c", "currency": "USD", "amount": 999, "qty": 1, "taxes": [], "automaticTaxCategoryId": "6578278e879ad2646715ba9c", "type": "one_time", "taxInclusive": true } ], "discount": { "value": 10, "type": "percentage", "validOnProductIds": "[ '6579751d56f60276e5bd4154' ]" }, "title": "New Template", "miscellaneousCharges": { "charges": [ [] ], "collectedMiscellaneousCharges": 10, "paidCharges": [ { "name": "Processing Fee", "charge": 10, "amount": 10, "_id": "673d01d7d547648a8dab6211" } ] } }) }; try { const response = await fetch('https://services.leadconnectorhq.com/invoices/template/', options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` **Python** ```python import requests url = "https://services.leadconnectorhq.com/invoices/template/{templateId}" headers = { "Authorization": "Bearer ", "Version": "v3" } payload = { "altId": "6578278e879ad2646715ba9c", "altType": "location", "name": "New Template", "businessDetails": { "logoUrl": "https://example.com/logo.png", "name": "ABC Corp.", "phoneNo": "+1-214-559-6993", "address": "9931 Beechwood, TX", "website": "wwww.example.com", "customValues": [] }, "items": [ { "name": "ABC Product", "description": "ABC Corp.", "productId": "6578278e879ad2646715ba9c", "priceId": "6578278e879ad2646715ba9c", "currency": "USD", "amount": 999, "qty": 1, "taxes": [], "automaticTaxCategoryId": "6578278e879ad2646715ba9c", "type": "one_time", "taxInclusive": true } ], "discount": { "value": 10, "type": "percentage", "validOnProductIds": "[ '6579751d56f60276e5bd4154' ]" }, "title": "New Template", "miscellaneousCharges": { "charges": [ [] ], "collectedMiscellaneousCharges": 10, "paidCharges": [ { "name": "Processing Fee", "charge": 10, "amount": 10, "_id": "673d01d7d547648a8dab6211" } ] } } response = requests.put(url, json=payload, headers=headers) print(response.json()) ``` **PHP** ```php 'https://services.leadconnectorhq.com/invoices/template/', CURLOPT_RETURNTRANSFER => true, CURLOPT_CUSTOMREQUEST => 'PUT', CURLOPT_HTTPHEADER => [ 'Authorization: Bearer ', 'Version: v3', 'Content-Type: application/json', ], CURLOPT_POSTFIELDS => '{ "altId": "6578278e879ad2646715ba9c", "altType": "location", "name": "New Template", "businessDetails": { "logoUrl": "https://example.com/logo.png", "name": "ABC Corp.", "phoneNo": "+1-214-559-6993", "address": "9931 Beechwood, TX", "website": "wwww.example.com", "customValues": [] }, "items": [ { "name": "ABC Product", "description": "ABC Corp.", "productId": "6578278e879ad2646715ba9c", "priceId": "6578278e879ad2646715ba9c", "currency": "USD", "amount": 999, "qty": 1, "taxes": [], "automaticTaxCategoryId": "6578278e879ad2646715ba9c", "type": "one_time", "taxInclusive": true } ], "discount": { "value": 10, "type": "percentage", "validOnProductIds": "[ '6579751d56f60276e5bd4154' ]" }, "title": "New Template", "miscellaneousCharges": { "charges": [ [] ], "collectedMiscellaneousCharges": 10, "paidCharges": [ { "name": "Processing Fee", "charge": 10, "amount": 10, "_id": "673d01d7d547648a8dab6211" } ] } }', ]); $response = curl_exec($curl); curl_close($curl); echo $response; ``` **Java** ```java HttpResponse response = Unirest .put("https://services.leadconnectorhq.com/invoices/template/") .header("Authorization", "Bearer ") .header("Version", "v3") .header("Content-Type", "application/json") .body("{\"altId\":\"6578278e879ad2646715ba9c\",\"altType\":\"location\",\"name\":\"New Template\",\"businessDetails\":{\"logoUrl\":\"https://example.com/logo.png\",\"name\":\"ABC Corp.\",\"phoneNo\":\"+1-214-559-6993\",\"address\":\"9931 Beechwood, TX\",\"website\":\"wwww.example.com\",\"customValues\":[]},\"items\":[{\"name\":\"ABC Product\",\"description\":\"ABC Corp.\",\"productId\":\"6578278e879ad2646715ba9c\",\"priceId\":\"6578278e879ad2646715ba9c\",\"currency\":\"USD\",\"amount\":999,\"qty\":1,\"taxes\":[],\"automaticTaxCategoryId\":\"6578278e879ad2646715ba9c\",\"type\":\"one_time\",\"taxInclusive\":true}],\"discount\":{\"value\":10,\"type\":\"percentage\",\"validOnProductIds\":\"[ '6579751d56f60276e5bd4154' ]\"},\"title\":\"New Template\",\"miscellaneousCharges\":{\"charges\":[[]],\"collectedMiscellaneousCharges\":10,\"paidCharges\":[{\"name\":\"Processing Fee\",\"charge\":10,\"amount\":10,\"_id\":\"673d01d7d547648a8dab6211\"}]}}") .asString(); ``` **Go** ```go package main import ( "fmt" "net/http" "io" "strings" ) func main() { url := "https://services.leadconnectorhq.com/invoices/template/" payload := strings.NewReader(`{ "altId": "6578278e879ad2646715ba9c", "altType": "location", "name": "New Template", "businessDetails": { "logoUrl": "https://example.com/logo.png", "name": "ABC Corp.", "phoneNo": "+1-214-559-6993", "address": "9931 Beechwood, TX", "website": "wwww.example.com", "customValues": [] }, "items": [ { "name": "ABC Product", "description": "ABC Corp.", "productId": "6578278e879ad2646715ba9c", "priceId": "6578278e879ad2646715ba9c", "currency": "USD", "amount": 999, "qty": 1, "taxes": [], "automaticTaxCategoryId": "6578278e879ad2646715ba9c", "type": "one_time", "taxInclusive": true } ], "discount": { "value": 10, "type": "percentage", "validOnProductIds": "[ '6579751d56f60276e5bd4154' ]" }, "title": "New Template", "miscellaneousCharges": { "charges": [ [] ], "collectedMiscellaneousCharges": 10, "paidCharges": [ { "name": "Processing Fee", "charge": 10, "amount": 10, "_id": "673d01d7d547648a8dab6211" } ] } }`) req, _ := http.NewRequest("PUT", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Version", "v3") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(string(body)) } ``` **Ruby** ```ruby require 'uri' require 'net/http' url = URI("https://services.leadconnectorhq.com/invoices/template/") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Put.new(url) request["Authorization"] = "Bearer " request["Version"] = "v3" request["Content-Type"] = "application/json" request.body = '{ "altId": "6578278e879ad2646715ba9c", "altType": "location", "name": "New Template", "businessDetails": { "logoUrl": "https://example.com/logo.png", "name": "ABC Corp.", "phoneNo": "+1-214-559-6993", "address": "9931 Beechwood, TX", "website": "wwww.example.com", "customValues": [] }, "items": [ { "name": "ABC Product", "description": "ABC Corp.", "productId": "6578278e879ad2646715ba9c", "priceId": "6578278e879ad2646715ba9c", "currency": "USD", "amount": 999, "qty": 1, "taxes": [], "automaticTaxCategoryId": "6578278e879ad2646715ba9c", "type": "one_time", "taxInclusive": true } ], "discount": { "value": 10, "type": "percentage", "validOnProductIds": "[ '6579751d56f60276e5bd4154' ]" }, "title": "New Template", "miscellaneousCharges": { "charges": [ [] ], "collectedMiscellaneousCharges": 10, "paidCharges": [ { "name": "Processing Fee", "charge": 10, "amount": 10, "_id": "673d01d7d547648a8dab6211" } ] } }' response = http.request(request) puts response.read_body ``` **PowerShell** ```powershell $headers = @{ "Authorization" = "Bearer " "Version" = "v3" } $body = '{ "altId": "6578278e879ad2646715ba9c", "altType": "location", "name": "New Template", "businessDetails": { "logoUrl": "https://example.com/logo.png", "name": "ABC Corp.", "phoneNo": "+1-214-559-6993", "address": "9931 Beechwood, TX", "website": "wwww.example.com", "customValues": [] }, "items": [ { "name": "ABC Product", "description": "ABC Corp.", "productId": "6578278e879ad2646715ba9c", "priceId": "6578278e879ad2646715ba9c", "currency": "USD", "amount": 999, "qty": 1, "taxes": [], "automaticTaxCategoryId": "6578278e879ad2646715ba9c", "type": "one_time", "taxInclusive": true } ], "discount": { "value": 10, "type": "percentage", "validOnProductIds": "[ '6579751d56f60276e5bd4154' ]" }, "title": "New Template", "miscellaneousCharges": { "charges": [ [] ], "collectedMiscellaneousCharges": 10, "paidCharges": [ { "name": "Processing Fee", "charge": 10, "amount": 10, "_id": "673d01d7d547648a8dab6211" } ] } }' $response = Invoke-RestMethod -Uri 'https://services.leadconnectorhq.com/invoices/template/' -Method 'PUT' -Headers $headers -Body $body -ContentType 'application/json' $response | ConvertTo-Json ```