SEservicechannel
Notes

Create a work order note

Adds a new note to the specified work order. Returns the note ID for a successful request. <br />Learn more about work order notes in SCU.

post/workorders/{workorderId}/notes

Request

Path parameters

workorderIdinteger required

Unique numeric identifier of the work order where a note should be created. Note: You need to have access to the WO location per your user settings.

Request body

Notestring required

Note text. Required.

MailedTostring

Email address(es) of people who should receive an email notification about the new note. Separate multiple addresses with a semicolon. <br />To prevent sending email alerts, leave it empty.

ActionRequiredboolean

Defines whether the note should be marked with the Action Required flag. Possible values: true and false.

ScheduledDatestring date-time

Scheduled date of the work order. The format is YYYY-MM-DDThh:mm:ss.sssZ. <br />To change the scheduled date of the work order via this method, ensure you have the ChangeScheduledDateViaAddNoteApiMethod feature turned on as well as the following permission enabled: WorkOrderScheduledDateChange. <br />Without this feature and permission, the updated scheduled date will be reflected on the note but won’t automatically update the scheduled date on the work order. <br />To prevent updating the scheduled date, leave the ScheduledDate empty.

FollowUpDatestring date-time

To mark a note with the Follow Up flag, specify the follow-up date and time. It is used to revisit a work order at a later time, for example, to ensure the provider clocked in or updated the work order by the specified date. The format is YYYY-MM-DDThh:mm:ss.sssZ. Additionally, set the IsFollowUpDateChanged parameter to true if you specify the follow-up date. <br />When no follow-up is required, leave it empty.

IsFollowUpDateChangedboolean

Indicates whether the follow-up date should be changed. Possible input values:  • Enter true if you specify the FollowUpDate.  • Enter false if you don't specify the FollowUpDate.

AttachmentsIdsinteger[]

Attachment IDs that should be associated with the note. Only files already linked to the work order can be attached to the note. To get attachment IDs, run the following method: GET/odata/workorders({workorderId})/attachments.

Visibilityinteger

Defines which parties can view the note. Visibility also works in Universal Connector, where there are three primary parties: Subscriber, External Subscriber, and Provider. Possible input values:  • 0: Visible to everyone (subscriber, external subscriber, provider).  • 1: Visible to the subscriber and the provider. Not visible to the external subscriber.  • 2: Visible to the subscriber and the external subscriber. Not visible to the provider.  • 3: Visible to the subscriber only. <br />Available with the PrivateProviderNotesAndAttachments feature flag. For Universal Connector clients, the PrivateClientNotesAndAttachments feature should be turned on.

Actorstring

Defines who is adding a note.

NotifyFollowersboolean

Defines whether the WO followers should be notified about the new note. Possible values:  • true: WO followers will be notified.  • false: WO followers will not be notified.

DoNotSendEmailboolean

A flag indicating whether to suppress sending email notifications for the note. Possible input values: true and false.

IsPinnedboolean

Indicates if the note should be pinned and displayed at the top of the notes list. Only one note can be pinned to a single work order.  • true: The note will be pinned.  • false: The note shouldn’t be pinned. <br />Available to subscribers only — behind the PinnedNotes feature flag.

Response

The note has been created and added to the specified work order.

Changes

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