ads

PUT /v1/ads/connections/{connection_id}/profit

Turn profit bidding on or off, set product costs and fee estimates.

All ads endpoints

All developer docs →

Zinn®, our Viking, hammering at his anvil beside an API endpoint sending events to several listeners.

Authentication

Send an API key as a bearer token. The key must carry the ads.manage permission; a key without it is refused with 403, not 404.

This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

curl -X PUT https://api.zinndigital.com/v1/ads/connections/{connection_id}/profit \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

Gated on ads.manage; audit action ads.profit_settings. Every field is optional. products REPLACES the account's product costs as a whole (each product_ref once); sources sets the fee estimate of named checkout sources of THIS account. A cost change applies to sales that arrive after it: a sale keeps the margin it arrived with.

Parameters

NameTypeRequiredWhat it is
connection_id (path)stringYes—

Request body

NameTypeRequiredWhat it is
value_basisstring<revenue, profit>No—
default_cost_bpintegerNoCost of a product with no cost row
productsAdsProductCost[]No—
sourcesAdsProfitSourceFee[]No—

Response

NameTypeRequiredWhat it is
connection_idstringYes—
value_basisstring<revenue, profit>Yes—
default_cost_bpintegerYes—
productsAdsProductCost[]Yes—
sourcesAdsProfitSourceFee[]Yes—
summaryobjectYes—

Errors this endpoint can return

401 · 403 · 404 · 422 · 429