v1

latestOpenAPI 3.1.0Private2026-07-24196240439.2 KB

PartnerProductLink

Create Product Link

post/partner/products/{product_id}/links

product_idstring required

Unique Product ID

link_type'url' | 'phone' | 'email' required

Kind of link. product_cta is reserved for the in-app install CTA and is managed via the main product endpoint — not partner-settable here.

valuestring required

Target of the link: a URL (for url), a phone number (for phone), or an email address (for email).

titlestring

Display label for the link in the marketplace.

utm_campaignstring

Optional UTM campaign appended to the URL when rendered in the marketplace. Defaults to hint_marketplace when omitted.

utm_contentstring

Optional UTM content appended to the URL when rendered in the marketplace.

positioninteger

Display order. Optional — defaults to the next position via acts_as_list.

Successful response

idstring

composed_urlstring

link_typestring

positioninteger

titlestring

utm_campaignstring

utm_contentstring

valuestring