SEservicechannel
SiteAudit

Modify details of a completed audit

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 <br />Use the GET/subscribers/current/siteaudit/completed/{auditId} method to get the audit you want to modify.

put/subscribers/current/siteaudit/completed

Request

Request body

Idinteger

Unique numeric identifier of the completed site audit.

StoreIdinteger

Unique numeric identifier of the location where the site audit was conducted.

TemplateTypeIdinteger

Unique numeric identifier of the template that was used to complete the site audit. The template determines the audit type.

Languagestring

Language that was used to conduct the audit. Use the two-letter abbreviation, for example, EN.

SendEmailsboolean

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.

Emailsstring

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. <br />Learn more about the email list for site audits in SCU.

Status'Undefined' | 'Open' | 'Completed'

Site audit status. Set the status value to 2 (Completed).

Sourcestring

Response

The site audit was successfully updated.

IsSuccessboolean

Returns true when the completed audit details have been successfully updated.

Sentstring

Returns the success message when the updated site audit information is sent out to the specified email address.

Changes

No recorded changes to this operation across all 1 revision of this API.