--- title: "Modify details of a completed audit" method: PUT path: "/subscribers/current/siteaudit/completed" tags: ["SiteAudit"] --- # Modify details of a completed audit `PUT /subscribers/current/siteaudit/completed` ## Request - Base URL: `https://sb2api.servicechannel.com/v3` - URL: `https://sb2api.servicechannel.com/v3/subscribers/current/siteaudit/completed` - Auth: OAuth 2 - Authorization code: `https://sb2login.servicechannel.com/oauth/authorize` - Token URL: `https://sb2login.servicechannel.com/oauth/token` - TypeScript: (a function with typed inputs; its response is checked against the schema) Allows users to update, delete, and add information for completed site audits. The following audit parameters can be modified:  • `Areas`  • `CheckLists`  • `CheckListItems`  • `WorkOrderIds`  • `Quantity`  • `Issues`  • `Attachments`
Use the [GET/subscribers/current/siteaudit/completed/{auditId}](https://developer.servicechannel.com/swagger/index.html#/SiteAudit/GETv3_subscribers_current_siteaudit_completed_%7BauditId%7D) method to get the audit you want to modify. ## Request body - ServiceChannelServicesMessagingSiteAuditUpdatedAuditDataExternal: Parameters for updating general audit info. - `Id` integer: Unique numeric identifier of the completed site audit. - `StoreId` integer: Unique numeric identifier of the location where the site audit was conducted. - `TemplateTypeId` integer: Unique numeric identifier of the template that was used to complete the site audit. The template determines the audit type. - `Language` string: Language that was used to conduct the audit. Use the two-letter abbreviation, for example, **EN**. - `SendEmails` boolean: Specifies whether an email notification was sent out upon completing the site audit. Possible input values: • `true`: The audit results were sent to the specified recipient(s). Use the `Emails` parameter to add the recipients. • `false`: The audit results were not emailed to anyone. - `Emails` string: Email address(es) to which the audit results were sent out upon completing the audit. Check the `Sent` parameter in the response to see whether the audit results were successfully sent out to the specified recipients.
Learn more about the email list for site audits in [SCU](https://servicechannel.atlassian.net/wiki/spaces/SCU/pages/552173744/Configuring+an+Email+List+for+Site+Audit+Reports). - `Status` 'Undefined' | 'Open' | 'Completed': Site audit status. Set the status value to `2` (`Completed`). - `Source` string - `Areas` ServiceChannelServicesMessagingSiteAuditUpdatedAuditAreaExternal[] - `Id` integer: Unique numeric identifier of the area that was inspected. - `Name` string: Area name that was inspected, for example, *Exterior* or *Interior*. - `SortOrder` integer: Sorting order of the area. - `CheckLists` ServiceChannelServicesMessagingSiteAuditUpdatedCheckListExternal[] - `Id` integer: Unique numeric identifier of the checklist. - `Name` string: Checklist name, for example, *Restroom* or *Dining room*. - `Unlisted` boolean - `SortOrder` integer: Sorting order of the checklist. - `CheckListItems` ServiceChannelServicesMessagingSiteAuditUpdatedCheckListItemExternal[] - `Id` integer: Unique numeric identifier of the checklist item. - `Name` string: Checklist item name, for example, *Hand dryer* or *Sink*. - `Description` string: Detailed description/instruction for the checklist item. - `Score` integer: Shows how the checklist item was rated. The response value depends on the rating system applied: • `1`: In the **Pass/Fail** rating system, it stands for the **Fail** answer. • `2`: In the **Pass/Fail** rating system, it stands for the **Pass** answer. • `numeric value`: In the **Weighted** rating system, a custom numeric value is assigned to each option: **Good**, **Fair**, and **Fail**. • `0–10`: In the **Numeric** rating system, a value from 0 to 10 can be used to rate the item. • `0–100`: In the **Percentage** rating system, a value from 0% to 100% can be used to rate the item. - `System` integer: Rating system that was applied to the checklist item. Possible values: • `1`: For the **Pass/Fail** rating system • `2`: For the **Numeric** rating system • `3`: For the **Weighted** rating system • `4`: For the **Percentage** rating system. When this rating system is used, the `Score` value is displayed in percentages.
Learn more about each rating system in [SCU](https://servicechannel.atlassian.net/wiki/spaces/SCU/pages/550928611/Building+a+Site+Audit+in+an+Excel+Template). - `Date` string, date-time: Date and time when the checklist item was inspected and rated. The format is YYYY-MM-DDThh:mm:ss.sssZ. - `Unlisted` boolean - `CheckListItemImpact` string: Checklist item’s impact on the total audit score. Possible input values: • `Veto`: Means that this item has the highest impact on the audit score. When at least one of the veto checklist items is rated as **Fail**, the total score of the audit drops to 1%. • `Ignore`: Means that this item is ignored when the audit score is calculated. • `Empty value`: Means that this checklist item is counted as a regular item. - `UseNumericRatingSystem` boolean - `PassThreshold` integer: Minimum rating value that is sufficient to pass the audit. Can be in numbers or in percentages based on the rating system applied to the checklist item. See the `System` parameter. - `Range` integer[]: Range of numbers displayed to the user during the audit, allowing the auditor to rate the item. Permits selecting a score on a 0–10 scale or from 0% to 100%. - `Issues` ServiceChannelServicesMessagingSiteAuditUpdatedAuditIssueExternal[] - `Id` integer: Comment ID. - `Date` string, date-time: Date and time when the comment was added to the checklist item. The format is YYYY-MM-DDThh:mm:ss.sss. - `Description` string: Text of the comment added to the checklist item during the audit. - `Persistent` boolean: Shows whether the comment should be saved for future audits. Possible input values: • `true`: To save the checklist item comment for future audits, set the parameter value to `true`. • `false`: When the comment should not be preserved and displayed for future audits, set the parameter value to `false`. - `Attachments` ServiceChannelServicesMessagingSiteAuditUpdatedAuditIssueAttachmentExternal[]: Images or videos attached to the checklist item during the inspection. - `Id` integer: Attachment ID. - `FileName` string: File name of the attachment. - `RemoteName` string: Remote name of the attached file. - `RemoteNameResized` string: File name that has been resized. - `WorkOrderIds` integer[]: Tracking numbers of the work orders created in the event of the checklist item inspection. - `Quantity` ServiceChannelServicesMessagingSiteAuditUpdatedAuditQuantityExternal: Parameters for updating the quantity or dollar cost of the inspected checklist items. - `Id` integer: Quantity record ID. - `Value` integer: Value showing either the quantity or the dollar cost of the inspected items. Check the `Type` parameter’s value. - `Type` 'Dollar' | 'Quantity': Value type. Possible values: `Quantity` and `Dollar`. - `Unit` string: Shows whether the auditor captured the **Quantity** or the **Dollar cost** of the inspected item. Possible values: `Quantity` and `Dollar`. ## Response `200` The site audit was successfully updated. - ServiceChannelServicesMessagingSiteAuditUpdatedCompletedAuditResponse: Object containing response parameters. - `IsSuccess` boolean: Returns `true` when the completed audit details have been successfully updated. - `Sent` string: Returns the success message when the updated site audit information is sent out to the specified email address. ## Other responses - `400`: The request is not accepted due to bad syntax, missing parameters, insufficient data, etc.
Error codes: 608 — Do not have access to the location 1009 — An error occurred while updating the entries. See the inner exception for details 1009 — Validation failed: Site audit must contain at least one checklist item 1009 — Validation failed: The range must contain the score 1009 — Validation failed: The range must contain the pass threshold value 1009 — Unexpected error - `401`: The requested resource requires authentication.
Error codes: 504 — API call rejected by security permissions - `404`: The requested resource does not exist on the server.
Error codes: 1008 — The requested audit was not found - `500`: Something went wrong, and the server was unable to complete your request.
Error codes: 501 — Unspecified internal server error occurred --- [API](https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3.md) - [All operations](https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3/llms.txt) - [OpenAPI document](https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3/revisions/d490d6596809?raw)