# Update schedule

- **URL:** https://marketplace.gohighlevel.com/docs/ghl/invoices/update-invoice-schedule
- **Summary:** API to update an schedule by schedule id

[Skip to main content](https://marketplace.gohighlevel.com/docs/ghl/invoices/update-invoice-schedule#__docusaurus_skipToContent_fallback)

Version: v3

Update schedule
===============

PUT 

https://services.leadconnectorhq.com/invoices/schedule/:scheduleId

Copy for LLMView as MarkdownOpen in ClaudeOpen in ChatGPTOpen in Cursor

API to update an schedule by schedule id

### Requirements

#### Scope(s)

`invoices/schedule.write`

#### Auth Method(s)

`OAuth Access Token``Private Integration Token`

#### Token Type(s)

`Sub-Account Token``Agency Token`

Request[​](https://marketplace.gohighlevel.com/docs/ghl/invoices/update-invoice-schedule#request "Direct link to request")

### Header Parameters

**Version** stringrequired

**Possible values:** \[`v3`\]

API Version

### Path Parameters

**scheduleId** stringrequired

Schedule Id

**Example:** `6578278e879ad2646715ba9c`

*   application/json

*   Body
*   Example (auto)

### Body**required**

**altId**stringrequired

location Id / company Id based on altType

**Example:** `6578278e879ad2646715ba9c`

**altType**stringrequired

Alt Type

**Possible values:** \[`location`\]

**Example:** `location`

**name**stringrequired

**contactDetails** objectrequired

**id**stringrequired

Contact ID

**Example:** `6578278e879ad2646715ba9c`

**name**stringrequired

Contact Name

**Example:** `Alex`

**phoneNo**stringrequired

Contact Phone Number

**Example:** `+1234567890`

**email**stringrequired

Contact Email

**Example:** `alex@example.com`

**additionalEmails** object\[\]

Secondary email addresses for the contact to be saved

*   Array \[\
    \
\
**email**stringrequired\
\
**Example:** `alex@example.com`\
\
*   \]
    

**companyName**string

Contact Company Name

**Example:** `ABC Corp.`

**address** object

**addressLine1**string

Address Line 1

**Example:** `9931 Beechwood`

**addressLine2**string

Address Line 2

**Example:** `Beechwood`

**city**string

City

**Example:** `St. Houston`

**state**string

State

**Example:** `TX`

**countryCode**string

Country Code

**Example:** `US`

**postalCode**string

Postal Code

**Example:** `559-6993`

**customFields**string\[\]

Custom Values

**schedule** objectrequired

**executeAt**string

**rrule** object

**intervalType**stringrequired

**Possible values:** \[`yearly`, `monthly`, `weekly`, `daily`, `hourly`, `minutely`, `secondly`\]

**Example:** `monthly`

**interval**numberrequired

**Example:** `2`

**startDate**stringrequired

Start date in YYYY-MM-DD format

**Example:** `2023-01-01`

**startTime**string

Start time in HH:mm:ss format

**Example:** `20:45:00`

**endDate**string

End date in YYYY-MM-DD format

**Example:** `2029-11-01`

**endTime**string

End time in HH:mm:ss format

**Example:** `18:45:00`

**dayOfMonth**number

\-1, 1, 2, 3, ..., 27, 28

**Example:** `15`

**dayOfWeek**string

**Possible values:** \[`mo`, `tu`, `we`, `th`, `fr`, `sa`, `su`\]

**Example:** `mo`

**numOfWeek**number

\-1, 1, 2, 3, 4

**Example:** `-1`

**monthOfYear**string

**Possible values:** \[`jan`, `feb`, `mar`, `apr`, `may`, `jun`, `jul`, `aug`, `sep`, `oct`, `nov`, `dec`\]

**Example:** `jan`

**count**number

Max number of task executions

**Example:** `10`

**daysBefore**number

Execute task number of days before

**Example:** `5`

**useStartAsPrimaryUserAccepted**boolean

Start as primary user accepted date

**Example:** `true`

**endType**string

End type like after, by, count

**Example:** `by`

**liveMode**booleanrequired

**businessDetails** objectrequired

**logoUrl**string

Business Logo URL

**Example:** `https://example.com/logo.png`

**name**string

Business Name

**Example:** `ABC Corp.`

**phoneNo**string

Business Phone Number

**Example:** `+1-214-559-6993`

**address** object

Business Address

**addressLine1**string

Address Line 1

**Example:** `9931 Beechwood`

**addressLine2**string

Address Line 2

**Example:** `Beechwood`

**city**string

City

**Example:** `St. Houston`

**state**string

State

**Example:** `TX`

**countryCode**string

Country Code

**Example:** `US`

**postalCode**string

Postal Code

**Example:** `559-6993`

**website**string

Business Website Link

**Example:** `wwww.example.com`

**customValues**string\[\]

Custom Values

**currency**stringrequired

**items** object\[\]required

*   Array \[\
    \
\
**name**stringrequired\
\
Invoice Item Name\
\
**Example:** `ABC Product`\
\
**description**string\
\
Invoice descriptions\
\
**Example:** `ABC Corp.`\
\
**productId**string\
\
Product Id\
\
**Example:** `6578278e879ad2646715ba9c`\
\
**priceId**string\
\
Price Id\
\
**Example:** `6578278e879ad2646715ba9c`\
\
**currency**stringrequired\
\
Currency\
\
**Example:** `USD`\
\
**amount**numberrequired\
\
Product amount\
\
**Example:** `999`\
\
**qty**numberrequired\
\
Product Quantity\
\
**Example:** `1`\
\
**taxes** object\[\]\
\
Tax\
\
*   Array \[\
    \
\
**_id**stringrequired\
\
**name**stringrequired\
\
**rate**numberrequired\
\
**calculation**string\
\
**Possible values:** \[`exclusive`\]\
\
**description**string\
\
**taxId**string\
\
*   \]\
    \
\
**automaticTaxCategoryId**string\
\
Tax category id for calculating automatic tax\
\
**Example:** `6578278e879ad2646715ba9c`\
\
**isSetupFeeItem**boolean\
\
Setupfee item, only created when 1st invoice of recurring schedule is generated\
\
**type**string\
\
Price type of the item\
\
**Possible values:** \[`one_time`, `recurring`\]\
\
**Example:** `one_time`\
\
**taxInclusive**boolean\
\
true if item amount is tax inclusive\
\
**Default value:** `false`\
\
**Example:** `true`\
\
*   \]
    

**discount** objectrequired

**value**number

Discount Value

**Default value:** `0`

**Example:** `10`

**type**stringrequired

Discount type

**Possible values:** \[`percentage`, `fixed`\]

**Default value:** `percentage`

**Example:** `percentage`

**validOnProductIds**string\[\]

Product Ids on which discount is applicable

**Example:** `[ '6579751d56f60276e5bd4154' ]`

**termsNotes**string

**title**string

**attachments** object\[\]

attachments for the invoice

*   Array \[\
    \
\
**id**stringrequired\
\
Id of the file selected\
\
**Example:** `6241712be68f7a98102ba272`\
\
**name**stringrequired\
\
Name of the file\
\
**Example:** `Electronics.pdf`\
\
**url**stringrequired\
\
URL of the file\
\
**Example:** `https://example.com/digital-delivery`\
\
**type**stringrequired\
\
Type of the file\
\
**size**numberrequired\
\
Size of the file\
\
**Example:** `10000`\
\
*   \]
    

**miscellaneousCharges** object

miscellaneous charges for the invoice

**charges**array\[\]required

charges for the processing fee

**collectedMiscellaneousCharges**number

collected miscellaneous charges

**Example:** `10`

**paidCharges** object\[\]

paid miscellaneous charges

*   Array \[\
    \
\
**name**stringrequired\
\
name of the processing fee\
\
**Example:** `Processing Fee`\
\
**charge**numberrequired\
\
charge for the processing fee\
\
**Example:** `10`\
\
**amount**numberrequired\
\
amount of the processing fee\
\
**Example:** `10`\
\
**_id**stringrequired\
\
id of the processing fee\
\
**Example:** `673d01d7d547648a8dab6211`\
\
*   \]
    

    {  "altId": "6578278e879ad2646715ba9c",  "altType": "location",  "name": "string",  "contactDetails": {    "id": "6578278e879ad2646715ba9c",    "name": "Alex",    "phoneNo": "+1234567890",    "email": "alex@example.com",    "additionalEmails": [      {        "email": "alex@example.com"      }    ],    "companyName": "ABC Corp.",    "address": {      "addressLine1": "9931 Beechwood",      "addressLine2": "Beechwood",      "city": "St. Houston",      "state": "TX",      "countryCode": "US",      "postalCode": "559-6993"    },    "customFields": [      "string"    ]  },  "schedule": {    "executeAt": "string",    "rrule": {      "intervalType": "monthly",      "interval": 2,      "startDate": "2023-01-01",      "startTime": "20:45:00",      "endDate": "2029-11-01",      "endTime": "18:45:00",      "dayOfMonth": 15,      "dayOfWeek": "mo",      "numOfWeek": -1,      "monthOfYear": "jan",      "count": 10,      "daysBefore": 5,      "useStartAsPrimaryUserAccepted": true,      "endType": "by"    }  },  "liveMode": true,  "businessDetails": {    "logoUrl": "https://example.com/logo.png",    "name": "ABC Corp.",    "phoneNo": "+1-214-559-6993",    "address": "9931 Beechwood, TX",    "website": "wwww.example.com",    "customValues": [      "string"    ]  },  "currency": "string",  "items": [    {      "name": "ABC Product",      "description": "ABC Corp.",      "productId": "6578278e879ad2646715ba9c",      "priceId": "6578278e879ad2646715ba9c",      "currency": "USD",      "amount": 999,      "qty": 1,      "taxes": [        {          "_id": "string",          "name": "string",          "rate": 0,          "calculation": "exclusive",          "description": "string",          "taxId": "string"        }      ],      "automaticTaxCategoryId": "6578278e879ad2646715ba9c",      "isSetupFeeItem": true,      "type": "one_time",      "taxInclusive": true    }  ],  "discount": {    "value": 10,    "type": "percentage",    "validOnProductIds": "[ '6579751d56f60276e5bd4154' ]"  },  "termsNotes": "string",  "title": "string",  "attachments": [    {      "id": "6241712be68f7a98102ba272",      "name": "Electronics.pdf",      "url": "https://example.com/digital-delivery",      "type": "string",      "size": 10000    }  ],  "miscellaneousCharges": {    "charges": [      null    ],    "collectedMiscellaneousCharges": 10,    "paidCharges": [      {        "name": "Processing Fee",        "charge": 10,        "amount": 10,        "_id": "673d01d7d547648a8dab6211"      }    ]  }}

Responses[​](https://marketplace.gohighlevel.com/docs/ghl/invoices/update-invoice-schedule#responses "Direct link to Responses")

*   200
*   400
*   401
*   422

Successful response

*   application/json

*   Schema
*   Example (auto)

**Schema**

**_id**stringrequired

Schedule Id

**Example:** `6578278e879ad2646715ba9c`

**status**objectrequired

Schedule Status

**Example:** `draft`

**liveMode**booleanrequired

Live Mode

**Example:** `false`

**altId**stringrequired

Location Id or Agency Id

**Example:** `6578278e879ad2646715ba9c`

**altType**stringrequired

**Possible values:** \[`location`\]

**name**stringrequired

Name of the invoice

**Example:** `New Invoice`

**schedule** object

**executeAt**string

**rrule** object

**intervalType**stringrequired

**Possible values:** \[`yearly`, `monthly`, `weekly`, `daily`, `hourly`, `minutely`, `secondly`\]

**Example:** `monthly`

**interval**numberrequired

**Example:** `2`

**startDate**stringrequired

Start date in YYYY-MM-DD format

**Example:** `2023-01-01`

**startTime**string

Start time in HH:mm:ss format

**Example:** `20:45:00`

**endDate**string

End date in YYYY-MM-DD format

**Example:** `2029-11-01`

**endTime**string

End time in HH:mm:ss format

**Example:** `18:45:00`

**dayOfMonth**number

\-1, 1, 2, 3, ..., 27, 28

**Example:** `15`

**dayOfWeek**string

**Possible values:** \[`mo`, `tu`, `we`, `th`, `fr`, `sa`, `su`\]

**Example:** `mo`

**numOfWeek**number

\-1, 1, 2, 3, 4

**Example:** `-1`

**monthOfYear**string

**Possible values:** \[`jan`, `feb`, `mar`, `apr`, `may`, `jun`, `jul`, `aug`, `sep`, `oct`, `nov`, `dec`\]

**Example:** `jan`

**count**number

Max number of task executions

**Example:** `10`

**daysBefore**number

Execute task number of days before

**Example:** `5`

**useStartAsPrimaryUserAccepted**boolean

Start as primary user accepted date

**Example:** `true`

**endType**string

End type like after, by, count

**Example:** `by`

**invoices** object\[\]required

List of invoices

*   Array \[\
    \
\
**_id**stringrequired\
\
Invoice Id\
\
**Example:** `6578278e879ad2646715ba9c`\
\
**status**stringrequired\
\
Invoice Status\
\
**Possible values:** \[`draft`, `sent`, `payment_processing`, `paid`, `void`, `partially_paid`\]\
\
**Example:** `draft`\
\
**liveMode**booleanrequired\
\
Live Mode\
\
**Example:** `false`\
\
**amountPaid**numberrequired\
\
Amount Paid\
\
**Example:** `0`\
\
**altId**stringrequired\
\
Location Id or Agency Id\
\
**Example:** `6578278e879ad2646715ba9c`\
\
**altType**stringrequired\
\
**Possible values:** \[`location`\]\
\
**name**stringrequired\
\
Name of the invoice\
\
**Example:** `New Invoice`\
\
**businessDetails**objectrequired\
\
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"}`\
\
**invoiceNumber**numberrequired\
\
Invoice Number\
\
**Example:** `19`\
\
**currency**stringrequired\
\
Currency\
\
**Example:** `USD`\
\
**contactDetails**objectrequired\
\
Contact Details\
\
**Example:** `{"id":"c6tZZU0rJBf30ZXx9Gli","phoneNo":"+1-214-559-6993","email":"alex@example.com","customFields":[],"name":"Alex","address":{"countryCode":"US"}}`\
\
**issueDate**stringrequired\
\
Issue date in YYYY-MM-DD format\
\
**Example:** `2023-01-01`\
\
**dueDate**stringrequired\
\
Due date in YYYY-MM-DD format\
\
**Example:** `2023-01-01`\
\
**discount**object\
\
Discount\
\
**Example:** `{"type":"percentage","value":0}`\
\
**invoiceItems**string\[\]required\
\
Invoice Items\
\
**Example:** `[{"taxes":[],"_id":"c6tZZU0rJBf30ZXx9Gli","productId":"c6tZZU0rJBf30ZXx9Gli","priceId":"c6tZZU0rJBf30ZXx9Gli","currency":"USD","name":"Macbook Pro","qty":1,"amount":999}]`\
\
**total**numberrequired\
\
Total Amount\
\
**Example:** `999`\
\
**title**stringrequired\
\
Title\
\
**Example:** `INVOICE`\
\
**amountDue**numberrequired\
\
Total Amount Due\
\
**Example:** `999`\
\
**createdAt**stringrequired\
\
created at\
\
**Example:** `2023-12-12T09:27:42.355Z`\
\
**updatedAt**stringrequired\
\
updated at\
\
**Example:** `2023-12-12T09:27:42.355Z`\
\
**automaticTaxesEnabled**boolean\
\
Automatic taxes enabled for the Invoice\
\
**Example:** `true`\
\
**automaticTaxesCalculated**boolean\
\
Is Automatic taxes calculated for the Invoice items\
\
**Example:** `true`\
\
**paymentSchedule**object\
\
split invoice into payment schedule summing up to full invoice amount\
\
*   \]
    

**businessDetails** objectrequired

Business Details

**logoUrl**string

Business Logo URL

**Example:** `https://example.com/logo.png`

**name**string

Business Name

**Example:** `ABC Corp.`

**phoneNo**string

Business Phone Number

**Example:** `+1-214-559-6993`

**address** object

Business Address

**addressLine1**string

Address Line 1

**Example:** `9931 Beechwood`

**addressLine2**string

Address Line 2

**Example:** `Beechwood`

**city**string

City

**Example:** `St. Houston`

**state**string

State

**Example:** `TX`

**countryCode**string

Country Code

**Example:** `US`

**postalCode**string

Postal Code

**Example:** `559-6993`

**website**string

Business Website Link

**Example:** `wwww.example.com`

**customValues**string\[\]

Custom Values

**currency**stringrequired

Currency

**Example:** `USD`

**contactDetails** objectrequired

Contact Details

**id**stringrequired

Contact ID

**Example:** `6578278e879ad2646715ba9c`

**name**stringrequired

Contact Name

**Example:** `Alex`

**phoneNo**stringrequired

Contact Phone Number

**Example:** `+1234567890`

**email**stringrequired

Contact Email

**Example:** `alex@example.com`

**additionalEmails** object\[\]

Secondary email addresses for the contact to be saved

*   Array \[\
    \
\
**email**stringrequired\
\
**Example:** `alex@example.com`\
\
*   \]
    

**companyName**string

Contact Company Name

**Example:** `ABC Corp.`

**address** object

**addressLine1**string

Address Line 1

**Example:** `9931 Beechwood`

**addressLine2**string

Address Line 2

**Example:** `Beechwood`

**city**string

City

**Example:** `St. Houston`

**state**string

State

**Example:** `TX`

**countryCode**string

Country Code

**Example:** `US`

**postalCode**string

Postal Code

**Example:** `559-6993`

**customFields**string\[\]

Custom Values

**discount** object

Discount

**value**number

Discount Value

**Default value:** `0`

**Example:** `10`

**type**stringrequired

Discount type

**Possible values:** \[`percentage`, `fixed`\]

**Default value:** `percentage`

**Example:** `percentage`

**validOnProductIds**string\[\]

Product Ids on which discount is applicable

**Example:** `[ '6579751d56f60276e5bd4154' ]`

**items**string\[\]required

Invoice Items

**Example:** `[{"taxes":[],"_id":"c6tZZU0rJBf30ZXx9Gli","productId":"c6tZZU0rJBf30ZXx9Gli","priceId":"c6tZZU0rJBf30ZXx9Gli","currency":"USD","name":"Macbook Pro","qty":1,"amount":999}]`

**total**numberrequired

Total Amount

**Example:** `999`

**title**stringrequired

Title

**Example:** `INVOICE`

**termsNotes**stringrequired

Terms notes

**Example:** `Confidential`

**compiledTermsNotes**stringrequired

Compiled terms notes

**Example:** `Confidential`

**createdAt**stringrequired

created at

**Example:** `2023-12-12T09:27:42.355Z`

**updatedAt**stringrequired

updated at

**Example:** `2023-12-12T09:27:42.355Z`

    {  "_id": "6578278e879ad2646715ba9c",  "status": "draft",  "liveMode": false,  "altId": "6578278e879ad2646715ba9c",  "altType": "location",  "name": "New Invoice",  "schedule": {    "executeAt": "string",    "rrule": {      "intervalType": "monthly",      "interval": 2,      "startDate": "2023-01-01",      "startTime": "20:45:00",      "endDate": "2029-11-01",      "endTime": "18:45:00",      "dayOfMonth": 15,      "dayOfWeek": "mo",      "numOfWeek": -1,      "monthOfYear": "jan",      "count": 10,      "daysBefore": 5,      "useStartAsPrimaryUserAccepted": true,      "endType": "by"    }  },  "invoices": [    {      "_id": "6578278e879ad2646715ba9c",      "status": "draft",      "liveMode": false,      "amountPaid": 0,      "altId": "6578278e879ad2646715ba9c",      "altType": "location",      "name": "New Invoice",      "businessDetails": {        "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"      },      "invoiceNumber": "19",      "currency": "USD",      "contactDetails": {        "id": "c6tZZU0rJBf30ZXx9Gli",        "phoneNo": "+1-214-559-6993",        "email": "alex@example.com",        "customFields": [],        "name": "Alex",        "address": {          "countryCode": "US"        }      },      "issueDate": "2023-01-01",      "dueDate": "2023-01-01",      "discount": {        "type": "percentage",        "value": 0      },      "invoiceItems": [        {          "taxes": [],          "_id": "c6tZZU0rJBf30ZXx9Gli",          "productId": "c6tZZU0rJBf30ZXx9Gli",          "priceId": "c6tZZU0rJBf30ZXx9Gli",          "currency": "USD",          "name": "Macbook Pro",          "qty": 1,          "amount": 999        }      ],      "total": 999,      "title": "INVOICE",      "amountDue": 999,      "createdAt": "2023-12-12T09:27:42.355Z",      "updatedAt": "2023-12-12T09:27:42.355Z",      "automaticTaxesEnabled": true,      "automaticTaxesCalculated": true,      "paymentSchedule": {}    }  ],  "businessDetails": {    "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"  },  "currency": "USD",  "contactDetails": {    "id": "c6tZZU0rJBf30ZXx9Gli",    "phoneNo": "+1-214-559-6993",    "email": "alex@example.com",    "customFields": [],    "name": "Alex",    "address": {      "countryCode": "US"    }  },  "discount": {    "type": "percentage",    "value": 0  },  "items": [    {      "taxes": [],      "_id": "c6tZZU0rJBf30ZXx9Gli",      "productId": "c6tZZU0rJBf30ZXx9Gli",      "priceId": "c6tZZU0rJBf30ZXx9Gli",      "currency": "USD",      "name": "Macbook Pro",      "qty": 1,      "amount": 999    }  ],  "total": 999,  "title": "INVOICE",  "termsNotes": "Confidential",  "compiledTermsNotes": "Confidential",  "createdAt": "2023-12-12T09:27:42.355Z",  "updatedAt": "2023-12-12T09:27:42.355Z"}
> Common reference appendix (shared error/status catalog): see [../_shared-appendix.md](../_shared-appendix.md).
**name:** [Authorization](https://marketplace.gohighlevel.com/docs/ghl/invoices/invoice-api#authentication)
**type:** http**scopes:** `invoices/schedule.write`**scheme:** bearer**bearerFormat:** JWT**in:** header**description:** Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.

*   curl
*   nodejs
*   python
*   php
*   java
*   go
*   ruby
*   powershell

*   CURL

    curl -L -X PUT 'https://services.leadconnectorhq.com/invoices/schedule/6578278e879ad2646715ba9c' \-H 'Content-Type: application/json' \-H 'Accept: application/json' \-H 'Authorization: Bearer <Authorization>' \--data-raw '{  "altId": "6578278e879ad2646715ba9c",  "altType": "location",  "name": "string",  "contactDetails": {    "id": "6578278e879ad2646715ba9c",    "name": "Alex",    "phoneNo": "+1234567890",    "email": "alex@example.com",    "additionalEmails": [      {        "email": "alex@example.com"      }    ],    "companyName": "ABC Corp.",    "address": {      "addressLine1": "9931 Beechwood",      "addressLine2": "Beechwood",      "city": "St. Houston",      "state": "TX",      "countryCode": "US",      "postalCode": "559-6993"    },    "customFields": [      "string"    ]  },  "schedule": {    "executeAt": "string",    "rrule": {      "intervalType": "monthly",      "interval": 2,      "startDate": "2023-01-01",      "startTime": "20:45:00",      "endDate": "2029-11-01",      "endTime": "18:45:00",      "dayOfMonth": 15,      "dayOfWeek": "mo",      "numOfWeek": -1,      "monthOfYear": "jan",      "count": 10,      "daysBefore": 5,      "useStartAsPrimaryUserAccepted": true,      "endType": "by"    }  },  "liveMode": true,  "businessDetails": {    "logoUrl": "https://example.com/logo.png",    "name": "ABC Corp.",    "phoneNo": "+1-214-559-6993",    "address": {      "addressLine1": "9931 Beechwood",      "addressLine2": "Beechwood",      "city": "St. Houston",      "state": "TX",      "countryCode": "US",      "postalCode": "559-6993"    },    "website": "wwww.example.com",    "customValues": [      "string"    ]  },  "currency": "string",  "items": [    {      "name": "ABC Product",      "description": "ABC Corp.",      "productId": "6578278e879ad2646715ba9c",      "priceId": "6578278e879ad2646715ba9c",      "currency": "USD",      "amount": 999,      "qty": 1,      "taxes": [        {          "_id": "string",          "name": "string",          "rate": 0,          "calculation": "exclusive",          "description": "string",          "taxId": "string"        }      ],      "automaticTaxCategoryId": "6578278e879ad2646715ba9c",      "isSetupFeeItem": true,      "type": "one_time",      "taxInclusive": true    }  ],  "discount": {    "value": 10,    "type": "percentage",    "validOnProductIds": "[ '\''6579751d56f60276e5bd4154'\'' ]"  },  "termsNotes": "string",  "title": "string",  "attachments": [    {      "id": "6241712be68f7a98102ba272",      "name": "Electronics.pdf",      "url": "https://example.com/digital-delivery",      "type": "string",      "size": 10000    }  ],  "miscellaneousCharges": {    "charges": [      null    ],    "collectedMiscellaneousCharges": 10,    "paidCharges": [      {        "name": "Processing Fee",        "charge": 10,        "amount": 10,        "_id": "673d01d7d547648a8dab6211"      }    ]  }}'

RequestCollapse all

Base URL

Edit

https://services.leadconnectorhq.com

Auth

Security SchemeLocation-AccessAgency-Access

Bearer Token

Parameters

scheduleId — pathrequired

Version — headerrequired\---v3

Body required

{
  "altId": "6578278e879ad2646715ba9c",  "altType": "location",  "name": "string",  "contactDetails": {    "id": "6578278e879ad2646715ba9c",    "name": "Alex",    "phoneNo": "+1234567890",    "email": "alex@example.com",    "additionalEmails": \[      {        "email": "alex@example.com"      }    \],    "companyName": "ABC Corp.",    "address": {      "addressLine1": "9931 Beechwood",      "addressLine2": "Beechwood",      "city": "St. Houston",      "state": "TX",      "countryCode": "US",      "postalCode": "559-6993"    },    "customFields": \[      "string"    \]  },  "schedule": {    "executeAt": "string",    "rrule": {      "intervalType": "monthly",      "interval": 2,      "startDate": "2023-01-01",      "startTime": "20:45:00",      "endDate": "2029-11-01",      "endTime": "18:45:00",      "dayOfMonth": 15,      "dayOfWeek": "mo",      "numOfWeek": \-1,      "monthOfYear": "jan",      "count": 10,      "daysBefore": 5,      "useStartAsPrimaryUserAccepted": true,      "endType": "by"    }  },  "liveMode": true,  "businessDetails": {    "logoUrl": "https://example.com/logo.png",    "name": "ABC Corp.",    "phoneNo": "+1-214-559-6993",    "address": {      "addressLine1": "9931 Beechwood",      "addressLine2": "Beechwood",      "city": "St. Houston",      "state": "TX",      "countryCode": "US",      "postalCode": "559-6993"    },    "website": "wwww.example.com",    "customValues": \[      "string"    \]  },  "currency": "string",  "items": \[    {      "name": "ABC Product",      "description": "ABC Corp.",      "productId": "6578278e879ad2646715ba9c",      "priceId": "6578278e879ad2646715ba9c",      "currency": "USD",      "amount": 999,      "qty": 1,      "taxes": \[        {          "_id": "string",          "name": "string",          "rate": 0,          "calculation": "exclusive",          "description": "string",          "taxId": "string"        }      \],      "automaticTaxCategoryId": "6578278e879ad2646715ba9c",      "isSetupFeeItem": true,      "type": "one_time",      "taxInclusive": true    }  \],  "discount": {    "value": 10,    "type": "percentage",    "validOnProductIds": "\[ '6579751d56f60276e5bd4154' \]"  },  "termsNotes": "string",  "title": "string",  "attachments": \[    {      "id": "6241712be68f7a98102ba272",      "name": "Electronics.pdf",      "url": "https://example.com/digital-delivery",      "type": "string",      "size": 10000    }  \],  "miscellaneousCharges": {    "charges": \[      null    \],    "collectedMiscellaneousCharges": 10,    "paidCharges": \[      {        "name": "Processing Fee",        "charge": 10,        "amount": 10,        "_id": "673d01d7d547648a8dab6211"      }    \]  }
}
Send API Request

ResponseClear

Click the `Send API Request` button above and see the response here!
