ConnectWise Manage
ConnectWise Manage is a professional services automation platform that centralizes service delivery, ticketing, billing, and client management for technology service providers.
ConnectWise Manage is a leading professional services automation (PSA) platform designed for IT service providers to streamline business operations, including ticketing, company and contact management, service boards, SLAs, and invoicing. This connector enables Swimlane Turbine users to automate the creation, retrieval, updating, and deletion of records in ConnectWise Manageβsuch as companies, contacts, tickets, service boards, SLAs, and invoicesβdirectly from low-code playbooks. By integrating ConnectWise Manage with Swimlane Turbine, organizations can synchronize business and security operations, accelerate incident response, and ensure data consistency across systems without manual intervention. This seamless automation reduces operational overhead, improves service delivery, and empowers teams to focus on higher-value tasks.
Prerequisites
To use the ConnectWise Manage connector, ensure you have the following prerequisites configured:
- Custom authentication for ConnectWise Manage, requiring:
- API Version: The version of the ConnectWise Manage API you intend to use.
- Client ID: A unique identifier for your application, provided by ConnectWise.
- Company Identifier: The short code or name representing your ConnectWise Manage company instance.
- Host: The base URL or domain where your ConnectWise Manage instance is hosted.
- Private Key: The private API key generated for secure authentication.
- Public Key: The public API key paired with the private key for API access.
Client ID
To obtain a Client ID, follow these steps:
- Follow this link.
- Sign in using the credentials provided by ConnectWise when you registered your account.
- Scroll to the bottom of the page and click Create New Integration.
- Set all parameters. Give the integration a name and a short description.
- Set the integration to Private.
- Select Technical Contact Email and populate with your email address.
- Set the product to Manage and click Submit.
- Remember to copy your Client ID and store it in a safe place.
Private and Public Key
Note: You must have Administrator access to ConnectWise Manage to obtain the public and private keys.
To obtain a Private and Public Key:
- Log in to ConnectWise Manage and navigate to System, Security Roles. You are creating a new security role that you'll use to obtain the REST API credentials.
- On Security Roles, click + (the plus icon) at the top of the screen.
- Enter a name for your new security role and then click Save.
- On Security Modules, expand Companies, Service Desk, and System.
- In all three sections, replicate the permission parameters precisely, as shown in the tables below. Expand the permissions from None, which is the default, to All. The following tables show the rows that require editing.
Companies | Add Level | Edit Level | Delete Level | Inquire Level |
|---|---|---|---|---|
Company Maintenance | All | All | None | All |
Configuration - Display Passwords | None | None | None | All |
Configurations | All | All | None | All |
Contacts | All | All | None | All |
Service Desk | Add Level | Edit Level | Delete Level | Inquire Level |
|---|---|---|---|---|
Service Tickets | None | None | None | All |
System | Add Level | Edit Level | Delete Level | Inquire Level |
|---|---|---|---|---|
API Reports | All | All | None | All |
Member Maintenance | None | None | None | All |
- After editing the permissions for each section, click Save and Close.
- Navigate to the System, Members, API Members tab, then click + New Member.
- On Details, complete the following fields in each section:
- Profile section:
- Member ID - Enter the username of the member (Swimlane). The maximum number of characters allowed is 15.
- Time Zone - Select a time zone for the internal company. To set up time zones, refer to ConnectWise's documentation here.
- Member Name - Enter the member's first and last name
- System section:
- Role ID - The security Role ID controls the level of access to the ConnectWise Manage application by limiting access to functionality. Select the new security role that you created.
- Location - Select the default location for the company. Any new record created by the member will default to the location set here.
- Level - Select the level of access that the member will have in the application. The member will be able to search for companies at the specified level and the ones below it. The restriction here applies to tickets for companies outside the location, as well as members.
- Business Unit - Select the member's business unit.
- Name - This field corresponds to the Level field above. After selecting a Level, select a specific name associated with the structure level. To setup Name, please refer to ConnectWise's documentation here.
- Default Territory - Select the member's default territory
- In the top menu bar, click Save.
- On the API Keys tab click (+).
- Enter a description of the key and then click Save.
- Once saved, the public and private keys will be generated.
- Remember to copy both your Public and Private Key, and store them in a safe place.
Company Identifier
The Company Identifier serves as a unique identifier and record ID.
Capabilities
This connector allows you to retrieve, edit, manage, and delete:
- Company records
- Contact records
- Service Boards
- Service License Agreements
- Service Desk Tickets
Retrieve and create:
- Project ticket notes
Retrieve, edit, and manage:
- Invoice records
Limitations
This connector only works with API version 2020.2 or newer. Additionally, this connector lacks tasks to create or delete an invoice.
Known Errors
- If you enter the wrong Company Identifier you will receive the following: Message : User Not Authenticated
- If you enter the wrong Public/Private Key you will receive the following: Message : incorrect public/private key
- If you enter the wrong Client ID you will receive the following: Message : Incorrect or disabled client ID
- For Tasks: Update A Company, Update A Contact, Update A Invoice, Update an SLA, Update A Service Board, and Update A Ticket. If only an ID is provided, and no field to update is given, the task will fail and you will receive the following: Message: Not Found for URL
Additional Documentation
Configurations
Asset
Authenticates ConnectWise Manage
Configuration Parameters
Parameter | Description | Type | Required |
|---|---|---|---|
api_version | ConnectWise API Version, it can befound in the dashboard after the base URL. | string | Required |
client_id | Client ID, used for authentication | string | Required |
company_identifier | Company Identifier, used for authentication | string | Required |
url | Server Host Address | string | Required |
private_key | Private Key, used for authentication. | string | Required |
public_key | Public Key, used for authentication. | string | Required |
verbose_errors | Turn on to get more detailed errors (generally used for debugging) | boolean | Optional |
verify_ssl | Verify SSL certificate | boolean | Optional |
http_proxy | A proxy to route requests through. | string | Optional |
Actions
Create Company
Create a new company record in ConnectWise Manage without requiring additional input parameters.
Endpoint
- URL: company/companies
- Method: POST
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
id | number | Optional | Unique identifier |
identifier | string | Optional | Unique identifier |
name | string | Optional | Name of the resource |
status | object | Optional | Status value |
status.id | number | Optional | Unique identifier |
status.name | string | Optional | Name of the resource |
status._info | object | Optional | Status value |
status._info.additionalProp1 | string | Optional | Status value |
status._info.additionalProp2 | string | Optional | Status value |
status._info.additionalProp3 | string | Optional | Status value |
addressLine1 | string | Optional | Parameter for Create Company |
addressLine2 | string | Optional | Parameter for Create Company |
city | string | Optional | Parameter for Create Company |
state | string | Optional | Parameter for Create Company |
zip | string | Optional | Parameter for Create Company |
country | object | Optional | Parameter for Create Company |
country.id | number | Optional | Unique identifier |
country.identifier | string | Optional | Unique identifier |
country.name | string | Optional | Name of the resource |
country._info | object | Optional | Parameter for Create Company |
country._info.additionalProp1 | string | Optional | Parameter for Create Company |
country._info.additionalProp2 | string | Optional | Parameter for Create Company |
country._info.additionalProp3 | string | Optional | Parameter for Create Company |
phoneNumber | string | Optional | Parameter for Create Company |
faxNumber | string | Optional | Parameter for Create Company |
Input Example
{"id":123,"identifier":"string","name":"Example Name","status":{"id":123,"name":"Example Name","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"addressLine1":"string","addressLine2":"string","city":"string","state":"string","zip":"string","country":{"id":123,"identifier":"string","name":"Example Name","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"phoneNumber":"string","faxNumber":"string","website":"string","territory":{"id":123,"name":"Example Name","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"market":{"id":123,"name":"Example Name","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"accountNumber":"string","defaultContact":{"id":123,"name":"Example Name","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"dateAcquired":"string","sicCode":{"id":123,"name":"Example Name","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"parentCompany":{"id":123,"identifier":"string","name":"Example Name","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"annualRevenue":123,"numberOfEmployees":123,"yearEstablished":123,"revenueYear":123,"ownershipType":{"id":123,"name":"Example Name","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"timeZoneSetup":{"id":123,"name":"Example Name","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"leadSource":"string","leadFlag":true,"unsubscribeFlag":true,"calendar":{"id":123,"name":"Example Name","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"userDefinedField1":"string","userDefinedField2":"string","userDefinedField3":"string","userDefinedField4":"string","userDefinedField5":"string","userDefinedField6":"string","userDefinedField7":"string","userDefinedField8":"string","userDefinedField9":"string","userDefinedField10":"string","vendorIdentifier":"string","taxIdentifier":"string","taxCode":{"id":123,"name":"Example Name","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"billingTerms":{"id":123,"name":"Example Name","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"invoiceTemplate":{"id":123,"name":"Example Name","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"pricingSchedule":{"id":123,"name":"Example Name","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"companyEntityType":{"id":123,"name":"Example Name","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"billToCompany":{"id":123,"identifier":"string","name":"Example Name","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"billingSite":{"id":123,"name":"Example Name","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"billingContact":{"id":123,"name":"Example Name","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
id | number | Unique identifier |
identifier | string | Unique identifier |
name | string | Name of the resource |
status | object | Status value |
status.id | number | Unique identifier |
status.name | string | Name of the resource |
status._info | object | Status value |
status._info.additionalProp1 | string | Status value |
status._info.additionalProp2 | string | Status value |
status._info.additionalProp3 | string | Status value |
addressLine1 | string | Output field: addressLine1 |
addressLine2 | string | Output field: addressLine2 |
city | string | Output field: city |
state | string | Output field: state |
zip | string | Output field: zip |
country | object | Output field: country |
country.id | number | Unique identifier |
country.identifier | string | Unique identifier |
country.name | string | Name of the resource |
country._info | object | Output field: country._info |
country._info.additionalProp1 | string | Output field: country._info.additionalProp1 |
country._info.additionalProp2 | string | Output field: country._info.additionalProp2 |
country._info.additionalProp3 | string | Output field: country._info.additionalProp3 |
Output Example
{"id":123,"identifier":"string","name":"Example Name","status":{"id":123,"name":"Example Name","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"addressLine1":"string","addressLine2":"string","city":"string","state":"string","zip":"string","country":{"id":123,"identifier":"string","name":"Example Name","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"phoneNumber":"string","faxNumber":"string","website":"string...
Create Contact
Generate a new contact record in ConnectWise Manage to add user details and streamline contact management within the system.
Endpoint
- URL: company/contacts
- Method: POST
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
id | number | Optional | Unique identifier |
firstName | string | Optional | Name of the resource |
lastName | string | Optional | Name of the resource |
company | object | Optional | Parameter for Create Contact |
company.id | number | Optional | Unique identifier |
company.identifier | string | Optional | Unique identifier |
company.name | string | Optional | Name of the resource |
company._info | object | Optional | Parameter for Create Contact |
company._info.additionalProp1 | string | Optional | Parameter for Create Contact |
company._info.additionalProp2 | string | Optional | Parameter for Create Contact |
company._info.additionalProp3 | string | Optional | Parameter for Create Contact |
site | object | Optional | Parameter for Create Contact |
site.id | number | Optional | Unique identifier |
site.name | string | Optional | Name of the resource |
site._info | object | Optional | Parameter for Create Contact |
site._info.additionalProp1 | string | Optional | Parameter for Create Contact |
site._info.additionalProp2 | string | Optional | Parameter for Create Contact |
site._info.additionalProp3 | string | Optional | Parameter for Create Contact |
addressLine1 | string | Optional | Parameter for Create Contact |
addressLine2 | string | Optional | Parameter for Create Contact |
city | string | Optional | Parameter for Create Contact |
state | string | Optional | Parameter for Create Contact |
zip | string | Optional | Parameter for Create Contact |
country | object | Optional | Parameter for Create Contact |
country.id | number | Optional | Unique identifier |
Input Example
{"json_body":{"id":0,"firstName":"string","lastName":"string","company":{"id":0,"identifier":"string","name":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"site":{"id":0,"name":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"addressLine1":"string","addressLine2":"string","city":"string","state":"string","zip":"string","country":{"id":0,"identifier":"string","name":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"relationship":{"id":0,"name":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"relationshipOverride":"string","department":{"id":0,"name":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"inactiveFlag":true,"defaultMergeContactId":0,"securityIdentifier":"string","managerContact":{"id":0,"name":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"assistantContact":{"id":0,"name":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"title":"string","school":"string","nickName":"string","marriedFlag":true,"childrenFlag":true,"children":"string","significantOther":"string","portalPassword":"string","portalSecurityLevel":0,"disablePortalLoginFlag":true,"unsubscribeFlag":true,"gender":"Female","birthDay":"string","anniversary":"string","presence":"NoAgent","mobileGuid":"3fa85f64-5717-4562-b3fc-2c963f66afa6","facebookUrl":"string","twitterUrl":"string","linkedInUrl":"string","defaultPhoneType":"string","defaultPhoneNbr":"string","defaultPhoneExtension":"string","defaultBillingFlag":true,"defaultFlag":true,"userDefinedField1":"string","userDefinedField2":"string","userDefinedField3":"string","userDefinedField4":"string","userDefinedField5":"string","userDefinedField6":"string","userDefinedField7":"string","userDefinedField8":"string","userDefinedField9":"string","userDefinedField10":"string","companyLocation":{"id":0,"name":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"communicationItems":[{"id":0,"type":{"id":0,"name":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"value":"string","extension":"string","defaultFlag":true,"domain":"string","communicationType":"Email"}],"types":[{"id":0,"name":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}}],"integratorTags":["string"],"customFields":[{"id":0,"caption":"string","type":"TextArea","entryMethod":"Date","numberOfDecimals":0,"value":{}}],"photo":{"id":0,"name":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"ignoreDuplicates":true,"_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"},"typeIds":[0]}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
id | number | Unique identifier |
firstName | string | Name of the resource |
lastName | string | Name of the resource |
company | object | Output field: company |
company.id | number | Unique identifier |
company.identifier | string | Unique identifier |
company.name | string | Name of the resource |
company._info | object | Output field: company._info |
company._info.additionalProp1 | string | Output field: company._info.additionalProp1 |
company._info.additionalProp2 | string | Output field: company._info.additionalProp2 |
company._info.additionalProp3 | string | Output field: company._info.additionalProp3 |
site | object | Output field: site |
site.id | number | Unique identifier |
site.name | string | Name of the resource |
site._info | object | Output field: site._info |
site._info.additionalProp1 | string | Output field: site._info.additionalProp1 |
site._info.additionalProp2 | string | Output field: site._info.additionalProp2 |
site._info.additionalProp3 | string | Output field: site._info.additionalProp3 |
addressLine1 | string | Output field: addressLine1 |
addressLine2 | string | Output field: addressLine2 |
city | string | Output field: city |
state | string | Output field: state |
zip | string | Output field: zip |
Output Example
{"status_code":201,"response_headers":{"Content-Type":"application/json; charset=utf-8","Transfer-Encoding":"chunked","Connection":"keep-alive","Date":"Mon, 04 Dec 2023 10:03:39 GMT","Cache-Control":"no-cache","Pragma":"no-cache","Expires":"-1","Strict-Transport-Security":"max-age=31536000; includeSubDomains","x-server-name":"IP-0A0A0134","x-cw-request-id":"3d48a108-bdfe-4ca7-8372-3719b0e4c80c","x-frame-options":"SAMEORIGIN","Link":"<https://api-staging.connectwisedev.com/v4_6_release/apis/3.0/c...
Create Service Board
Create a new service board in ConnectWise Manage to efficiently organize and manage service tickets and requests.
Endpoint
- URL: service/boards
- Method: POST
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
id | number | Optional | Unique identifier |
name | string | Optional | Name of the resource |
location | object | Optional | Parameter for Create Service Board |
location.id | number | Optional | Unique identifier |
location.name | string | Optional | Name of the resource |
location._info | object | Optional | Parameter for Create Service Board |
location._info.additionalProp1 | string | Optional | Parameter for Create Service Board |
location._info.additionalProp2 | string | Optional | Parameter for Create Service Board |
location._info.additionalProp3 | string | Optional | Parameter for Create Service Board |
department | object | Optional | Parameter for Create Service Board |
department.id | number | Optional | Unique identifier |
department.identifier | string | Optional | Unique identifier |
department.name | string | Optional | Name of the resource |
department._info | object | Optional | Parameter for Create Service Board |
department._info.additionalProp1 | string | Optional | Parameter for Create Service Board |
department._info.additionalProp2 | string | Optional | Parameter for Create Service Board |
department._info.additionalProp3 | string | Optional | Parameter for Create Service Board |
inactiveFlag | boolean | Optional | Parameter for Create Service Board |
signOffTemplate | object | Optional | Parameter for Create Service Board |
signOffTemplate.id | number | Optional | Unique identifier |
signOffTemplate.name | string | Optional | Name of the resource |
signOffTemplate._info | object | Optional | Parameter for Create Service Board |
signOffTemplate._info.additionalProp1 | string | Optional | Parameter for Create Service Board |
signOffTemplate._info.additionalProp2 | string | Optional | Parameter for Create Service Board |
signOffTemplate._info.additionalProp3 | string | Optional | Parameter for Create Service Board |
Input Example
{"json_body":{"id":0,"name":"string","location":{"id":0,"name":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"department":{"id":0,"identifier":"string","name":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"inactiveFlag":true,"signOffTemplate":{"id":0,"name":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"sendToContactFlag":true,"contactTemplate":{"id":0,"identifier":"string","name":"string","type":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"sendToResourceFlag":true,"resourceTemplate":{"id":0,"identifier":"string","name":"string","type":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"projectFlag":true,"showDependenciesFlag":true,"showEstimatesFlag":true,"boardIcon":{"id":0,"name":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"billTicketsAfterClosedFlag":true,"billTicketSeparatelyFlag":true,"billUnapprovedTimeExpenseFlag":true,"overrideBillingSetupFlag":true,"dispatchMember":{"id":0,"identifier":"string","name":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"serviceManagerMember":{"id":0,"identifier":"string","name":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"dutyManagerMember":{"id":0,"identifier":"string","name":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"oncallMember":{"id":0,"identifier":"string","name":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"workRole":{"id":0,"name":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"workType":{"id":0,"name":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"billTime":"Billable","billExpense":"Billable","billProduct":"Billable","autoCloseStatus":{"id":0,"name":"string","sort":0,"_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"autoAssignNewTicketsFlag":true,"autoAssignNewECTicketsFlag":true,"autoAssignNewPortalTicketsFlag":true,"discussionsLockedFlag":true,"timeEntryLockedFlag":true,"notifyEmailFrom":"string","notifyEmailFromName":"string","closedLoopDiscussionsFlag":true,"closedLoopResolutionFlag":true,"closedLoopInternalAnalysisFlag":true,"timeEntryDiscussionFlag":true,"timeEntryResolutionFlag":true,"timeEntryInternalAnalysisFlag":true,"problemSort":"Ascending","resolutionSort":"Ascending","internalAnalysisSort":"Ascending","emailConnectorAllowReopenClosedFlag":true,"emailConnectorReopenStatus":{"id":0,"name":"string","sort":0,"_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"emailConnectorReopenResourcesFlag":true,"emailConnectorNewTicketNoMatchFlag":true,"emailConnectorNeverReopenByDaysFlag":true,"emailConnectorReopenDaysLimit":0,"emailConnectorNeverReopenByDaysClosedFlag":true,"emailConnectorReopenDaysClosedLimit":0,"useMemberDisplayNameFlag":true,"sendToCCFlag":true,"autoAssignTicketOwnerFlag":true,"autoAssignLimitFlag":true,"autoAssignLimitAmount":0,"closedLoopAllFlag":true,"percentageCalculation":"ActualHours","allSort":"Ascending","markFirstNoteIssueFlag":true,"restrictBoardByDefaultFlag":true,"_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
id | number | Unique identifier |
name | string | Name of the resource |
location | object | Output field: location |
location.id | number | Unique identifier |
location.name | string | Name of the resource |
location._info | object | Output field: location._info |
location._info.additionalProp1 | string | Output field: location._info.additionalProp1 |
location._info.additionalProp2 | string | Output field: location._info.additionalProp2 |
location._info.additionalProp3 | string | Output field: location._info.additionalProp3 |
department | object | Output field: department |
department.id | number | Unique identifier |
department.identifier | string | Unique identifier |
department.name | string | Name of the resource |
department._info | object | Output field: department._info |
department._info.additionalProp1 | string | Output field: department._info.additionalProp1 |
department._info.additionalProp2 | string | Output field: department._info.additionalProp2 |
department._info.additionalProp3 | string | Output field: department._info.additionalProp3 |
inactiveFlag | boolean | Output field: inactiveFlag |
signOffTemplate | object | Output field: signOffTemplate |
signOffTemplate.id | number | Unique identifier |
signOffTemplate.name | string | Name of the resource |
signOffTemplate._info | object | Output field: signOffTemplate._info |
signOffTemplate._info.additionalProp1 | string | Output field: signOffTemplate._info.additionalProp1 |
signOffTemplate._info.additionalProp2 | string | Output field: signOffTemplate._info.additionalProp2 |
Output Example
{"status_code":201,"response_headers":{"Content-Type":"application/json; charset=utf-8","Transfer-Encoding":"chunked","Connection":"keep-alive","Date":"Mon, 04 Dec 2023 10:03:39 GMT","Cache-Control":"no-cache","Pragma":"no-cache","Expires":"-1","Strict-Transport-Security":"max-age=31536000; includeSubDomains","x-server-name":"IP-0A0A0134","x-cw-request-id":"3d48a108-bdfe-4ca7-8372-3719b0e4c80c","x-frame-options":"SAMEORIGIN","Link":"<https://api-staging.connectwisedev.com/v4_6_release/apis/3.0/c...
Create SLA
Create a new Service Level Agreement (SLA) in ConnectWise Manage and receive details of the created SLA.
Endpoint
- URL: service/SLAs
- Method: POST
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
parameters.id | number | Optional | Parameters for the Create SLA action |
parameters.name | string | Optional | Parameters for the Create SLA action |
parameters.basedOn | string | Optional | Parameters for the Create SLA action |
parameters.customCalendar | object | Optional | Parameters for the Create SLA action |
parameters.customCalendar.id | number | Optional | Parameters for the Create SLA action |
parameters.customCalendar.name | string | Optional | Parameters for the Create SLA action |
parameters.customCalendar._info | object | Optional | Parameters for the Create SLA action |
parameters.customCalendar._info.additionalProp1 | string | Optional | Parameters for the Create SLA action |
parameters.customCalendar._info.additionalProp2 | string | Optional | Parameters for the Create SLA action |
parameters.customCalendar._info.additionalProp3 | string | Optional | Parameters for the Create SLA action |
parameters.defaultFlag | boolean | Optional | Parameters for the Create SLA action |
parameters.applicationOrder | number | Optional | Parameters for the Create SLA action |
parameters.hiImpactHiUrgency | object | Optional | Parameters for the Create SLA action |
parameters.hiImpactHiUrgency.id | number | Optional | Parameters for the Create SLA action |
parameters.hiImpactHiUrgency.name | string | Optional | Parameters for the Create SLA action |
parameters.hiImpactHiUrgency.sort | number | Optional | Parameters for the Create SLA action |
parameters.hiImpactHiUrgency.level | string | Optional | Parameters for the Create SLA action |
parameters.hiImpactHiUrgency._info | object | Optional | Parameters for the Create SLA action |
parameters.hiImpactHiUrgency._info.additionalProp1 | string | Optional | Parameters for the Create SLA action |
parameters.hiImpactHiUrgency._info.additionalProp2 | string | Optional | Parameters for the Create SLA action |
parameters.hiImpactHiUrgency._info.additionalProp3 | string | Optional | Parameters for the Create SLA action |
parameters.hiImpactMedUrgency | object | Optional | Parameters for the Create SLA action |
parameters.hiImpactMedUrgency.id | number | Optional | Parameters for the Create SLA action |
parameters.hiImpactMedUrgency.name | string | Optional | Parameters for the Create SLA action |
parameters.hiImpactMedUrgency.sort | number | Optional | Parameters for the Create SLA action |
Input Example
{"parameters":{"id":0,"name":"string","basedOn":"AllHours","customCalendar":{"id":0,"name":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"defaultFlag":true,"applicationOrder":0,"hiImpactHiUrgency":{"id":0,"name":"string","sort":0,"level":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"hiImpactMedUrgency":{"id":0,"name":"string","sort":0,"level":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"hiImpactLowUrgency":{"id":0,"name":"string","sort":0,"level":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"medImpactHiUrgency":{"id":0,"name":"string","sort":0,"level":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"medImpactMedUrgency":{"id":0,"name":"string","sort":0,"level":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"medImpactLowUrgency":{"id":0,"name":"string","sort":0,"level":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"lowImpactHiUrgency":{"id":0,"name":"string","sort":0,"level":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"lowImpactMedUrgency":{"id":0,"name":"string","sort":0,"level":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"lowImpactLowUrgency":{"id":0,"name":"string","sort":0,"level":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"respondHours":0,"respondPercent":0,"planWithin":0,"planWithinPercent":0,"resolutionHours":0,"resolutionPercent":0,"_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
id | number | Unique identifier |
name | string | Name of the resource |
basedOn | string | Output field: basedOn |
customCalendar | object | Output field: customCalendar |
customCalendar.id | number | Unique identifier |
customCalendar.name | string | Name of the resource |
customCalendar._info | object | Output field: customCalendar._info |
customCalendar._info.additionalProp1 | string | Output field: customCalendar._info.additionalProp1 |
customCalendar._info.additionalProp2 | string | Output field: customCalendar._info.additionalProp2 |
customCalendar._info.additionalProp3 | string | Output field: customCalendar._info.additionalProp3 |
defaultFlag | boolean | Output field: defaultFlag |
applicationOrder | number | Output field: applicationOrder |
hiImpactHiUrgency | object | Output field: hiImpactHiUrgency |
hiImpactHiUrgency.id | number | Unique identifier |
hiImpactHiUrgency.name | string | Name of the resource |
hiImpactHiUrgency.sort | number | Output field: hiImpactHiUrgency.sort |
hiImpactHiUrgency.level | string | Output field: hiImpactHiUrgency.level |
hiImpactHiUrgency._info | object | Output field: hiImpactHiUrgency._info |
hiImpactHiUrgency._info.additionalProp1 | string | Output field: hiImpactHiUrgency._info.additionalProp1 |
hiImpactHiUrgency._info.additionalProp2 | string | Output field: hiImpactHiUrgency._info.additionalProp2 |
hiImpactHiUrgency._info.additionalProp3 | string | Output field: hiImpactHiUrgency._info.additionalProp3 |
hiImpactMedUrgency | object | Output field: hiImpactMedUrgency |
hiImpactMedUrgency.id | number | Unique identifier |
hiImpactMedUrgency.name | string | Name of the resource |
Output Example
{"status_code":201,"response_headers":{"Content-Type":"application/json; charset=utf-8","Transfer-Encoding":"chunked","Connection":"keep-alive","Date":"Mon, 04 Dec 2023 10:03:39 GMT","Cache-Control":"no-cache","Pragma":"no-cache","Expires":"-1","Strict-Transport-Security":"max-age=31536000; includeSubDomains","x-server-name":"IP-0A0A0134","x-cw-request-id":"3d48a108-bdfe-4ca7-8372-3719b0e4c80c","x-frame-options":"SAMEORIGIN","Link":"<https://api-staging.connectwisedev.com/v4_6_release/apis/3.0/c...
Create Ticket
Create a service desk ticket in ConnectWise Manage using required details such as summary and company, enabling efficient issue tracking and management.
Endpoint
- URL: service/tickets
- Method: POST
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
id | number | Optional | Unique identifier |
summary | string | Optional | Parameter for Create Ticket |
recordType | string | Optional | Type of the resource |
board | object | Optional | Parameter for Create Ticket |
board.id | number | Optional | Unique identifier |
board.name | string | Optional | Name of the resource |
board._info | object | Optional | Parameter for Create Ticket |
board._info.additionalProp1 | string | Optional | Parameter for Create Ticket |
board._info.additionalProp2 | string | Optional | Parameter for Create Ticket |
board._info.additionalProp3 | string | Optional | Parameter for Create Ticket |
status | object | Optional | Status value |
status.id | number | Optional | Unique identifier |
status.name | string | Optional | Name of the resource |
status.sort | number | Optional | Status value |
status._info | object | Optional | Status value |
status._info.additionalProp1 | string | Optional | Status value |
status._info.additionalProp2 | string | Optional | Status value |
status._info.additionalProp3 | string | Optional | Status value |
workRole | object | Optional | Parameter for Create Ticket |
workRole.id | number | Optional | Unique identifier |
workRole.name | string | Optional | Name of the resource |
workRole._info | object | Optional | Parameter for Create Ticket |
workRole._info.additionalProp1 | string | Optional | Parameter for Create Ticket |
workRole._info.additionalProp2 | string | Optional | Parameter for Create Ticket |
workRole._info.additionalProp3 | string | Optional | Parameter for Create Ticket |
Input Example
{"id":123,"summary":"string","recordType":"string","board":{"id":123,"name":"Example Name","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"status":{"id":123,"name":"Example Name","sort":123,"_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"workRole":{"id":123,"name":"Example Name","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"workType":{"id":123,"name":"Example Name","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"company":{"id":123,"identifier":"string","name":"Example Name","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"site":{"id":123,"name":"Example Name","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"siteName":"Example Name","addressLine1":"string","addressLine2":"string","city":"string","stateIdentifier":"string","zip":"string","country":{"id":123,"identifier":"string","name":"Example Name","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"contact":{"id":123,"name":"Example Name","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"contactName":"Example Name","contactPhoneNumber":"string","contactPhoneExtension":"string","contactEmailAddress":"string","type":{"id":123,"name":"Example Name","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"subType":{"id":123,"name":"Example Name","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"item":{"id":123,"name":"Example Name","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"team":{"id":123,"name":"Example Name","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"owner":{"id":123,"identifier":"string","name":"Example Name","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"priority":{"id":123,"name":"Example Name","sort":123,"level":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"serviceLocation":{"id":123,"name":"Example Name","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"source":{"id":123,"name":"Example Name","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"requiredDate":"string","budgetHours":123,"opportunity":{"id":123,"name":"Example Name","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"agreement":{"id":123,"name":"Example Name","type":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"severity":"string","impact":"string","externalXRef":"string","poNumber":"string","knowledgeBaseCategoryId":123,"knowledgeBaseSubCategoryId":123,"allowAllClientsPortalView":true,"customerUpdatedFlag":true,"automaticEmailContactFlag":true,"automaticEmailResourceFlag":true,"automaticEmailCcFlag":true,"automaticEmailCc":"string","initialDescription":"string","initialInternalAnalysis":"string","initialResolution":"string","initialDescriptionFrom":"string","contactEmailLookup":"string"}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
id | number | Unique identifier |
summary | string | Output field: summary |
recordType | string | Type of the resource |
board | object | Output field: board |
board.id | number | Unique identifier |
board.name | string | Name of the resource |
board._info | object | Output field: board._info |
board._info.additionalProp1 | string | Output field: board._info.additionalProp1 |
board._info.additionalProp2 | string | Output field: board._info.additionalProp2 |
board._info.additionalProp3 | string | Output field: board._info.additionalProp3 |
status | object | Status value |
status.id | number | Unique identifier |
status.name | string | Name of the resource |
status.sort | number | Status value |
status._info | object | Status value |
status._info.additionalProp1 | string | Status value |
status._info.additionalProp2 | string | Status value |
status._info.additionalProp3 | string | Status value |
workRole | object | Output field: workRole |
workRole.id | number | Unique identifier |
workRole.name | string | Name of the resource |
workRole._info | object | Output field: workRole._info |
workRole._info.additionalProp1 | string | Output field: workRole._info.additionalProp1 |
workRole._info.additionalProp2 | string | Output field: workRole._info.additionalProp2 |
Output Example
{"status_code":201,"response_headers":{"Content-Type":"application/json; charset=utf-8","Transfer-Encoding":"chunked","Connection":"keep-alive","Date":"Mon, 04 Dec 2023 10:03:39 GMT","Cache-Control":"no-cache","Pragma":"no-cache","Expires":"-1","Strict-Transport-Security":"max-age=31536000; includeSubDomains","x-server-name":"IP-0A0A0134","x-cw-request-id":"3d48a108-bdfe-4ca7-8372-3719b0e4c80c","x-frame-options":"SAMEORIGIN","Link":"<https://api-staging.connectwisedev.com/v4_6_release/apis/3.0/c...
Create Ticket Notes
Add a note to a project ticket in ConnectWise Manage by specifying the ticket's parent ID and the note text.
Endpoint
- URL: project/tickets/{{parentId}}/notes
- Method: POST
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.parentId | number | Required | The project ticket ID to add a note to. |
id | number | Optional | Unique identifier |
ticketId | number | Optional | Unique identifier |
text | string | Optional | The note content. |
detailDescriptionFlag | boolean | Optional | When true, the note appears in the Discussion tab. |
internalAnalysisFlag | boolean | Optional | When true, the note appears in the Internal Analysis tab. |
resolutionFlag | boolean | Optional | When true, the note appears in the Resolution tab. |
issueFlag | boolean | Optional | Parameter for Create Ticket Notes |
member | object | Optional | Parameter for Create Ticket Notes |
member.id | number | Optional | Unique identifier |
member.identifier | string | Optional | Unique identifier |
member.name | string | Optional | Name of the resource |
member._info | object | Optional | Parameter for Create Ticket Notes |
contact | object | Optional | Parameter for Create Ticket Notes |
contact.id | number | Optional | Unique identifier |
contact.name | string | Optional | Name of the resource |
contact._info | object | Optional | Parameter for Create Ticket Notes |
customerUpdatedFlag | boolean | Optional | Parameter for Create Ticket Notes |
processNotifications | boolean | Optional | Parameter for Create Ticket Notes |
internalFlag | boolean | Optional | When true, the note appears in the Internal tab. |
externalFlag | boolean | Optional | Parameter for Create Ticket Notes |
_info | object | Optional | Parameter for Create Ticket Notes |
Input Example
{"json_body":{"text":"Customer reported password reset issue.","detailDescriptionFlag":true,"internalAnalysisFlag":false,"resolutionFlag":false},"path_parameters":{"parentId":1047}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
id | number | Unique identifier |
ticketId | number | Unique identifier |
text | string | Output field: text |
detailDescriptionFlag | boolean | Output field: detailDescriptionFlag |
internalAnalysisFlag | boolean | Output field: internalAnalysisFlag |
resolutionFlag | boolean | Output field: resolutionFlag |
issueFlag | boolean | Output field: issueFlag |
member | object | Output field: member |
member.id | number | Unique identifier |
member.identifier | string | Unique identifier |
member.name | string | Name of the resource |
member._info | object | Output field: member._info |
contact | object | Output field: contact |
contact.id | number | Unique identifier |
contact.name | string | Name of the resource |
contact._info | object | Output field: contact._info |
customerUpdatedFlag | boolean | Output field: customerUpdatedFlag |
processNotifications | boolean | Output field: processNotifications |
dateCreated | string | Output field: dateCreated |
createdBy | string | Output field: createdBy |
internalFlag | boolean | Output field: internalFlag |
externalFlag | boolean | Output field: externalFlag |
_info | object | Output field: _info |
Output Example
{"id":123,"ticketId":123,"text":"string","detailDescriptionFlag":true,"internalAnalysisFlag":true,"resolutionFlag":true,"issueFlag":true,"member":{"id":123,"identifier":"string","name":"Example Name","_info":{}},"contact":{"id":123,"name":"Example Name","_info":{}},"customerUpdatedFlag":true,"processNotifications":true,"dateCreated":"string","createdBy":"string","internalFlag":true,"externalFlag":true}
Delete Company By ID
Remove a specified company from ConnectWise Manage by providing the unique company ID as a path parameter.
Endpoint
- URL: company/companies/{{id}}
- Method: DELETE
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.id | number | Required | Parameters for the Delete Company By ID action |
Input Example
{"path_parameters":{"id":763}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{"status_code":204,"response_headers":{"Content-Type":"application/json; charset=utf-8","Transfer-Encoding":"chunked","Connection":"keep-alive","Date":"Mon, 04 Dec 2023 10:03:39 GMT","Cache-Control":"no-cache","Pragma":"no-cache","Expires":"-1","Strict-Transport-Security":"max-age=31536000; includeSubDomains","x-server-name":"IP-0A0A0134","x-cw-request-id":"3d48a108-bdfe-4ca7-8372-3719b0e4c80c","x-frame-options":"SAMEORIGIN","Link":"<https://api-staging.connectwisedev.com/v4_6_release/apis/3.0/c...
Delete Contact By ID
Remove a contact from ConnectWise Manage by specifying the unique contact ID in the path parameters.
Endpoint
- URL: company/contacts/{{id}}
- Method: DELETE
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.id | number | Required | Parameters for the Delete Contact By ID action |
Input Example
{"path_parameters":{"id":27}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{"status_code":204,"response_headers":{"Content-Type":"application/json; charset=utf-8","Transfer-Encoding":"chunked","Connection":"keep-alive","Date":"Mon, 04 Dec 2023 10:03:39 GMT","Cache-Control":"no-cache","Pragma":"no-cache","Expires":"-1","Strict-Transport-Security":"max-age=31536000; includeSubDomains","x-server-name":"IP-0A0A0134","x-cw-request-id":"3d48a108-bdfe-4ca7-8372-3719b0e4c80c","x-frame-options":"SAMEORIGIN","Link":"<https://api-staging.connectwisedev.com/v4_6_release/apis/3.0/c...
Delete Service Board
Remove a specific service board from ConnectWise Manage by providing its unique ID.
Endpoint
- URL: service/boards/{{id}}
- Method: DELETE
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.id | number | Required | Parameters for the Delete Service Board action |
Input Example
{"path_parameters":{"id":764}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{"status_code":204,"response_headers":{"Content-Type":"application/json; charset=utf-8","Transfer-Encoding":"chunked","Connection":"keep-alive","Date":"Mon, 04 Dec 2023 10:03:39 GMT","Cache-Control":"no-cache","Pragma":"no-cache","Expires":"-1","Strict-Transport-Security":"max-age=31536000; includeSubDomains","x-server-name":"IP-0A0A0134","x-cw-request-id":"3d48a108-bdfe-4ca7-8372-3719b0e4c80c","x-frame-options":"SAMEORIGIN","Link":"<https://api-staging.connectwisedev.com/v4_6_release/apis/3.0/c...
Delete SLA By ID
Remove a specific Service Level Agreement (SLA) from ConnectWise Manage by providing its unique ID.
Endpoint
- URL: service/SLAs/{{id}}
- Method: DELETE
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.id | number | Required | Parameters for the Delete SLA By ID action |
Input Example
{"path_parameters":{"id":764}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{"status_code":204,"response_headers":{"Content-Type":"application/json; charset=utf-8","Transfer-Encoding":"chunked","Connection":"keep-alive","Date":"Mon, 04 Dec 2023 10:03:39 GMT","Cache-Control":"no-cache","Pragma":"no-cache","Expires":"-1","Strict-Transport-Security":"max-age=31536000; includeSubDomains","x-server-name":"IP-0A0A0134","x-cw-request-id":"3d48a108-bdfe-4ca7-8372-3719b0e4c80c","x-frame-options":"SAMEORIGIN","Link":"<https://api-staging.connectwisedev.com/v4_6_release/apis/3.0/c...
Delete Ticket By ID
Remove a specified ticket from ConnectWise Manage by providing the unique ticket ID in the path parameters.
Endpoint
- URL: service/tickets/{{id}}
- Method: DELETE
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.id | number | Required | Parameters for the Delete Ticket By ID action |
Input Example
{"path_parameters":{"id":763}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{"status_code":204,"response_headers":{"Content-Type":"application/json; charset=utf-8","Transfer-Encoding":"chunked","Connection":"keep-alive","Date":"Mon, 04 Dec 2023 10:03:39 GMT","Cache-Control":"no-cache","Pragma":"no-cache","Expires":"-1","Strict-Transport-Security":"max-age=31536000; includeSubDomains","x-server-name":"IP-0A0A0134","x-cw-request-id":"3d48a108-bdfe-4ca7-8372-3719b0e4c80c","x-frame-options":"SAMEORIGIN","Link":"<https://api-staging.connectwisedev.com/v4_6_release/apis/3.0/c...
Get Companies
Retrieve a comprehensive list of companies from ConnectWise Manage, including essential details for each organization.
Endpoint
- URL: company/companies
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
parameters.conditions | string | Optional | Parameters for the Get Companies action |
parameters.childConditions | string | Optional | Parameters for the Get Companies action |
parameters.columns | string | Optional | Parameters for the Get Companies action |
parameters.orderBy | string | Optional | Parameters for the Get Companies action |
parameters.fields | string | Optional | Parameters for the Get Companies action |
parameters.page | number | Optional | Parameters for the Get Companies action |
parameters.pageId | number | Optional | Parameters for the Get Companies action |
parameters.pageSize | number | Optional | Parameters for the Get Companies action |
parameters.customFieldConditions | string | Optional | Parameters for the Get Companies action |
Input Example
{"parameters":{"conditions":"board/name=Integration or summary=xyz or board/id in (3, 2, 4) or lastUpdated > [2016-08-20T18:04:26Z]","childConditions":"communicationItems/value like [email protected] AND communicationItems/communicationType=Email","columns":"id,summary,name","orderBy":"applicationOrder asc","fields":"id,name,status/id","page":20,"pageId":1,"pageSize":20,"customFieldConditions":"caption='TomNumber' AND value !=null"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{"status_code":200,"response_headers":{"Content-Type":"application/json; charset=utf-8","Transfer-Encoding":"chunked","Connection":"keep-alive","Date":"Mon, 04 Dec 2023 10:03:39 GMT","Cache-Control":"no-cache","Pragma":"no-cache","Expires":"-1","Strict-Transport-Security":"max-age=31536000; includeSubDomains","x-server-name":"IP-0A0A0134","x-cw-request-id":"3d48a108-bdfe-4ca7-8372-3719b0e4c80c","x-frame-options":"SAMEORIGIN","Link":"<https://api-staging.connectwisedev.com/v4_6_release/apis/3.0/c...
Get Company By ID
Retrieve detailed information for a specific company in ConnectWise Manage using the unique company ID as a path parameter.
Endpoint
- URL: company/companies/{{id}}
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.id | number | Required | Parameters for the Get Company By ID action |
parameters.conditions | string | Optional | Parameters for the Get Company By ID action |
parameters.childConditions | string | Optional | Parameters for the Get Company By ID action |
parameters.orderBy | string | Optional | Parameters for the Get Company By ID action |
parameters.fields | string | Optional | Parameters for the Get Company By ID action |
parameters.page | number | Optional | Parameters for the Get Company By ID action |
parameters.pageId | number | Optional | Parameters for the Get Company By ID action |
parameters.pageSize | number | Optional | Parameters for the Get Company By ID action |
parameters.customFieldConditions | string | Optional | Parameters for the Get Company By ID action |
Input Example
{"parameters":{"conditions":"board/name=Integration or summary=xyz or board/id in (3, 2, 4) or lastUpdated > [2016-08-20T18:04:26Z]","childConditions":"communicationItems/value like [email protected] AND communicationItems/communicationType=Email","orderBy":"applicationOrder asc","fields":"id,name,status/id","page":20,"pageId":1,"pageSize":20,"customFieldConditions":"caption='TomNumber' AND value !=null"},"path_parameters":{"id":1}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
id | number | Unique identifier |
identifier | string | Unique identifier |
name | string | Name of the resource |
status | object | Status value |
status.id | number | Unique identifier |
status.name | string | Name of the resource |
status._info | object | Status value |
status._info.additionalProp1 | string | Status value |
status._info.additionalProp2 | string | Status value |
status._info.additionalProp3 | string | Status value |
addressLine1 | string | Output field: addressLine1 |
addressLine2 | string | Output field: addressLine2 |
city | string | Output field: city |
state | string | Output field: state |
zip | string | Output field: zip |
country | object | Output field: country |
country.id | number | Unique identifier |
country.identifier | string | Unique identifier |
country.name | string | Name of the resource |
country._info | object | Output field: country._info |
country._info.additionalProp1 | string | Output field: country._info.additionalProp1 |
country._info.additionalProp2 | string | Output field: country._info.additionalProp2 |
country._info.additionalProp3 | string | Output field: country._info.additionalProp3 |
Output Example
{"status_code":200,"response_headers":{"Content-Type":"application/json; charset=utf-8","Transfer-Encoding":"chunked","Connection":"keep-alive","Date":"Mon, 04 Dec 2023 10:03:39 GMT","Cache-Control":"no-cache","Pragma":"no-cache","Expires":"-1","Strict-Transport-Security":"max-age=31536000; includeSubDomains","x-server-name":"IP-0A0A0134","x-cw-request-id":"3d48a108-bdfe-4ca7-8372-3719b0e4c80c","x-frame-options":"SAMEORIGIN","Link":"<https://api-staging.connectwisedev.com/v4_6_release/apis/3.0/c...
Get Contact By ID
Retrieve detailed information for a contact in ConnectWise Manage using the unique contact ID.
Endpoint
- URL: company/contacts/{{id}}
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.id | number | Required | Parameters for the Get Contact By ID action |
parameters.conditions | string | Optional | Parameters for the Get Contact By ID action |
parameters.childConditions | string | Optional | Parameters for the Get Contact By ID action |
parameters.orderBy | string | Optional | Parameters for the Get Contact By ID action |
parameters.fields | string | Optional | Parameters for the Get Contact By ID action |
parameters.page | number | Optional | Parameters for the Get Contact By ID action |
parameters.pageId | number | Optional | Parameters for the Get Contact By ID action |
parameters.pageSize | number | Optional | Parameters for the Get Contact By ID action |
parameters.customFieldConditions | string | Optional | Parameters for the Get Contact By ID action |
Input Example
{"parameters":{"conditions":"board/name=Integration or summary=xyz or board/id in (3, 2, 4) or lastUpdated > [2016-08-20T18:04:26Z]","childConditions":"communicationItems/value like [email protected] AND communicationItems/communicationType=Email","orderBy":"applicationOrder asc","fields":"id,name,status/id","page":20,"pageId":1,"pageSize":20,"customFieldConditions":"caption='TomNumber' AND value !=null"},"path_parameters":{"id":764}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
id | number | Unique identifier |
firstName | string | Name of the resource |
lastName | string | Name of the resource |
company | object | Output field: company |
company.id | number | Unique identifier |
company.identifier | string | Unique identifier |
company.name | string | Name of the resource |
company._info | object | Output field: company._info |
company._info.additionalProp1 | string | Output field: company._info.additionalProp1 |
company._info.additionalProp2 | string | Output field: company._info.additionalProp2 |
company._info.additionalProp3 | string | Output field: company._info.additionalProp3 |
site | object | Output field: site |
site.id | number | Unique identifier |
site.name | string | Name of the resource |
site._info | object | Output field: site._info |
site._info.additionalProp1 | string | Output field: site._info.additionalProp1 |
site._info.additionalProp2 | string | Output field: site._info.additionalProp2 |
site._info.additionalProp3 | string | Output field: site._info.additionalProp3 |
addressLine1 | string | Output field: addressLine1 |
addressLine2 | string | Output field: addressLine2 |
city | string | Output field: city |
state | string | Output field: state |
zip | string | Output field: zip |
country | object | Output field: country |
Output Example
{"status_code":200,"response_headers":{"Content-Type":"application/json; charset=utf-8","Transfer-Encoding":"chunked","Connection":"keep-alive","Date":"Mon, 04 Dec 2023 10:03:39 GMT","Cache-Control":"no-cache","Pragma":"no-cache","Expires":"-1","Strict-Transport-Security":"max-age=31536000; includeSubDomains","x-server-name":"IP-0A0A0134","x-cw-request-id":"3d48a108-bdfe-4ca7-8372-3719b0e4c80c","x-frame-options":"SAMEORIGIN","Link":"<https://api-staging.connectwisedev.com/v4_6_release/apis/3.0/c...
Get Contacts
Retrieve a comprehensive list of all contacts from ConnectWise Manage, including individuals associated with the service.
Endpoint
- URL: company/contacts
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
parameters.conditions | string | Optional | Parameters for the Get Contacts action |
parameters.childConditions | string | Optional | Parameters for the Get Contacts action |
parameters.orderBy | string | Optional | Parameters for the Get Contacts action |
parameters.fields | string | Optional | Parameters for the Get Contacts action |
parameters.page | number | Optional | Parameters for the Get Contacts action |
parameters.pageId | number | Optional | Parameters for the Get Contacts action |
parameters.pageSize | number | Optional | Parameters for the Get Contacts action |
parameters.customFieldConditions | string | Optional | Parameters for the Get Contacts action |
Input Example
{"parameters":{"conditions":"board/name=Integration or summary=xyz or board/id in (3, 2, 4) or lastUpdated > [2016-08-20T18:04:26Z]","childConditions":"communicationItems/value like [email protected] AND communicationItems/communicationType=Email","orderBy":"applicationOrder asc","fields":"id,name,status/id","page":20,"pageId":1,"pageSize":20,"customFieldConditions":"caption='TomNumber' AND value !=null"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{"status_code":200,"response_headers":{"Content-Type":"application/json; charset=utf-8","Transfer-Encoding":"chunked","Connection":"keep-alive","Date":"Mon, 04 Dec 2023 10:01:43 GMT","Cache-Control":"no-cache","Pragma":"no-cache","Expires":"-1","Strict-Transport-Security":"max-age=31536000; includeSubDomains","x-server-name":"IP-0A0A01E4","x-cw-request-id":"738a4ff5-61a7-4889-b3ba-ddd0db0df5ef","x-frame-options":"SAMEORIGIN","Link":"<https://api-staging.connectwisedev.com/v4_6_release/apis/3.0/c...
Get Invoice By ID
Fetch a specific invoice from ConnectWise Manage using the provided invoice ID as a path parameter.
Endpoint
- URL: finance/invoices/{{id}}
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.id | number | Required | Parameters for the Get Invoice By ID action |
parameters.conditions | string | Optional | Parameters for the Get Invoice By ID action |
parameters.childConditions | string | Optional | Parameters for the Get Invoice By ID action |
parameters.orderBy | string | Optional | Parameters for the Get Invoice By ID action |
parameters.fields | string | Optional | Parameters for the Get Invoice By ID action |
parameters.page | number | Optional | Parameters for the Get Invoice By ID action |
parameters.pageId | number | Optional | Parameters for the Get Invoice By ID action |
parameters.pageSize | number | Optional | Parameters for the Get Invoice By ID action |
parameters.customFieldConditions | string | Optional | Parameters for the Get Invoice By ID action |
Input Example
{"parameters":{"conditions":"board/name=Integration or summary=xyz or board/id in (3, 2, 4) or lastUpdated > [2016-08-20T18:04:26Z]","childConditions":"communicationItems/value like [email protected] AND communicationItems/communicationType=Email","orderBy":"applicationOrder asc","fields":"id,name,status/id","page":20,"pageId":1,"pageSize":20,"customFieldConditions":"caption='TomNumber' AND value !=null"},"path_parameters":{"id":1}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
id | number | Unique identifier |
invoiceNumber | string | Output field: invoiceNumber |
type | string | Type of the resource |
status | object | Status value |
status.id | number | Unique identifier |
status.name | string | Name of the resource |
status._info | object | Status value |
status._info.additionalProp1 | string | Status value |
status._info.additionalProp2 | string | Status value |
status._info.additionalProp3 | string | Status value |
company | object | Output field: company |
company.id | number | Unique identifier |
company.identifier | string | Unique identifier |
company.name | string | Name of the resource |
company._info | object | Output field: company._info |
company._info.additionalProp1 | string | Output field: company._info.additionalProp1 |
company._info.additionalProp2 | string | Output field: company._info.additionalProp2 |
company._info.additionalProp3 | string | Output field: company._info.additionalProp3 |
billToCompany | object | Output field: billToCompany |
billToCompany.id | number | Unique identifier |
billToCompany.identifier | string | Unique identifier |
billToCompany.name | string | Name of the resource |
billToCompany._info | object | Output field: billToCompany._info |
billToCompany._info.additionalProp1 | string | Output field: billToCompany._info.additionalProp1 |
Output Example
{"status_code":200,"response_headers":{"Content-Type":"application/json; charset=utf-8","Transfer-Encoding":"chunked","Connection":"keep-alive","Date":"Mon, 04 Dec 2023 10:01:43 GMT","Cache-Control":"no-cache","Pragma":"no-cache","Expires":"-1","Strict-Transport-Security":"max-age=31536000; includeSubDomains","x-server-name":"IP-0A0A01E4","x-cw-request-id":"738a4ff5-61a7-4889-b3ba-ddd0db0df5ef","x-frame-options":"SAMEORIGIN","Link":"<https://api-staging.connectwisedev.com/v4_6_release/apis/3.0/c...
Get Invoices
Retrieve all invoices from ConnectWise Manage to provide a comprehensive list of billing documents for review or processing.
Endpoint
- URL: finance/invoices
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
parameters.parameters.conditions | string | Optional | Parameters for the Get Invoices action |
parameters.parameters.childConditions | string | Optional | Parameters for the Get Invoices action |
parameters.parameters.orderBy | string | Optional | Parameters for the Get Invoices action |
parameters.parameters.fields | string | Optional | Parameters for the Get Invoices action |
parameters.parameters.page | number | Optional | Parameters for the Get Invoices action |
parameters.parameters.pageId | number | Optional | Parameters for the Get Invoices action |
parameters.parameters.pageSize | number | Optional | Parameters for the Get Invoices action |
parameters.parameters.customFieldConditions | string | Optional | Parameters for the Get Invoices action |
Input Example
{"parameters":{"parameters":{"conditions":"board/name=Integration or summary=xyz or board/id in (3, 2, 4) or lastUpdated > [2016-08-20T18:04:26Z]","childConditions":"communicationItems/value like [email protected] AND communicationItems/communicationType=Email","orderBy":"applicationOrder asc","fields":"id,name,status/id","page":20,"pageId":1,"pageSize":20,"customFieldConditions":"caption='TomNumber' AND value !=null"}}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
Output Example
{"status_code":200,"response_headers":{"Content-Type":"application/json; charset=utf-8","Transfer-Encoding":"chunked","Connection":"keep-alive","Date":"Mon, 04 Dec 2023 10:03:39 GMT","Cache-Control":"no-cache","Pragma":"no-cache","Expires":"-1","Strict-Transport-Security":"max-age=31536000; includeSubDomains","x-server-name":"IP-0A0A0134","x-cw-request-id":"3d48a108-bdfe-4ca7-8372-3719b0e4c80c","x-frame-options":"SAMEORIGIN","Link":"<https://api-staging.connectwisedev.com/v4_6_release/apis/3.0/c...
Get Service Board By ID
Retrieve detailed information for a specific Service Board in ConnectWise Manage using its unique ID.
Endpoint
- URL: service/boards/{{id}}
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.id | number | Required | Parameters for the Get Service Board By ID action |
parameters.conditions | string | Optional | Parameters for the Get Service Board By ID action |
parameters.childConditions | string | Optional | Parameters for the Get Service Board By ID action |
parameters.orderBy | string | Optional | Parameters for the Get Service Board By ID action |
parameters.fields | string | Optional | Parameters for the Get Service Board By ID action |
parameters.page | number | Optional | Parameters for the Get Service Board By ID action |
parameters.pageId | number | Optional | Parameters for the Get Service Board By ID action |
parameters.pageSize | number | Optional | Parameters for the Get Service Board By ID action |
parameters.customFieldConditions | string | Optional | Parameters for the Get Service Board By ID action |
Input Example
{"parameters":{"conditions":"board/name=Integration or summary=xyz or board/id in (3, 2, 4) or lastUpdated > [2016-08-20T18:04:26Z]","childConditions":"communicationItems/value like [email protected] AND communicationItems/communicationType=Email","orderBy":"applicationOrder asc","fields":"id,name,status/id","page":1,"pageId":20,"pageSize":20,"customFieldConditions":"caption='TomNumber' AND value !=null"},"path_parameters":{"id":764}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
id | number | Unique identifier |
name | string | Name of the resource |
location | object | Output field: location |
location.id | number | Unique identifier |
location.name | string | Name of the resource |
location._info | object | Output field: location._info |
location._info.additionalProp1 | string | Output field: location._info.additionalProp1 |
location._info.additionalProp2 | string | Output field: location._info.additionalProp2 |
location._info.additionalProp3 | string | Output field: location._info.additionalProp3 |
department | object | Output field: department |
department.id | number | Unique identifier |
department.identifier | string | Unique identifier |
department.name | string | Name of the resource |
department._info | object | Output field: department._info |
department._info.additionalProp1 | string | Output field: department._info.additionalProp1 |
department._info.additionalProp2 | string | Output field: department._info.additionalProp2 |
department._info.additionalProp3 | string | Output field: department._info.additionalProp3 |
inactiveFlag | boolean | Output field: inactiveFlag |
signOffTemplate | object | Output field: signOffTemplate |
signOffTemplate.id | number | Unique identifier |
signOffTemplate.name | string | Name of the resource |
signOffTemplate._info | object | Output field: signOffTemplate._info |
signOffTemplate._info.additionalProp1 | string | Output field: signOffTemplate._info.additionalProp1 |
signOffTemplate._info.additionalProp2 | string | Output field: signOffTemplate._info.additionalProp2 |
Output Example
{"status_code":200,"response_headers":{"Content-Type":"application/json; charset=utf-8","Transfer-Encoding":"chunked","Connection":"keep-alive","Date":"Mon, 04 Dec 2023 10:03:39 GMT","Cache-Control":"no-cache","Pragma":"no-cache","Expires":"-1","Strict-Transport-Security":"max-age=31536000; includeSubDomains","x-server-name":"IP-0A0A0134","x-cw-request-id":"3d48a108-bdfe-4ca7-8372-3719b0e4c80c","x-frame-options":"SAMEORIGIN","Link":"<https://api-staging.connectwisedev.com/v4_6_release/apis/3.0/c...
Get Service Boards
Retrieve a list of service boards from ConnectWise Manage to provide an overview of available support resources.
Endpoint
- URL: service/boards
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
parameters.conditions | string | Optional | Parameters for the Get Service Boards action |
parameters.childConditions | string | Optional | Parameters for the Get Service Boards action |
parameters.orderBy | string | Optional | Parameters for the Get Service Boards action |
parameters.fields | string | Optional | Parameters for the Get Service Boards action |
parameters.page | number | Optional | Parameters for the Get Service Boards action |
parameters.pageId | number | Optional | Parameters for the Get Service Boards action |
parameters.pageSize | number | Optional | Parameters for the Get Service Boards action |
parameters.customFieldConditions | string | Optional | Parameters for the Get Service Boards action |
Input Example
{"parameters":{"conditions":"board/name=Integration or summary=xyz or board/id in (3, 2, 4) or lastUpdated > [2016-08-20T18:04:26Z]","childConditions":"communicationItems/value like [email protected] AND communicationItems/communicationType=Email","orderBy":"applicationOrder asc","fields":"id,name,status/id","page":1,"pageId":20,"pageSize":20,"customFieldConditions":"caption='TomNumber' AND value !=null"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
Output Example
{"status_code":200,"response_headers":{"Content-Type":"application/json; charset=utf-8","Transfer-Encoding":"chunked","Connection":"keep-alive","Date":"Mon, 04 Dec 2023 10:03:39 GMT","Cache-Control":"no-cache","Pragma":"no-cache","Expires":"-1","Strict-Transport-Security":"max-age=31536000; includeSubDomains","x-server-name":"IP-0A0A0134","x-cw-request-id":"3d48a108-bdfe-4ca7-8372-3719b0e4c80c","x-frame-options":"SAMEORIGIN","Link":"<https://api-staging.connectwisedev.com/v4_6_release/apis/3.0/c...
Get SLA
Retrieve all Service Level Agreements (SLAs) from ConnectWise Manage without requiring any input parameters.
Endpoint
- URL: service/SLAs
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
parameters.conditions | string | Optional | Parameters for the Get SLA action |
parameters.childConditions | string | Optional | Parameters for the Get SLA action |
parameters.orderBy | string | Optional | Parameters for the Get SLA action |
parameters.fields | string | Optional | Parameters for the Get SLA action |
parameters.page | number | Optional | Parameters for the Get SLA action |
parameters.pageId | number | Optional | Parameters for the Get SLA action |
parameters.pageSize | number | Optional | Parameters for the Get SLA action |
parameters.customFieldConditions | string | Optional | Parameters for the Get SLA action |
Input Example
{"parameters":{"conditions":"board/name=Integration or summary=xyz or board/id in (3, 2, 4) or lastUpdated > [2016-08-20T18:04:26Z]","childConditions":"communicationItems/value like [email protected] AND communicationItems/communicationType=Email","orderBy":"applicationOrder asc","fields":"id,name,status/id","page":20,"pageId":1,"pageSize":20,"customFieldConditions":"caption='TomNumber' AND value !=null"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
Output Example
{"status_code":200,"response_headers":{"Content-Type":"application/json; charset=utf-8","Transfer-Encoding":"chunked","Connection":"keep-alive","Date":"Mon, 04 Dec 2023 10:03:39 GMT","Cache-Control":"no-cache","Pragma":"no-cache","Expires":"-1","Strict-Transport-Security":"max-age=31536000; includeSubDomains","x-server-name":"IP-0A0A0134","x-cw-request-id":"3d48a108-bdfe-4ca7-8372-3719b0e4c80c","x-frame-options":"SAMEORIGIN","Link":"<https://api-staging.connectwisedev.com/v4_6_release/apis/3.0/c...
Get SLA By ID
Retrieve detailed information about a specific Service Level Agreement (SLA) from ConnectWise Manage using its unique ID.
Endpoint
- URL: service/SLAs/{{id}}
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.id | number | Required | Parameters for the Get SLA By ID action |
parameters.conditions | string | Optional | Parameters for the Get SLA By ID action |
parameters.childConditions | string | Optional | Parameters for the Get SLA By ID action |
parameters.orderBy | string | Optional | Parameters for the Get SLA By ID action |
parameters.fields | string | Optional | Parameters for the Get SLA By ID action |
parameters.page | number | Optional | Parameters for the Get SLA By ID action |
parameters.pageId | number | Optional | Parameters for the Get SLA By ID action |
parameters.pageSize | number | Optional | Parameters for the Get SLA By ID action |
parameters.customFieldConditions | string | Optional | Parameters for the Get SLA By ID action |
Input Example
{"parameters":{"conditions":"board/name=Integration or summary=xyz or board/id in (3, 2, 4) or lastUpdated > [2016-08-20T18:04:26Z]","childConditions":"communicationItems/value like [email protected] AND communicationItems/communicationType=Email","orderBy":"applicationOrder asc","fields":"id,name,status/id","page":1,"pageId":20,"pageSize":20,"customFieldConditions":"caption='TomNumber' AND value !=null"},"path_parameters":{"id":764}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
id | number | Unique identifier |
name | string | Name of the resource |
basedOn | string | Output field: basedOn |
customCalendar | object | Output field: customCalendar |
customCalendar.id | number | Unique identifier |
customCalendar.name | string | Name of the resource |
customCalendar._info | object | Output field: customCalendar._info |
customCalendar._info.additionalProp1 | string | Output field: customCalendar._info.additionalProp1 |
customCalendar._info.additionalProp2 | string | Output field: customCalendar._info.additionalProp2 |
customCalendar._info.additionalProp3 | string | Output field: customCalendar._info.additionalProp3 |
defaultFlag | boolean | Output field: defaultFlag |
applicationOrder | number | Output field: applicationOrder |
hiImpactHiUrgency | object | Output field: hiImpactHiUrgency |
hiImpactHiUrgency.id | number | Unique identifier |
hiImpactHiUrgency.name | string | Name of the resource |
hiImpactHiUrgency.sort | number | Output field: hiImpactHiUrgency.sort |
hiImpactHiUrgency.level | string | Output field: hiImpactHiUrgency.level |
hiImpactHiUrgency._info | object | Output field: hiImpactHiUrgency._info |
hiImpactHiUrgency._info.additionalProp1 | string | Output field: hiImpactHiUrgency._info.additionalProp1 |
hiImpactHiUrgency._info.additionalProp2 | string | Output field: hiImpactHiUrgency._info.additionalProp2 |
hiImpactHiUrgency._info.additionalProp3 | string | Output field: hiImpactHiUrgency._info.additionalProp3 |
hiImpactMedUrgency | object | Output field: hiImpactMedUrgency |
hiImpactMedUrgency.id | number | Unique identifier |
hiImpactMedUrgency.name | string | Name of the resource |
Output Example
{"status_code":200,"response_headers":{"Content-Type":"application/json; charset=utf-8","Transfer-Encoding":"chunked","Connection":"keep-alive","Date":"Mon, 04 Dec 2023 10:03:39 GMT","Cache-Control":"no-cache","Pragma":"no-cache","Expires":"-1","Strict-Transport-Security":"max-age=31536000; includeSubDomains","x-server-name":"IP-0A0A0134","x-cw-request-id":"3d48a108-bdfe-4ca7-8372-3719b0e4c80c","x-frame-options":"SAMEORIGIN","Link":"<https://api-staging.connectwisedev.com/v4_6_release/apis/3.0/c...
Get Ticket By ID
Retrieve detailed information for a specific ticket in ConnectWise Manage using the ticket's unique ID.
Endpoint
- URL: service/tickets/{{id}}
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.id | number | Required | Parameters for the Get Ticket By ID action |
parameters.conditions | string | Optional | Parameters for the Get Ticket By ID action |
parameters.childConditions | string | Optional | Parameters for the Get Ticket By ID action |
parameters.orderBy | string | Optional | Parameters for the Get Ticket By ID action |
parameters.fields | string | Optional | Parameters for the Get Ticket By ID action |
parameters.page | number | Optional | Parameters for the Get Ticket By ID action |
parameters.pageId | number | Optional | Parameters for the Get Ticket By ID action |
parameters.pageSize | number | Optional | Parameters for the Get Ticket By ID action |
parameters.customFieldConditions | string | Optional | Parameters for the Get Ticket By ID action |
Input Example
{"parameters":{"conditions":"board/name=Integration or summary=xyz or board/id in (3, 2, 4) or lastUpdated > [2016-08-20T18:04:26Z]","childConditions":"communicationItems/value like [email protected] AND communicationItems/communicationType=Email","orderBy":"applicationOrder asc","fields":"id,name,status/id","page":1,"pageId":20,"pageSize":20,"customFieldConditions":"caption='TomNumber' AND value !=null"},"path_parameters":{"id":1047}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
id | number | Unique identifier |
summary | string | Output field: summary |
recordType | string | Type of the resource |
board | object | Output field: board |
board.id | number | Unique identifier |
board.name | string | Name of the resource |
board._info | object | Output field: board._info |
board._info.board_href | string | Output field: board._info.board_href |
status | object | Status value |
status.id | number | Unique identifier |
status.name | string | Name of the resource |
status.Sort | number | Status value |
status._info | object | Status value |
status._info.status_href | string | Status value |
company | object | Output field: company |
company.id | number | Unique identifier |
company.identifier | string | Unique identifier |
company.name | string | Name of the resource |
company._info | object | Output field: company._info |
company._info.company_href | string | Output field: company._info.company_href |
company._info.mobileGuid | string | Unique identifier |
site | object | Output field: site |
site.id | number | Unique identifier |
site.name | string | Name of the resource |
Output Example
{"status_code":200,"response_headers":{"Content-Type":"application/json; charset=utf-8","Transfer-Encoding":"chunked","Connection":"keep-alive","Date":"Mon, 04 Dec 2023 10:03:39 GMT","Cache-Control":"no-cache","Pragma":"no-cache","Expires":"-1","Strict-Transport-Security":"max-age=31536000; includeSubDomains","x-server-name":"IP-0A0A0134","x-cw-request-id":"3d48a108-bdfe-4ca7-8372-3719b0e4c80c","x-frame-options":"SAMEORIGIN","Link":"<https://api-staging.connectwisedev.com/v4_6_release/apis/3.0/c...
Get Ticket Notes
Retrieve all notes associated with a specific project ticket in ConnectWise Manage using the ticket's parent ID.
Endpoint
- URL: project/tickets/{{parentId}}/notes
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.parentId | number | Required | The project ticket ID to retrieve notes for. |
parameters.conditions | string | Optional | Parameters for the Get Ticket Notes action |
parameters.childConditions | string | Optional | Parameters for the Get Ticket Notes action |
parameters.customFieldConditions | string | Optional | Parameters for the Get Ticket Notes action |
parameters.orderBy | string | Optional | Parameters for the Get Ticket Notes action |
parameters.fields | string | Optional | Parameters for the Get Ticket Notes action |
parameters.page | number | Optional | Parameters for the Get Ticket Notes action |
parameters.pageId | number | Optional | Parameters for the Get Ticket Notes action |
parameters.pageSize | number | Optional | Parameters for the Get Ticket Notes action |
Input Example
{"parameters":{"conditions":"text like '*password*'","orderBy":"id desc","fields":"id,text,detailDescriptionFlag","page":1,"pageSize":25},"path_parameters":{"parentId":1047}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
Output Example
[]
Get Tickets
Retrieve all Service Desk tickets from ConnectWise Manage and provide a comprehensive list of support requests for review or further action.
Endpoint
- URL: service/tickets
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
parameters.conditions | string | Optional | Parameters for the Get Tickets action |
parameters.childConditions | string | Optional | Parameters for the Get Tickets action |
parameters.orderBy | string | Optional | Parameters for the Get Tickets action |
parameters.fields | string | Optional | Parameters for the Get Tickets action |
parameters.page | number | Optional | Parameters for the Get Tickets action |
parameters.pageId | number | Optional | Parameters for the Get Tickets action |
parameters.pageSize | number | Optional | Parameters for the Get Tickets action |
parameters.customFieldConditions | string | Optional | Parameters for the Get Tickets action |
Input Example
{"parameters":{"conditions":"board/name=Integration or summary=xyz or board/id in (3, 2, 4) or lastUpdated > [2016-08-20T18:04:26Z]","childConditions":"communicationItems/value like [email protected] AND communicationItems/communicationType=Email","orderBy":"applicationOrder asc","fields":"id,name,status/id","page":20,"pageId":1,"pageSize":20,"customFieldConditions":"caption='TomNumber' AND value !=null"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
Output Example
{"status_code":200,"response_headers":{"Content-Type":"application/json; charset=utf-8","Transfer-Encoding":"chunked","Connection":"keep-alive","Date":"Mon, 04 Dec 2023 10:03:39 GMT","Cache-Control":"no-cache","Pragma":"no-cache","Expires":"-1","Strict-Transport-Security":"max-age=31536000; includeSubDomains","x-server-name":"IP-0A0A0134","x-cw-request-id":"3d48a108-bdfe-4ca7-8372-3719b0e4c80c","x-frame-options":"SAMEORIGIN","Link":"<https://api-staging.connectwisedev.com/v4_6_release/apis/3.0/c...
Update Company By ID
Update the details of a specific company in ConnectWise Manage using its unique ID as a path parameter.
Endpoint
- URL: company/companies/{{id}}
- Method: PUT
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.id | number | Required | Parameters for the Update Company By ID action |
id | number | Optional | Unique identifier |
identifier | string | Optional | Unique identifier |
name | string | Optional | Name of the resource |
status | object | Optional | Status value |
status.id | number | Optional | Unique identifier |
status.name | string | Optional | Name of the resource |
status._info | object | Optional | Status value |
status._info.additionalProp1 | string | Optional | Status value |
status._info.additionalProp2 | string | Optional | Status value |
status._info.additionalProp3 | string | Optional | Status value |
addressLine1 | string | Optional | Parameter for Update Company By ID |
addressLine2 | string | Optional | Parameter for Update Company By ID |
city | string | Optional | Parameter for Update Company By ID |
state | string | Optional | Parameter for Update Company By ID |
zip | string | Optional | Parameter for Update Company By ID |
country | object | Optional | Parameter for Update Company By ID |
country.id | number | Optional | Unique identifier |
country.identifier | string | Optional | Unique identifier |
country.name | string | Optional | Name of the resource |
country._info | object | Optional | Parameter for Update Company By ID |
country._info.additionalProp1 | string | Optional | Parameter for Update Company By ID |
country._info.additionalProp2 | string | Optional | Parameter for Update Company By ID |
country._info.additionalProp3 | string | Optional | Parameter for Update Company By ID |
phoneNumber | string | Optional | Parameter for Update Company By ID |
Input Example
{"json_body":{"id":0,"identifier":"string","name":"string","status":{"id":0,"name":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"addressLine1":"string","addressLine2":"string","city":"string","state":"string","zip":"string","country":{"id":0,"identifier":"string","name":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"phoneNumber":"string","faxNumber":"string","website":"string","territory":{"id":0,"name":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"market":{"id":0,"name":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"accountNumber":"string","defaultContact":{"id":0,"name":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"dateAcquired":"2023-11-28T16:30:06Z","sicCode":{"id":0,"name":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"parentCompany":{"id":0,"identifier":"string","name":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"annualRevenue":0,"numberOfEmployees":0,"yearEstablished":0,"revenueYear":0,"ownershipType":{"id":0,"name":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"timeZoneSetup":{"id":0,"name":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"leadSource":"string","leadFlag":true,"unsubscribeFlag":true,"calendar":{"id":0,"name":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"userDefinedField1":"string","userDefinedField2":"string","userDefinedField3":"string","userDefinedField4":"string","userDefinedField5":"string","userDefinedField6":"string","userDefinedField7":"string","userDefinedField8":"string","userDefinedField9":"string","userDefinedField10":"string","vendorIdentifier":"string","taxIdentifier":"string","taxCode":{"id":0,"name":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"billingTerms":{"id":0,"name":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"invoiceTemplate":{"id":0,"name":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"pricingSchedule":{"id":0,"name":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"companyEntityType":{"id":0,"name":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"billToCompany":{"id":0,"identifier":"string","name":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"billingSite":{"id":0,"name":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"billingContact":{"id":0,"name":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"invoiceDeliveryMethod":{"id":0,"name":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"invoiceToEmailAddress":"string","invoiceCCEmailAddress":"string","deletedFlag":true,"dateDeleted":"2023-11-28T16:30:06Z","deletedBy":"string","mobileGuid":"3fa85f64-5717-4562-b3fc-2c963f66afa6","facebookUrl":"string","twitterUrl":"string","linkedInUrl":"string","currency":{"id":0,"symbol":"string","currencyCode":"string","decimalSeparator":"string","numberOfDecimals":0,"thousandsSeparator":"string","negativeParenthesesFlag":true,"displaySymbolFlag":true,"currencyIdentifier":"string","displayIdFlag":true,"rightAlign":true,"name":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"territoryManager":{"id":0,"identifier":"string","name":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"resellerIdentifier":"string","isVendorFlag":true,"types":[{"id":0,"name":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}}],"site":{"id":0,"name":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"integratorTags":["string"],"_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"},"customFields":[{"id":0,"caption":"string","type":"TextArea","entryMethod":"Date","numberOfDecimals":0,"value":{}}]},"path_parameters":{"id":20}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
id | number | Unique identifier |
identifier | string | Unique identifier |
name | string | Name of the resource |
status | object | Status value |
status.id | number | Unique identifier |
status.name | string | Name of the resource |
status._info | object | Status value |
status._info.additionalProp1 | string | Status value |
status._info.additionalProp2 | string | Status value |
status._info.additionalProp3 | string | Status value |
addressLine1 | string | Output field: addressLine1 |
addressLine2 | string | Output field: addressLine2 |
city | string | Output field: city |
state | string | Output field: state |
zip | string | Output field: zip |
country | object | Output field: country |
country.id | number | Unique identifier |
country.identifier | string | Unique identifier |
country.name | string | Name of the resource |
country._info | object | Output field: country._info |
country._info.additionalProp1 | string | Output field: country._info.additionalProp1 |
country._info.additionalProp2 | string | Output field: country._info.additionalProp2 |
country._info.additionalProp3 | string | Output field: country._info.additionalProp3 |
Output Example
{"status_code":200,"response_headers":{"Content-Type":"application/json; charset=utf-8","Transfer-Encoding":"chunked","Connection":"keep-alive","Date":"Mon, 04 Dec 2023 10:03:39 GMT","Cache-Control":"no-cache","Pragma":"no-cache","Expires":"-1","Strict-Transport-Security":"max-age=31536000; includeSubDomains","x-server-name":"IP-0A0A0134","x-cw-request-id":"3d48a108-bdfe-4ca7-8372-3719b0e4c80c","x-frame-options":"SAMEORIGIN","Link":"<https://api-staging.connectwisedev.com/v4_6_release/apis/3.0/c...
Update Contact By ID
Update an existing contact in ConnectWise Manage by specifying the unique contact ID as a path parameter.
Endpoint
- URL: company/contacts/{{id}}
- Method: PUT
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.id | number | Required | Parameters for the Update Contact By ID action |
parameters.firstName | string | Optional | Parameters for the Update Contact By ID action |
parameters.lastName | string | Optional | Parameters for the Update Contact By ID action |
parameters.company | object | Optional | Parameters for the Update Contact By ID action |
parameters.company.id | number | Optional | Parameters for the Update Contact By ID action |
parameters.company.identifier | string | Optional | Parameters for the Update Contact By ID action |
parameters.company.name | string | Optional | Parameters for the Update Contact By ID action |
parameters.company._info | object | Optional | Parameters for the Update Contact By ID action |
parameters.company._info.company_href | string | Optional | Parameters for the Update Contact By ID action |
parameters.company._info.mobileGuid | string | Optional | Parameters for the Update Contact By ID action |
parameters.site | object | Optional | Parameters for the Update Contact By ID action |
parameters.site.id | number | Optional | Parameters for the Update Contact By ID action |
parameters.site.name | string | Optional | Parameters for the Update Contact By ID action |
parameters.site._info | object | Optional | Parameters for the Update Contact By ID action |
parameters.site._info.site_href | string | Optional | Parameters for the Update Contact By ID action |
parameters.site._info.mobileGuid | string | Optional | Parameters for the Update Contact By ID action |
parameters.inactiveFlag | boolean | Optional | Parameters for the Update Contact By ID action |
parameters.title | string | Optional | Parameters for the Update Contact By ID action |
parameters.marriedFlag | boolean | Optional | Parameters for the Update Contact By ID action |
parameters.childrenFlag | boolean | Optional | Parameters for the Update Contact By ID action |
parameters.unsubscribeFlag | boolean | Optional | Parameters for the Update Contact By ID action |
parameters.mobileGuid | string | Optional | Parameters for the Update Contact By ID action |
parameters.defaultPhoneType | string | Optional | Parameters for the Update Contact By ID action |
parameters.defaultPhoneNbr | string | Optional | Parameters for the Update Contact By ID action |
parameters.defaultPhoneExtension | string | Optional | Parameters for the Update Contact By ID action |
Input Example
{"parameters":{"firstName":"Gordon","lastName":"Packard","company":{"id":6,"identifier":"BlueLightCo","name":"Blue Light, Co.","_info":{"company_href":"https://api-staging.connectwisedev.com/v4_6_release/apis/3.0//company/companies/6","mobileGuid":"f9ff4363-7b48-4ebb-b6e4-cc69250b7697"}},"site":{"id":5,"name":"Main","_info":{"site_href":"https://api-staging.connectwisedev.com/v4_6_release/apis/3.0//company/companies/6/sites/5","mobileGuid":"c15cf504-4a98-47c0-bcf9-749f6d2a676e"}},"inactiveFlag":false,"title":"Packard","marriedFlag":false,"childrenFlag":false,"unsubscribeFlag":false,"mobileGuid":"658f698f-5e7f-4636-9230-a2b4813e11a2","defaultPhoneType":"Direct","defaultPhoneNbr":"8132986178","defaultPhoneExtension":"11","defaultBillingFlag":false,"defaultFlag":true,"companyLocation":{"id":38,"name":"Corporate","_info":{"location_href":"https://api-staging.connectwisedev.com/v4_6_release/apis/3.0//system/locations/38"}},"communicationItems":[{"id":34,"type":{"id":2,"name":"Direct","_info":{"type_href":"https://api-staging.connectwisedev.com/v4_6_release/apis/3.0//company/communicationTypes/2"}},"value":"8132986100","extension":"11","defaultFlag":true,"communicationType":"Phone"},{"id":35,"type":{"id":1,"name":"Email","_info":{"type_href":"https://api-staging.connectwisedev.com/v4_6_release/apis/3.0//company/communicationTypes/1"}},"value":"[email protected]","extension":"","defaultFlag":true,"domain":"@bluelight.com","communicationType":"Email"}],"types":[],"ignoreDuplicates":false,"_info":{"lastUpdated":"2005-03-21T15:43:44Z","updatedBy":"Import1","communications_href":"https://api-staging.connectwisedev.com/v4_6_release/apis/3.0//company/contacts/15/communications","notes_href":"https://api-staging.connectwisedev.com/v4_6_release/apis/3.0//company/contacts/15/notes","tracks_href":"https://api-staging.connectwisedev.com/v4_6_release/apis/3.0//company/contacts/15/tracks","portalSecurity_href":"https://api-staging.connectwisedev.com/v4_6_release/apis/3.0//company/contacts/15/portalSecurity","activities_href":"https://api-staging.connectwisedev.com/v4_6_release/apis/3.0//sales/activities?conditions=contact/id=15","documents_href":"https://api-staging.connectwisedev.com/v4_6_release/apis/3.0//system/documents?recordType=Contact&recordId=15","configurations_href":"https://api-staging.connectwisedev.com/v4_6_release/apis/3.0//company/configurations?conditions=contact/id=15","tickets_href":"https://api-staging.connectwisedev.com/v4_6_release/apis/3.0//service/tickets?conditions=contact/id=15","opportunities_href":"https://api-staging.connectwisedev.com/v4_6_release/apis/3.0//sales/opportunities?conditions=contact/id=15","projects_href":"https://api-staging.connectwisedev.com/v4_6_release/apis/3.0//project/projects?conditions=contact/id=15","image_href":"https://api-staging.connectwisedev.com/v4_6_release/apis/3.0//company/contacts/15/image?lastModified=2005-03-21T15:43:44Z"}},"path_parameters":{"id":15}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
id | number | Unique identifier |
firstName | string | Name of the resource |
lastName | string | Name of the resource |
company | object | Output field: company |
company.id | number | Unique identifier |
company.identifier | string | Unique identifier |
company.name | string | Name of the resource |
company._info | object | Output field: company._info |
company._info.additionalProp1 | string | Output field: company._info.additionalProp1 |
company._info.additionalProp2 | string | Output field: company._info.additionalProp2 |
company._info.additionalProp3 | string | Output field: company._info.additionalProp3 |
site | object | Output field: site |
site.id | number | Unique identifier |
site.name | string | Name of the resource |
site._info | object | Output field: site._info |
site._info.additionalProp1 | string | Output field: site._info.additionalProp1 |
site._info.additionalProp2 | string | Output field: site._info.additionalProp2 |
site._info.additionalProp3 | string | Output field: site._info.additionalProp3 |
addressLine1 | string | Output field: addressLine1 |
addressLine2 | string | Output field: addressLine2 |
city | string | Output field: city |
state | string | Output field: state |
zip | string | Output field: zip |
country | object | Output field: country |
Output Example
{"status_code":200,"response_headers":{"Content-Type":"application/json; charset=utf-8","Transfer-Encoding":"chunked","Connection":"keep-alive","Date":"Mon, 04 Dec 2023 10:01:43 GMT","Cache-Control":"no-cache","Pragma":"no-cache","Expires":"-1","Strict-Transport-Security":"max-age=31536000; includeSubDomains","x-server-name":"IP-0A0A01E4","x-cw-request-id":"738a4ff5-61a7-4889-b3ba-ddd0db0df5ef","x-frame-options":"SAMEORIGIN","Link":"<https://api-staging.connectwisedev.com/v4_6_release/apis/3.0/c...
Update Invoice
Update an existing invoice in ConnectWise Manage by specifying the invoice ID as a path parameter.
Endpoint
- URL: finance/invoices/{{id}}
- Method: PUT
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.id | number | Required | Parameters for the Update Invoice action |
parameters.id | number | Optional | Parameters for the Update Invoice action |
parameters.invoiceNumber | string | Optional | Parameters for the Update Invoice action |
parameters.type | string | Optional | Parameters for the Update Invoice action |
parameters.status | object | Optional | Parameters for the Update Invoice action |
parameters.status.id | number | Optional | Parameters for the Update Invoice action |
parameters.status.name | string | Optional | Parameters for the Update Invoice action |
parameters.status._info | object | Optional | Parameters for the Update Invoice action |
parameters.status._info.additionalProp1 | string | Optional | Parameters for the Update Invoice action |
parameters.status._info.additionalProp2 | string | Optional | Parameters for the Update Invoice action |
parameters.status._info.additionalProp3 | string | Optional | Parameters for the Update Invoice action |
parameters.company | object | Optional | Parameters for the Update Invoice action |
parameters.company.id | number | Optional | Parameters for the Update Invoice action |
parameters.company.identifier | string | Optional | Parameters for the Update Invoice action |
parameters.company.name | string | Optional | Parameters for the Update Invoice action |
parameters.company._info | object | Optional | Parameters for the Update Invoice action |
parameters.company._info.additionalProp1 | string | Optional | Parameters for the Update Invoice action |
parameters.company._info.additionalProp2 | string | Optional | Parameters for the Update Invoice action |
parameters.company._info.additionalProp3 | string | Optional | Parameters for the Update Invoice action |
parameters.billToCompany | object | Optional | Parameters for the Update Invoice action |
parameters.billToCompany.id | number | Optional | Parameters for the Update Invoice action |
parameters.billToCompany.identifier | string | Optional | Parameters for the Update Invoice action |
parameters.billToCompany.name | string | Optional | Parameters for the Update Invoice action |
parameters.billToCompany._info | object | Optional | Parameters for the Update Invoice action |
parameters.billToCompany._info.additionalProp1 | string | Optional | Parameters for the Update Invoice action |
Input Example
{"parameters":{"id":7,"invoiceNumber":"string","type":"Agreement","status":{"id":0,"name":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"company":{"id":0,"identifier":"string","name":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"billToCompany":{"id":0,"identifier":"string","name":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"shipToCompany":{"id":0,"identifier":"string","name":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"accountNumber":"string","applyToType":"All","applyToId":0,"attention":"string","shipToAttention":"string","billingSite":{"id":0,"name":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"billingSiteAddressLine1":"string","billingSiteAddressLine2":"string","billingSiteCity":"string","billingSiteState":"string","billingSiteZip":"string","billingSiteCountry":"string","shippingSite":{"id":0,"name":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"shippingSiteAddressLine1":"string","shippingSiteAddressLine2":"string","shippingSiteCity":"string","shippingSiteState":"string","shippingSiteZip":"string","shippingSiteCountry":"string","billingTerms":{"id":0,"name":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"reference":"string","customerPO":"string","templateSetupId":0,"invoiceTemplate":{"id":0,"name":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"emailTemplateId":0,"addToBatchEmailList":true,"date":"2023-11-28T09:30:59Z","restrictDownpaymentFlag":true,"locationId":0,"departmentId":0,"territoryId":0,"topComment":"string","bottomComment":"string","taxableFlag":true,"taxCode":{"id":0,"name":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"internalNotes":"string","downpaymentPreviouslyTaxedFlag":true,"serviceTotal":0,"overrideDownPaymentAmountFlag":true,"currency":{"id":0,"symbol":"string","currencyCode":"string","decimalSeparator":"string","numberOfDecimals":0,"thousandsSeparator":"string","negativeParenthesesFlag":true,"displaySymbolFlag":true,"currencyIdentifier":"string","displayIdFlag":true,"rightAlign":true,"name":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"dueDate":"2023-11-28T09:30:59Z","expenseTotal":0,"productTotal":0,"previousProgressApplied":0,"serviceAdjustmentAmount":0,"agreementAmount":0,"downpaymentApplied":0,"subtotal":0,"total":0,"remainingDownpayment":0,"salesTax":0,"adjustmentReason":"string","adjustedBy":"string","payments":0,"credits":0,"balance":0,"specialInvoiceFlag":true,"billingSetupReference":{"id":0,"name":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"ticket":{"id":0,"summary":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"project":{"id":0,"name":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"phase":{"id":0,"name":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"salesOrder":{"id":0,"identifier":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"agreement":{"id":0,"name":"string","type":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"},"customFields":[{"id":0,"caption":"string","type":"TextArea","entryMethod":"Date","numberOfDecimals":0,"value":{}}]},"path_parameters":{"id":7}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
id | number | Unique identifier |
invoiceNumber | string | Output field: invoiceNumber |
type | string | Type of the resource |
status | object | Status value |
status.id | number | Unique identifier |
status.name | string | Name of the resource |
status._info | object | Status value |
status._info.additionalProp1 | string | Status value |
status._info.additionalProp2 | string | Status value |
status._info.additionalProp3 | string | Status value |
company | object | Output field: company |
company.id | number | Unique identifier |
company.identifier | string | Unique identifier |
company.name | string | Name of the resource |
company._info | object | Output field: company._info |
company._info.additionalProp1 | string | Output field: company._info.additionalProp1 |
company._info.additionalProp2 | string | Output field: company._info.additionalProp2 |
company._info.additionalProp3 | string | Output field: company._info.additionalProp3 |
billToCompany | object | Output field: billToCompany |
billToCompany.id | number | Unique identifier |
billToCompany.identifier | string | Unique identifier |
billToCompany.name | string | Name of the resource |
billToCompany._info | object | Output field: billToCompany._info |
billToCompany._info.additionalProp1 | string | Output field: billToCompany._info.additionalProp1 |
Output Example
{"status_code":200,"response_headers":{"Content-Type":"application/json; charset=utf-8","Transfer-Encoding":"chunked","Connection":"keep-alive","Date":"Mon, 04 Dec 2023 10:01:43 GMT","Cache-Control":"no-cache","Pragma":"no-cache","Expires":"-1","Strict-Transport-Security":"max-age=31536000; includeSubDomains","x-server-name":"IP-0A0A01E4","x-cw-request-id":"738a4ff5-61a7-4889-b3ba-ddd0db0df5ef","x-frame-options":"SAMEORIGIN","Link":"<https://api-staging.connectwisedev.com/v4_6_release/apis/3.0/c...
Update Service Board
Update a specific service board in ConnectWise Manage by providing the required board ID.
Endpoint
- URL: service/boards/{{id}}
- Method: PUT
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.id | number | Required | Parameters for the Update Service Board action |
parameters.id | number | Optional | Parameters for the Update Service Board action |
parameters.name | string | Optional | Parameters for the Update Service Board action |
parameters.location | object | Optional | Parameters for the Update Service Board action |
parameters.location.id | number | Optional | Parameters for the Update Service Board action |
parameters.location.name | string | Optional | Parameters for the Update Service Board action |
parameters.location._info | object | Optional | Parameters for the Update Service Board action |
parameters.location._info.additionalProp1 | string | Optional | Parameters for the Update Service Board action |
parameters.location._info.additionalProp2 | string | Optional | Parameters for the Update Service Board action |
parameters.location._info.additionalProp3 | string | Optional | Parameters for the Update Service Board action |
parameters.department | object | Optional | Parameters for the Update Service Board action |
parameters.department.id | number | Optional | Parameters for the Update Service Board action |
parameters.department.identifier | string | Optional | Parameters for the Update Service Board action |
parameters.department.name | string | Optional | Parameters for the Update Service Board action |
parameters.department._info | object | Optional | Parameters for the Update Service Board action |
parameters.department._info.additionalProp1 | string | Optional | Parameters for the Update Service Board action |
parameters.department._info.additionalProp2 | string | Optional | Parameters for the Update Service Board action |
parameters.department._info.additionalProp3 | string | Optional | Parameters for the Update Service Board action |
parameters.inactiveFlag | boolean | Optional | Parameters for the Update Service Board action |
parameters.signOffTemplate | object | Optional | Parameters for the Update Service Board action |
parameters.signOffTemplate.id | number | Optional | Parameters for the Update Service Board action |
parameters.signOffTemplate.name | string | Optional | Parameters for the Update Service Board action |
parameters.signOffTemplate._info | object | Optional | Parameters for the Update Service Board action |
parameters.signOffTemplate._info.additionalProp1 | string | Optional | Parameters for the Update Service Board action |
parameters.signOffTemplate._info.additionalProp2 | string | Optional | Parameters for the Update Service Board action |
Input Example
{"parameters":{"id":0,"name":"string","location":{"id":0,"name":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"department":{"id":0,"identifier":"string","name":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"inactiveFlag":true,"signOffTemplate":{"id":0,"name":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"sendToContactFlag":true,"contactTemplate":{"id":0,"identifier":"string","name":"string","type":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"sendToResourceFlag":true,"resourceTemplate":{"id":0,"identifier":"string","name":"string","type":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"projectFlag":true,"showDependenciesFlag":true,"showEstimatesFlag":true,"boardIcon":{"id":0,"name":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"billTicketsAfterClosedFlag":true,"billTicketSeparatelyFlag":true,"billUnapprovedTimeExpenseFlag":true,"overrideBillingSetupFlag":true,"dispatchMember":{"id":0,"identifier":"string","name":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"serviceManagerMember":{"id":0,"identifier":"string","name":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"dutyManagerMember":{"id":0,"identifier":"string","name":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"oncallMember":{"id":0,"identifier":"string","name":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"workRole":{"id":0,"name":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"workType":{"id":0,"name":"string","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"billTime":"Billable","billExpense":"Billable","billProduct":"Billable","autoCloseStatus":{"id":0,"name":"string","sort":0,"_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"autoAssignNewTicketsFlag":true,"autoAssignNewECTicketsFlag":true,"autoAssignNewPortalTicketsFlag":true,"discussionsLockedFlag":true,"timeEntryLockedFlag":true,"notifyEmailFrom":"string","notifyEmailFromName":"string","closedLoopDiscussionsFlag":true,"closedLoopResolutionFlag":true,"closedLoopInternalAnalysisFlag":true,"timeEntryDiscussionFlag":true,"timeEntryResolutionFlag":true,"timeEntryInternalAnalysisFlag":true,"problemSort":"Ascending","resolutionSort":"Ascending","internalAnalysisSort":"Ascending","emailConnectorAllowReopenClosedFlag":true,"emailConnectorReopenStatus":{"id":0,"name":"string","sort":0,"_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"emailConnectorReopenResourcesFlag":true,"emailConnectorNewTicketNoMatchFlag":true,"emailConnectorNeverReopenByDaysFlag":true,"emailConnectorReopenDaysLimit":0,"emailConnectorNeverReopenByDaysClosedFlag":true,"emailConnectorReopenDaysClosedLimit":0,"useMemberDisplayNameFlag":true,"sendToCCFlag":true,"autoAssignTicketOwnerFlag":true,"autoAssignLimitFlag":true,"autoAssignLimitAmount":0,"closedLoopAllFlag":true,"percentageCalculation":"ActualHours","allSort":"Ascending","markFirstNoteIssueFlag":true,"restrictBoardByDefaultFlag":true,"_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"path_parameters":{"id":1}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
id | number | Unique identifier |
name | string | Name of the resource |
location | object | Output field: location |
location.id | number | Unique identifier |
location.name | string | Name of the resource |
location._info | object | Output field: location._info |
location._info.additionalProp1 | string | Output field: location._info.additionalProp1 |
location._info.additionalProp2 | string | Output field: location._info.additionalProp2 |
location._info.additionalProp3 | string | Output field: location._info.additionalProp3 |
department | object | Output field: department |
department.id | number | Unique identifier |
department.identifier | string | Unique identifier |
department.name | string | Name of the resource |
department._info | object | Output field: department._info |
department._info.additionalProp1 | string | Output field: department._info.additionalProp1 |
department._info.additionalProp2 | string | Output field: department._info.additionalProp2 |
department._info.additionalProp3 | string | Output field: department._info.additionalProp3 |
inactiveFlag | boolean | Output field: inactiveFlag |
signOffTemplate | object | Output field: signOffTemplate |
signOffTemplate.id | number | Unique identifier |
signOffTemplate.name | string | Name of the resource |
signOffTemplate._info | object | Output field: signOffTemplate._info |
signOffTemplate._info.additionalProp1 | string | Output field: signOffTemplate._info.additionalProp1 |
signOffTemplate._info.additionalProp2 | string | Output field: signOffTemplate._info.additionalProp2 |
Output Example
{"status_code":200,"response_headers":{"Content-Type":"application/json; charset=utf-8","Transfer-Encoding":"chunked","Connection":"keep-alive","Date":"Mon, 04 Dec 2023 10:03:39 GMT","Cache-Control":"no-cache","Pragma":"no-cache","Expires":"-1","Strict-Transport-Security":"max-age=31536000; includeSubDomains","x-server-name":"IP-0A0A0134","x-cw-request-id":"3d48a108-bdfe-4ca7-8372-3719b0e4c80c","x-frame-options":"SAMEORIGIN","Link":"<https://api-staging.connectwisedev.com/v4_6_release/apis/3.0/c...
Update SLA By ID
Update a specific Service Level Agreement in ConnectWise Manage using JSON Patch operations and the provided SLA ID.
Endpoint
- URL: service/SLAs/{{id}}
- Method: PATCH
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.id | number | Required | Parameters for the Update SLA By ID action |
Input Example
{"json_body":[{"op":"replace","path":"name","value":"Updated SLA Name"},{"op":"replace","path":"basedOn","value":"AllHours"},{"op":"replace","path":"respondHours","value":2}],"path_parameters":{"id":1}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
id | number | Unique identifier |
name | string | Name of the resource |
basedOn | string | Output field: basedOn |
customCalendar | object | Output field: customCalendar |
customCalendar.id | number | Unique identifier |
customCalendar.name | string | Name of the resource |
customCalendar._info | object | Output field: customCalendar._info |
customCalendar._info.additionalProp1 | string | Output field: customCalendar._info.additionalProp1 |
customCalendar._info.additionalProp2 | string | Output field: customCalendar._info.additionalProp2 |
customCalendar._info.additionalProp3 | string | Output field: customCalendar._info.additionalProp3 |
defaultFlag | boolean | Output field: defaultFlag |
applicationOrder | number | Output field: applicationOrder |
hiImpactHiUrgency | object | Output field: hiImpactHiUrgency |
hiImpactHiUrgency.id | number | Unique identifier |
hiImpactHiUrgency.name | string | Name of the resource |
hiImpactHiUrgency.sort | number | Output field: hiImpactHiUrgency.sort |
hiImpactHiUrgency.level | string | Output field: hiImpactHiUrgency.level |
hiImpactHiUrgency._info | object | Output field: hiImpactHiUrgency._info |
hiImpactHiUrgency._info.additionalProp1 | string | Output field: hiImpactHiUrgency._info.additionalProp1 |
hiImpactHiUrgency._info.additionalProp2 | string | Output field: hiImpactHiUrgency._info.additionalProp2 |
hiImpactHiUrgency._info.additionalProp3 | string | Output field: hiImpactHiUrgency._info.additionalProp3 |
hiImpactMedUrgency | object | Output field: hiImpactMedUrgency |
hiImpactMedUrgency.id | number | Unique identifier |
hiImpactMedUrgency.name | string | Name of the resource |
Output Example
{"status_code":200,"response_headers":{"Content-Type":"application/json; charset=utf-8","Transfer-Encoding":"chunked","Connection":"keep-alive","Date":"Mon, 04 Dec 2023 10:03:39 GMT","Cache-Control":"no-cache","Pragma":"no-cache","Expires":"-1","Strict-Transport-Security":"max-age=31536000; includeSubDomains","x-server-name":"IP-0A0A0134","x-cw-request-id":"3d48a108-bdfe-4ca7-8372-3719b0e4c80c","x-frame-options":"SAMEORIGIN","Link":"<https://api-staging.connectwisedev.com/v4_6_release/apis/3.0/c...
Update Ticket By ID
Update a specific ticket in ConnectWise Manage using JSON Patch operations by providing the ticket ID as a path parameter.
Endpoint
- URL: service/tickets/{{id}}
- Method: PATCH
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.id | number | Required | Parameters for the Update Ticket By ID action |
Input Example
{"json_body":[{"op":"replace","path":"summary"},{"op":"replace","path":"company"},{"op":"replace","path":"customFields"}]}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
id | number | Unique identifier |
summary | string | Output field: summary |
recordType | string | Type of the resource |
board | object | Output field: board |
board.id | number | Unique identifier |
board.name | string | Name of the resource |
board._info | object | Output field: board._info |
board._info.additionalProp1 | string | Output field: board._info.additionalProp1 |
board._info.additionalProp2 | string | Output field: board._info.additionalProp2 |
board._info.additionalProp3 | string | Output field: board._info.additionalProp3 |
status | object | Status value |
status.id | number | Unique identifier |
status.name | string | Name of the resource |
status.sort | number | Status value |
status._info | object | Status value |
status._info.additionalProp1 | string | Status value |
status._info.additionalProp2 | string | Status value |
status._info.additionalProp3 | string | Status value |
workRole | object | Output field: workRole |
workRole.id | number | Unique identifier |
workRole.name | string | Name of the resource |
workRole._info | object | Output field: workRole._info |
workRole._info.additionalProp1 | string | Output field: workRole._info.additionalProp1 |
workRole._info.additionalProp2 | string | Output field: workRole._info.additionalProp2 |
Output Example
{"id":123,"summary":"string","recordType":"string","board":{"id":123,"name":"Example Name","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"status":{"id":123,"name":"Example Name","sort":123,"_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"workRole":{"id":123,"name":"Example Name","_info":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"workType":{"id":123,"name":"Example N...
Response Headers
Header | Description | Example |
|---|---|---|
api-current-version | HTTP response header: api-current-version | 2022.2 |
Cache-Control | Directives for caching mechanisms | no-cache |
Connection | HTTP response header: Connection | keep-alive |
Content-Encoding | HTTP response header: Content-Encoding | gzip |
Content-Security-Policy | HTTP response header: Content-Security-Policy | frame-ancestors 'self' blob: *.myconnectwise.net *.connectwisedev.com *.itboost.com; default-src 'self' 'unsafe-inline' 'unsafe-eval' blob: *.walkme.com *.connectwise *.connectwise.com az416426.vo.msecnd.net dc.services.visualstudio.com/v2/track *.connectwisedev.com *.myconnectwise.net cwview.com *.cwview.com *.wise-pay.com *.wise-sync.com;style-src 'self' 'unsafe-inline' fonts.googleapis.com files.connectwise.com *.itsupport247.net *.myconnectwise.net; font-src 'self' 'unsafe-inline' 'unsafe-eval' data: *.walkme.com *.connectwise.com *.googleapis.com; img-src * data: snapshot:; frame-src * data: mailto:; connect-src 'self' *.walkme.com *.connectwise.com *.connectwisedev.com *.myconnectwise.net .itsupport247.net cwview.com .cwview.com dc.services.visualstudio.com/v2/track cheetah quotewerks:// wss://.amazonaws.com; script-src 'self' 'unsafe-inline' 'unsafe-eval' *.connectwise.com *.connectwisedev.com *.myconnectwise.net cwview.com *.cwview.com *.walkme.com *.cwnet.io *.itsupport247.net |
Content-Type | The media type of the resource | application/json; charset=utf-8 |
Date | The date and time at which the message was originated | Mon, 04 Dec 2023 10:03:39 GMT |
Expires | The date/time after which the response is considered stale | -1 |
Link | HTTP response header: Link | |
Pragma | HTTP response header: Pragma | no-cache |
Referrer-Policy | HTTP response header: Referrer-Policy | strict-origin-when-cross-origin |
Strict-Transport-Security | HTTP response header: Strict-Transport-Security | max-age=31536000; includeSubDomains |
Transfer-Encoding | HTTP response header: Transfer-Encoding | chunked |
Vary | HTTP response header: Vary | Accept-Encoding |
Via | HTTP response header: Via | 1.1 e2f0e515fccd91a9016d3b4c96302db6.cloudfront.net (CloudFront) |
X-Amz-Cf-Id | HTTP response header: X-Amz-Cf-Id | LOoAm5NEy6CQTTJaMXiXyRCBGtp-QlTUQwl-823-dOliyHnuoL9Igw== |
X-Amz-Cf-Pop | HTTP response header: X-Amz-Cf-Pop | CCU50-C1 |
X-AspNet-Version | HTTP response header: X-AspNet-Version | 4.0.30319 |
X-Cache | HTTP response header: X-Cache | Miss from cloudfront |
X-Content-Type-Options | HTTP response header: X-Content-Type-Options | nosniff |
x-cw-request-id | HTTP response header: x-cw-request-id | 3d48a108-bdfe-4ca7-8372-3719b0e4c80c |
x-frame-options | HTTP response header: x-frame-options | SAMEORIGIN |
x-server-name | HTTP response header: x-server-name | IP-0A0A01E4 |
X-Xss-Protection | HTTP response header: X-Xss-Protection | 1; mode=block |