ads

PATCH `/v1/ads/connections/{connection_id}/checkout-sources/{source_id}`

Replace the signing secret, rename, or switch a checkout source on or off.

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 PATCH https://api.zinndigital.com/v1/ads/connections/{connection_id}/checkout-sources/{source_id} \
  -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.checkout_source_changed.

Parameters

Name	Type	Required	What it is
`connection_id (path)`	`string`	Yes	—
`source_id (path)`	`string`	Yes	—

Request body

Name	Type	Required	What it is
`signing_secret`	`string`	No	—
`label`	`string`	No	—
`enabled`	`boolean`	No	—

Response

Name	Type	Required	What it is
`id`	`string`	Yes	—
`connection_id`	`string`	Yes	—
`provider`	`string<stripe, paddle, freemius>`	Yes	—
`label`	`string`	Yes	—
`test_mode`	`boolean`	Yes	true = only the provider's test / sandbox events count; false = only live ones.
`enabled`	`boolean`	Yes	—
`has_secret`	`boolean`	Yes	Whether the provider's signing secret has been given (it is never returned).
`webhook_url`	`string`	Yes	The URL to paste into the provider.
`created_at`	`string`	Yes	—
`last_delivery_at`	`string`	Yes	—
`last_delivery_note`	`string`	Yes	What the last delivery was: received, ignored, otherMode, noSignature, badSignature, staleTimestamp, badTimestamp, noSecret, vaultUnavailable (empty = none yet).
`deliveries`	`integer`	Yes	—
`outcomes`	`integer`	Yes	Outcomes created from this source.

Errors this endpoint can return

401 · 403 · 404 · 422 · 429

PATCH /v1/ads/connections/{connection_id}/checkout-sources/{source_id}