Trackers

Update Tracker

Changed on

Update a Tracker by ID.

post/print-mail/v1/trackers/{id}

Request

  • Base URL
    https://api.postgrid.com
  • URL
    https://api.postgrid.com/print-mail/v1/trackers/{id}
  • Auth
    API key in header X-API-Key

Path parameters

idstring required

The ID of the Tracker to update.

Request body

redirectURLTemplatestring required

The base template for URLs generated by this Tracker.

urlExpireAfterDays30 | 60 | 90 | 180 | 365 required

The number of days generated Tracker URLs remain valid.

descriptionstring

An optional string describing this resource. Will be visible in the API and the dashboard.

metadataobject

See the section on Metadata.

Response

The updated Tracker.

idstring required

A unique ID prefixed with tracker_

descriptionstring

An optional string describing this resource. Will be visible in the API and the dashboard.

metadataobject

See the section on Metadata.

liveboolean required

true if this is a live mode resource else false.

createdAtstring date-time required

The UTC time at which this resource was created.

updatedAtstring date-time required

The UTC time at which this resource was last updated.

Changes