UTM Templates

UTM templates store reusable sets of UTM parameters (source, medium, campaign, term, content). When applied to a link, the parameters are appended to the destination URL at creation time.

Each workspace can hold up to 50 UTM templates.

POST /api/v1/utm-templates — Create a new UTM template.

Create Template

GET /api/v1/utm-templates — Retrieve all UTM templates in your workspace.

List Templates

GET /api/v1/utm-templates/:id — Fetch a single template by ID.

Get Template

DELETE /api/v1/utm-templates/:id — Permanently remove a template.

Delete Template

The UTM Template Object


{
  "id": "utm_abc123",
  "workspaceId": "ws_xyz",
  "name": "Email Newsletter",
  "source": "newsletter",
  "medium": "email",
  "campaign": "weekly-digest",
  "term": null,
  "content": null,
  "createdAt": "2024-06-01T10:00:00.000Z",
  "updatedAt": "2024-06-01T10:00:00.000Z"
}

Fields

Field	Type	Description
`id`	string	Unique identifier for the template
`workspaceId`	string	ID of the owning workspace
`name`	string	Human-readable label for the template
`source`	string	UTM source, e.g. `newsletter`, `google`
`medium`	string	UTM medium, e.g. `email`, `cpc`
`campaign`	string	UTM campaign name
`term`	string \| null	UTM term — typically used for paid search keywords
`content`	string \| null	UTM content — for A/B testing ad creatives
`createdAt`	string	ISO 8601 timestamp
`updatedAt`	string	ISO 8601 timestamp