---
title: "Add a location note"
method: POST
path: "/locations/{locationId}/notes"
tags: ["Locations"]
---

# Add a location note

`POST /locations/{locationId}/notes`

## Request

- Base URL: `https://sb2api.servicechannel.com/v3`
- URL: `https://sb2api.servicechannel.com/v3/locations/{locationId}/notes`
- Auth: OAuth 2
  - Authorization code: `https://sb2login.servicechannel.com/oauth/authorize`
  - Token URL: `https://sb2login.servicechannel.com/oauth/token`
- TypeScript: <https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3/docs/locations/:locationId/notes/post.ts> (a function with typed inputs; its response is checked against the schema)

Adds a location note for the specified location. If a note is already added, you can change it by sending the request, or leave the `Value` parameter empty to delete the note.
             <br /> To retrieve location IDs along with the location notes, send either of these requests: [GET/stores](/swagger/ui/index?version=3#/Locations/GETv3_stores_Id__Id__storeIdentifier__storeIdentifier__Name__Name__Sort__Sort__Page__Page__PageSize__PageSize_), [GET/locations](/swagger/ui/index?version=3#/Locations/GETv3_locations_Id__Id__storeIdentifier__storeIdentifier__Name__Name__Sort__Sort__Page__Page__PageSize__PageSize_).
             Get location notes separately for the specified location by sending the [GET/locations/{locationId}/notes](/swagger/ui/index?version=3#/Locations/GETv3_locations__locationId__notes) request.
             <br />***Note***: Method is available for users with the *Super Admin* or *Admin* roles, or the *Location Admin* permission.
             <br /> **Example request**
            
                 POST /locations/{locationId}/notes
                 {
                   "Header": "Location Manager",
                   "Value": "John Smith"
                 }

## Path parameters

- `locationId` integer, required

## Request body

- ServiceChannelServicesMessagingLocationNoteUpdateLocationNoteHeaderApiModelRequest: Object containing the details of the location note.
  - `Header` string: Name of the existing location note to add, update or delete a note for. The maximum length is 100 characters.
  - `Value` string: Text of the note a user wants to replace the existing note with. The maximum length is 7000 characters including spaces.

## Response `200`

The note is added to the specified location.

## Other responses

- `400`: The request is not accepted due to bad syntax, missing parameters, insufficient data, etc. <br/>Error codes: 601 — Location is not found 1301 — Request is empty or null
- `401`: The request is not authorized. <br/>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. <br/>Error codes: 100 — User has no rights to perform this action 612 — The user does not have access to update a protected location note header
- `404`: The requested resource does not exist on the server. <br/>Error codes: 611 — The location note header does not exist on the subscriber instance
- `500`: The server was unable to complete the request due to an internal error. <br/>Error codes: 501 — Object reference not set to an instance of an object

---

[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)