ads

POST /v1/ads/shield/claims/{claim_id}/sent

Record that a person sent the pack through Google's form.

All ads endpoints

All developer docs →

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.

Where your organisation id goes

This endpoint takes org_id as a field in the JSON body.

Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.

Try it

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

curl -X POST https://api.zinndigital.com/v1/ads/shield/claims/{claim_id}/sent \
  -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.shield_claim_sent. Zinn® never files a claim itself (owner ruling) — this records the person's word and, optionally, Google's reference, so the credit can be looked for on the following invoices.

Parameters

NameTypeRequiredWhat it is
claim_id (path)stringYes—

Request body

NameTypeRequiredWhat it is
org_idstringNo—
referencestringNo—

Response

NameTypeRequiredWhat it is
idstringYes—
connection_idstringYes—
accountstringYesThe Google Ads customer id.
account_labelstringYes—
monthstringYes—
statusstring<ready, filed, credited, declined>Yes—
clicksintegerYes—
estimated_cost_minorintegerYes—
currencystringYes—
filed_atobjectYes—
referencestringYes—
credited_minorobjectYesThe invalid-activity credit for the month read from the account's invoices (null = none seen yet).
credit_checked_atobjectYes—
credit_notestringYesno_monthly_invoicing when the account has no invoices to read.
google_form_urlstringYesGoogle's invalid-click investigation form.

Errors this endpoint can return

401 · 403 · 404 · 422 · 429