Skip to main content
PATCH
Update offer

Authorizations

Authorization
string
header
required

Workspace-scoped token sent in the Authorization header as Bearer . Access depends on the credential's allowed operations, read or write scope, and workspace subscription. Use an API key issued in the tracker for Public API v1. MCP uses separate OAuth credentials.

Path Parameters

id
string
required

Body

application/json

Partial offer update. All fields are optional.

name
string
Required string length: 1 - 160
url
string

Public HTTPS URL template, trimmed before saving. Supports tracker macros such as {click_id} and {token1:hash} through {token15:hash} for short token codes.

Required string length: 1 - 2048
Pattern: ^\s*[hH][tT][tT][pP][sS]://
affiliateNetworkId
string | null

UUIDv4 of the affiliate network, trimmed and lowercased before lookup. Null clears the reference.

appendClickId
boolean

When enabled, a change to url, affiliateNetworkId or appendClickId requires the selected network's clickIdParam query parameter exactly once in the resulting URL with {click_id} as its value. Supply the complete URL, including this parameter.

country
string

Supported ISO 3166-1 alpha-2 country code, case-insensitive and trimmed. ZZ, Global, and an empty string normalize to ZZ (Global). This controls asset compatibility, not visitor filtering.

Response

Updated

ok
enum<boolean>
required
Available options:
true
data
object | null
required