The tracking links object

The TrackingLinks endpoint accepts a POST request to generate a tracking link for a partner. It has certain attributes that can be defined as query string parameters when making a request.


Type enum

The type of tracking link.

View possible enum value
RegularCreates a standard tracking link.
VanityCreates a vanity tracking link.

CustomPath string

The custom path in the tracking link URL after the domain, used for vanity links (e.g.,

AdId integer

The unique identifier for the ad associated with the tracking link.

MediaPartnerPropertyId integer

The unique identifier of the partner's media property (e.g., website, social media, app, etc.) where the tracking link will be used.

DeepLink URI

If deep linking is enabled, this is the URL that the tracking link will redirect a user to.

Example request body

curl '<AccountSID>/Programs/<ProgramId>/TrackingLinks?MediaPartnerId=<MediaPartnerId>' \
  -X POST \
  -u '<AccountSID>:<AuthToken>' \
  -H 'Accept: application/json'