Conversions

Create a conversion destination

Creates a new place to send conversion events: a Google Ads conversion action or a LinkedIn conversion rule.

Supported for LinkedIn (conversion rule) and Google Ads (conversion action). Meta and OpenAI Ads pixels are created via their own tracking-tags flow instead (POST /v1/accounts/{accountId}/tracking-tags); this endpoint returns 405 for both, and for Reddit (create Reddit pixels in Reddit Ads Manager).

LinkedIn: creation is NOT idempotent. A retry creates a second destination. Deduplicate before retrying.

Google Ads: calling with a name that already exists reuses the existing conversion action transparently (the response is identical to a fresh create). Calling with the same name but a different category returns a typed IDEMPOTENCY_CONFLICT (409) rather than silently returning the mismatched action.

LinkedIn: the rule is created with conversionMethod=CONVERSIONS_API and (by default) auto-associated with all of the ad account's campaigns via autoAssociationType=ALL_CAMPAIGNS. Pass autoAssociationType: NONE to opt out and manage associations explicitly via the associations endpoints below.

365-day attribution windows are only valid for SUBMIT_APPLICATION, PURCHASE, ADD_TO_CART, QUALIFIED_LEAD, and LEAD rule types; the API rejects other combinations locally.

Google Ads: the conversion action is created with type=UPLOAD_CLICKS (required for API-uploaded offline conversions, immutable after creation). The type field carries the Google ConversionActionCategory enum value, e.g. PURCHASE, SUBSCRIBE_PAID, SIGNUP, IMPORTED_LEAD, BOOK_APPOINTMENT. Unified standard event names (e.g. Purchase, Subscribe, CompleteRegistration, Lead, Schedule) are resolved to their Google category equivalents automatically. The action defaults to secondary (non-primary) to avoid immediately steering Smart Bidding; pass primaryForGoal: true to opt in.

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

post/v1/messaging/accounts/{accountId}/conversion-destinations

Request

  • Base URL: https://apihub.co.il
  • URL: https://apihub.co.il/v1/messaging/accounts/{accountId}/conversion-destinations
  • Auth: HTTP bearer

Path parameters

accountIdstring required

SocialAccount ID (linkedinads or googleads).

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 required
typestring required

Conversion type. For LinkedIn: a unified standard event name (e.g. "Purchase", "Lead", "AddToCart") or a LinkedIn rule type enum (e.g. "PURCHASE", "QUALIFIED_LEAD"). For Google: a unified standard event name (Purchase, Subscribe, CompleteRegistration, Lead, Schedule) or a Google ConversionActionCategory enum value directly (e.g. "PURCHASE", "SUBSCRIBE_PAID", "SIGNUP", "IMPORTED_LEAD", "BOOK_APPOINTMENT"). Unknown values pass through to the platform.

valueType'DYNAMIC' | 'FIXED' | 'NO_VALUE'

LinkedIn only. DYNAMIC (default) uses the per-event value from sendConversions. FIXED uses the rule's value field. NO_VALUE drops monetary value entirely.

adAccountIdstring required

Ad account ID. For LinkedIn: numeric (e.g. "5123456") or full urn:li:sponsoredAccount:{id} URN. For Google: numeric customer ID (e.g. "1234567890") or customers/{id} form.

countingType'MANY_PER_CLICK' | 'ONE_PER_CLICK'

Google Ads only. Whether to count multiple conversions from the same click (MANY_PER_CLICK) or at most one (ONE_PER_CLICK). Defaults to MANY_PER_CLICK if omitted.

primaryForGoalboolean

Google Ads only. When true, the conversion action is marked as primary and immediately influences Smart Bidding. Defaults to false (secondary, record-only) to avoid unintentionally steering the customer's campaigns on creation.

attributionType'LAST_TOUCH_BY_CAMPAIGN' | 'LAST_TOUCH_BY_CONVERSION'

LinkedIn only.

autoAssociationType'ALL_CAMPAIGNS' | 'OBJECTIVE_BASED' | 'NONE'

LinkedIn only. Controls campaign association at rule-creation time:

  • ALL_CAMPAIGNS: associate the rule with every active, paused, and draft campaign in the ad account
  • OBJECTIVE_BASED: associate only campaigns whose objective matches the rule's type
  • NONE: don't auto-associate. Manage associations via the /associations endpoints below. Note: auto-association runs once at create time; new campaigns added after the rule still need explicit association.
postClickAttributionWindowSize1 | 7 | 30 | 90 | 365

LinkedIn only. Default 30. 365 only allowed for LEAD, PURCHASE, ADD_TO_CART, QUALIFIED_LEAD, SUBMIT_APPLICATION rule types; the API rejects other combinations locally.

viewThroughAttributionWindowSize1 | 7 | 30 | 90 | 365

LinkedIn only. Default 7. Same 365-day-window type restriction applies as postClickAttributionWindowSize.

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.