Customer links

Revoke a customer link

Use this when an order is cancelled or the customer should stop seeing the shipment. The link stops opening at once and the customer's tracking emails through it stop. It is a soft delete: the link is returned with active false and url null. Revoking a link that is already revoked returns it again and changes nothing. Needs the write scope. An admin or owner may revoke any link; a member only the ones their own token made (403 revoke_not_allowed otherwise). Recorded in the audit log as made through the API.

delete/share_links/{id}

Request

  • Base URL: https://trackberry.com/api/v1
  • URL: https://trackberry.com/api/v1/share_links/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

The customer link id (shl_ prefix). An id from another organization, or with another prefix, is a 404.

Headers

Trackberry-Versionstring

The API version to build this response for, for example 2026-10-01. Optional: without it the organization's pinned version is used (and the organization is pinned to the latest version on its first request without the header). Applies to this request only. An unpublished version is a 400 with code invalid_version.

Response

The revoked customer link.

object'share_link' required

Always share_link.

idstring required

The customer link id.

shipment_idstring required

The shipment the link opens.

customer_referencestring required

The customer's own reference for the order, as shown to the customer.

labelstring nullable required

Your own note to tell links apart. Never shown to the customer. Null when none was given.

urlstring nullable required

The link to give the customer. The secret part of the link is only ever inside this URL. Null once the link is revoked.

activeboolean required

False once the link has been revoked.

revoked_atstring date-time nullable required

When the link was revoked. Null while it is active.

created_atstring date-time required

When the link was created.

Changes

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