--- title: "Create a work order note" method: POST path: "/workorders/{workorderId}/notes" tags: ["Notes"] --- # Create a work order note `POST /workorders/{workorderId}/notes` ## Request - Base URL: `https://sb2api.servicechannel.com/v3` - URL: `https://sb2api.servicechannel.com/v3/workorders/{workorderId}/notes` - 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) Adds a new note to the specified work order. Returns the note ID for a successful request.
Learn more about work order notes in [SCU](https://servicechannel.atlassian.net/wiki/x/4oPNKQ). ## Path parameters - `workorderId` integer, required ## Request body - ServiceChannelServicesMessagingWorkordersCreateWoNoteRequest: Represents a request to create a work order note. - `Note` string, required: Note text. Required. - `MailedTo` string: Email address(es) of people who should receive an email notification about the new note. Separate multiple addresses with a semicolon.
To prevent sending email alerts, leave it empty. - `ActionRequired` boolean: Defines whether the note should be marked with the **Action Required** flag. Possible values: `true` and `false`. - `ScheduledDate` string, date-time: Scheduled date of the work order. The format is `YYYY-MM-DDThh:mm:ss.sssZ`.
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*.
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.
To prevent updating the scheduled date, leave the `ScheduledDate` empty. - `FollowUpDate` string, 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.
When no follow-up is required, leave it empty. - `IsFollowUpDateChanged` boolean: 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`. - `AttachmentsIds` integer[]: 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. - `Visibility` integer: 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.
Available with the *PrivateProviderNotesAndAttachments* feature flag. For Universal Connector clients, the *PrivateClientNotesAndAttachments* feature should be turned on. - `Actor` string: Defines who is adding a note. - `NotifyFollowers` boolean: 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. - `DoNotSendEmail` boolean: A flag indicating whether to suppress sending email notifications for the note. Possible input values: `true` and `false`. - `IsPinned` boolean: 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.
Available to subscribers only — behind the *PinnedNotes* feature flag. ## Response `201` The note has been created and added to the specified work order. ## Other responses - `400`: The request was not accepted due to bad syntax, missing parameters, insufficient data, etc.
Error codes: 100 — You don't have location access to perform this operation 503 — Validation fails. Invalid `WorkOrder Id` or `Note` value 503 — Request is empty or null - `401`: The requested resource requires authentication.
Error codes: 504 — API call rejected by security permissions - `403`: You are not authorized to request this resource, or the resource is unavailable for some reason.
Error codes: 100 — User is a provider or does not have the *PinnedNotes* FF enabled and is trying to add a pinned note 100 — User has no rights to perform this action - `500`: Something went wrong, and the server was unable to complete your request. --- [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)