Skip to main content

Configure Offer Fields in API Network Setting

Configure how each offer field is synced from your advertiser's API - at approval, continuously, or never.

Overview

In Step 3 of the network setup, you decide how each offer field should be updated when the advertiser changes it in their API. This gives you control over which fields stay in sync automatically and which you manage manually in Swaarm.

Each field has up to two settings:

  • On Sync - Use API Value - if checked, the field updates automatically every time the advertiser changes it in their API

  • On Approval - Use API Value - if checked, the field takes the value from the advertiser's API at the moment of offer approval

  • On Approval - Use Default Value - if a value is entered, this value is applied to the field at the moment of approval, regardless of what the API provides

ℹ️ Not all fields are supported by every adapter. Check the relevant adapter article to confirm which fields are available. → Network Configuration


Supported Fields

Name

The offer name displayed in Swaarm.

  • On Approval: if a Default Value is set, all offers approved from this advertiser will use that name. If Use API Value is checked, the offer name is taken from the advertiser's API at the moment of approval.

  • On Sync: if checked, the offer name updates automatically whenever the advertiser changes it in their API. If unchecked, the name is only set once at approval and never updated.


Private and Required Approval Flags

  • If Private is checked, the offer visibility will be set as private at the moment of approval.

  • If Required Approval is checked, the offer visibility will be set as 'requires approval'.

More about offer visibility here.


Status

  • On Approval: Default Value can be Active or Pending. If Use API Value is checked, the offer status is taken from the advertiser's API at approval.

  • On Sync: if checked, the offer status updates to Active or Paused whenever the advertiser changes it. If unchecked, the status is only set once at approval.


Leadflow

  • On Approval: set a Default Value (CPA, CPI, CPC, etc), or check Use API Value to take the leadflow from the advertiser's API.

Check all the supported leadflows here.


Tracking Link

The click tracking URL for the offer. Synced from the advertiser API.


Description

The offer description. Synced from the advertiser API.


Creatives URL

The creative asset URL. Synced from the advertiser API.


Events

Events are always created on the offer at the moment of approval with the values provided by the advertiser API.

  • On Sync: if checked, event updates from the API are reflected on the offer. If unchecked, events are only set once at approval and not updated.


Targeting

Refers to the OS and Country targeting on the offer. Check more details about how targeting works in Swaarm here.

  • On Sync: if checked, any changes to country or OS targeting in the API are reflected on the offer. If unchecked, the targeting set at approval remains and is never updated.


Advanced Targeting

Refers to the Targeting tab on the offer (region, city, time targeting, etc.). Check more details about Advanced Targeting here.

By default, Use API Value is enabled - any advanced targeting detected from the API is applied.

  • On Sync: if checked, the offer's advanced targeting is overridden with the latest API values on every sync (including any targeting you may have set manually). If unchecked, advanced targeting is only set once at approval.


Click Budgets

The daily click budget of the offer.

  • On Approval: set a Default Value or use the value from the API.

  • On Sync: if checked, the click budget updates automatically whenever the advertiser changes it. If unchecked, only set once at approval.


Budgets

Conversion and revenue budgets - both default and event-level. See more about Budgets in Swaarm here.

  • On Approval: set a Default Value or use the value from the API.

  • On Sync: if checked, budgets update automatically from the API.


Payouts

Default payouts and event-level payouts.

Payouts are always created at the moment of approval with the values provided by the advertiser API.

  • On Sync: if checked, payouts update automatically whenever the advertiser changes them. If unchecked, payouts are only set once at approval.


Blacklisted Sub IDs

Some Advertiser provide list of blocked subids in the API. Blacklisted Sub IDs are always created at the moment of approval with the values shared by the advertiser API.

  • On Sync: if checked, the blacklist updates automatically from the API. If unchecked, only set once at approval.


Impression Tracking URL

The impression tracking URL for the offer.

  • On Approval: if checked, the impression tracking URL is synced at the moment of approval. Uncheck to skip the initial import.

  • On Sync: if checked, the impression tracking URL updates on every sync. Uncheck to prevent repeat syncing.


Impression Budgets

Configure a default impression budget for all offers from the advertiser.


Preview URL

The App Store URL or final landing page for the offer.

  • On Approval: if checked, the Preview URL is synced at the moment of approval. Uncheck to skip the initial import.

  • On Sync: if checked, the Preview URL updates on every sync. Uncheck to prevent repeat syncing.


KPIs

The KPI field from the offer's General tab.

Synced from the advertiser API.


Revenue Share

Revenue-share based offer payouts. Synced from the advertiser API.

  • On Approval: if checked, Revenue Share setting is synced just at the moment of approval. Uncheck to skip the initial import.

  • On Sync: if checked, Revenue Share setting updates on every sync. Uncheck to prevent repeat syncing.


Use Case

I want to rename an offer without it being overwritten by the API

By default, if On Sync checkbox is enabled for the Name field, so any rename you make manually in Swaarm will be overwritten the next time the API syncs.

To prevent this:

  • On Sync - unselect the checkbox

  • On Approval - leave as selected

ℹ️ Once On Sync is unchecked, the offer name will never be updated from the API - any future changes on the advertiser's side will be ignored.

Did this answer your question?