---
title: "Campaign URL and UTM builder"
method: POST
path: "/api/agent-commerce/v1/services/url_campaign_builder/execute"
tags: ["data_tools"]
---

# Campaign URL and UTM builder

`POST /api/agent-commerce/v1/services/url_campaign_builder/execute`

## Request

- Base URL: `https://www.tradepilotusa.com` (the document declares no server; this is the origin it was published from)
- URL: `https://www.tradepilotusa.com/api/agent-commerce/v1/services/url_campaign_builder/execute`
- Auth: none declared

Build an HTTP(S) campaign URL with correctly encoded UTM fields while preserving unrelated query parameters and fragments. Replaces duplicate instances of supplied UTM fields. Rejects embedded credentials. Never visits or validates destination content.

## Request body

- object
  - `url` string, required
  - `utm_term` string
  - `utm_medium` string, required
  - `utm_source` string, required
  - `utm_content` string
  - `utm_campaign` string, required

## Response `200`

Successful response

- object
  - `result` object, required
    - `url` string, required
    - `network_request_performed` unknown, required
  - `utility` 'url_campaign_builder', required
  - `provenance` object, required
    - `execution` 'deterministic_local', required
    - `model_used` unknown, required
    - `network_request_performed` unknown, required
  - `request_id` string, required

## Other responses

- `402`: Payment Required

---

[API](https://skmtc.dev/tradepilotusa/apis/tradepilotusa-agent-commerce.md) · [All operations](https://skmtc.dev/tradepilotusa/apis/tradepilotusa-agent-commerce/llms.txt) · [OpenAPI document](https://skmtc.dev/tradepilotusa/apis/tradepilotusa-agent-commerce/revisions/1060778e0a57?raw)