# useApplyNoteChange

Returns a function to mutate the `note` property of the checkout.

## 

### UseApplyNoteChangeGeneratedType

Returns a function to mutate the `note` property of the checkout.

#### Returns: (change: NoteChange) => Promise<NoteChangeResult>
export function useApplyNoteChange<
  Target extends RenderExtensionTarget = RenderExtensionTarget,
>(): (change: NoteChange) => Promise<NoteChangeResult> {
  const api = useApi<Target>();

  if ('applyNoteChange' in api) {
    return api.applyNoteChange;
  }

  throw new ExtensionHasNoMethodError('applyNoteChange', api.extension.target);
}


### NoteRemoveChange

Removes a note

### type

value: `"removeNote"`

The type of the `NoteRemoveChange` API.

### NoteUpdateChange

An Update to a note on the order.
for example, the buyer could request detailed packaging instructions in an order note

### type

value: `"updateNote"`

The type of the `NoteUpdateChange` API.

### note

value: `string`

The new value of the note.

### NoteChangeResultSuccess

### type

value: `"success"`

The type of the `NoteChangeResultSuccess` API.

### NoteChangeResultError

### type

value: `"error"`

The type of the `NoteChangeResultError` API.

### message

value: `string`

A message that explains the error. This message is useful for debugging.
It is **not** localized, and therefore should not be presented directly
to the buyer.

## Related

- [StandardApi](https://shopify.dev/docs/api/checkout-ui-extensions/apis/standardapi)
- [CheckoutApi](https://shopify.dev/docs/api/checkout-ui-extensions/apis/checkoutapi)
- [OrderStatusApi](https://shopify.dev/docs/api/checkout-ui-extensions/apis/orderstatusapi)
- [CartLineItemApi](https://shopify.dev/docs/api/checkout-ui-extensions/apis/cartlineitemapi)
- [PickupPointListApi](https://shopify.dev/docs/api/checkout-ui-extensions/apis/pickuppointlistapi)
- [PickupLocationListApi](https://shopify.dev/docs/api/checkout-ui-extensions/apis/pickuplocationlistapi)
- [ShippingOptionItemApi](https://shopify.dev/docs/api/checkout-ui-extensions/apis/shippingoptionitemapi)
- [ExtensionTargets](https://shopify.dev/docs/api/checkout-ui-extensions/apis/extensiontargets)