Conversions

Update a conversion action's settings

Changes a Google Ads conversion action's settings, such as primary or secondary, counting, value and lookback windows, or removes or restores it.

Updates a Google Ads conversion action in one mutate, each field sent written on its own update mask leaf so omitted fields keep their value. Send at least one field.

primaryForGoal sets primary_for_goal: a primary action counts toward its goal's bidding and the Conversions column; a secondary one is observation-only (All conversions). countingType, category, the value settings (defaultValue, defaultCurrency, alwaysUseDefaultValue) and the click-through / view-through lookback windows map to the same-named conversion_action fields.

status: REMOVED removes the action (Google keeps it, with its history, as REMOVED) and must be sent alone; status: ENABLED restores a removed action. Google refuses HIDDEN on website actions, so it is not offered.

Billing: Request; paid actions are priced in credits (see GET /v1/messaging/prices) · Rate limit: 60/min

patch/v1/messaging/ads/conversions/actions/{actionId}

Request

  • Base URL: https://apihub.co.il
  • URL: https://apihub.co.il/v1/messaging/ads/conversions/actions/{actionId}
  • Auth: HTTP bearer

Path parameters

actionIdstring required

Google conversion action id

Headers

Idempotency-Keystring

Replay-safe: the same execution is returned instead of charging twice

X-Tagstring

Group calls into one job (e.g. one video) — see GET /v1/usage?tag=…

Request body

namestring
status'ENABLED' | 'REMOVED'

REMOVED removes the action and must be sent alone; ENABLED restores a removed one.

category'DEFAULT' | 'PAGE_VIEW' | 'PURCHASE' | 'SIGNUP' | 'DOWNLOAD' | 'ADD_TO_CART' | 'BEGIN_CHECKOUT' | 'SUBSCRIBE_PAID' | 'PHONE_CALL_LEAD' | 'IMPORTED_LEAD' | 'SUBMIT_LEAD_FORM' | 'BOOK_APPOINTMENT' | 'REQUEST_QUOTE' | 'GET_DIRECTIONS' | 'OUTBOUND_CLICK' | 'CONTACT' | 'ENGAGEMENT' | 'STORE_VISIT' | 'STORE_SALE' | 'QUALIFIED_LEAD' | 'CONVERTED_LEAD'

conversion_action.category. Defaults to DEFAULT on create.

accountIdstring required

Zernio SocialAccount id (Google Ads)

customerIdstring

Alias of adAccountId

adAccountIdstring

Google customer id. Required when the connection has multiple customers.

countingType'ONE_PER_CLICK' | 'MANY_PER_CLICK'

ONE_PER_CLICK counts one conversion per ad click (leads); MANY_PER_CLICK counts every one (purchases).

defaultValuenumber
primaryForGoalboolean

true = primary (counts toward bidding when its goal is biddable), false = secondary.

defaultCurrencystring

ISO 4217 currency of defaultValue (value_settings.default_currency_code).

alwaysUseDefaultValueboolean
viewThroughLookbackWindowDaysinteger

Days after an ad view a view-through conversion still counts.

clickThroughLookbackWindowDaysinteger

Days after an ad click a conversion still counts.

Response

Completed

idstring

Execution id — stable across internal retries; use it with GET /v1/executions/{id}

status'pending' | 'processing' | 'completed' | 'partial' | 'failed' | 'cancelled' | 'timeout'
operationstring
tagstring nullable

Your X-Tag, if sent

created_atstring date-time
completed_atstring date-time nullable
errorstring nullable

Changes

No recorded changes to this operation across all 2 revisions of this API.