---
title: "Update an existing tracker"
method: PATCH
path: "/public/v1/trackers/{trackerId}"
tags: ["📦 Trackers"]
---

# Update an existing tracker

`PATCH /public/v1/trackers/{trackerId}`

This endpoint allows to modify an existing `Tracker` matching with the given identifier.  

> Once the Tracker has gathered shipment tracking information, certain fields related to the shipment data cannot be modified. These include: 
> - `courierCode` 
> - `originCountryCode` 
> - `destinationCountryCode` 
> - `destinationPostCode` 
> - `shippingDate`

## Path parameters

- `trackerId` string, required

## Query parameters

- `searchBy` 'trackerId' | 'clientTrackerId'

## Request body

- object
  - `isSubscribed` boolean — Setting at `false` will unsubscribe you from the `Tracker`. Once unsubscribed, you will still be able to fetch the existing tracking results but Ship24 won't search for new data or send webhook notifications. `Trackers` are automatically disabled after the parcel delivery or after a long period without any new events. Manually unsubscribing your tracker is not useful, except if you wish to stop receiving webhooks on it or if you need to reuse the `clientTrackerId` value in a new `Tracker`.
  - `courierCode` union — Code of the courier(s) handling the shipment (Up to 3 max) (see Couriers list section) - 📌 Recommended to improve tracking accuracy
    - string[]
    - string
  - `originCountryCode` string, ISO 3166-1 alpha-2/alpha-3 — Sender country code.
  - `destinationCountryCode` string, ISO 3166-1 alpha-2/alpha-3 — Recipient country code - 📌 Recommended to improve tracking accuracy
  - `destinationPostCode` string — Recipient Post code (or ZIP code) - 📌 Recommended to improve tracking accuracy
  - `shippingDate` string, date-time — Date at which the shipment has been shipped - 📌 Recommended to improve tracking accuracy: providing the shipping date helps us accurately identify the shipment and improves our ability to retrieve the correct data. However, an inaccurate shipping date could cause our system to exclude the right shipment. Therefore, please ensure the provided shipping date aligns closely with the actual shipment date, give or take a few days. [Format](http://docs.ship24.com/data-format#logistics-date-and-time)

## Response `200`

- Tracker
  - `trackerId` string, required — The id of the tracker that is providing this tracking.
  - `trackingNumber` string, required — The tracking number which the tracker is following.
  - `shipmentReference` string, nullable, required — Your reference for this shipment, provided at the tracker's creation. Unlike clientTrackerId, this value is not validated for uniqueness.
  - `courierCode` union — Code of the courier(s) handling the shipment.
    - string[]
    - string
  - `clientTrackerId` string, nullable, required — Your unique identifier for this shipment, provided at the tracker's creation. Ship24 validates its uniqueness across all your active trackers.
  - `isSubscribed` boolean, required — Indicates whether the tracker is active. A value of `false` means the tracker is archived and will not be used for tracking.
  - `isTracked` boolean, required — Indicates whether we are actively tracking the parcel. A value of `true` means new data is being searched for, while `false` indicates tracking has stopped due to delivery, inactivity, or unsubscription. Existing tracking results will remain accessible; however, new data will not be fetched, and notifications will no longer be sent.
  - `createdAt` string, date-time, required — The date and time at which the tracker was created.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized - No valid API key provided.
- `403` — Forbidden - The API key provided does not have permissions to perform the request.
- `404` — Not Found - The requested resource does not exist.
- `429` — Rate limit exceeded. The client has sent too many requests in a given amount of time.

---

[API](https://skmtc.net/botbrains-io/apis/ship24-tracking-api.md) · [All operations](https://skmtc.net/botbrains-io/apis/ship24-tracking-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/botbrains-io/ship24-tracking-api/revisions/9d68f8b1d086/schema)