Skip to content

Workflow

  1. Look up targeting. Find targeting values with the inventory routes and size the audience with POST /inventory/forecast.

  2. Create a draft campaign with PUT /campaigns/{id}, which never overwrites an existing one. Drafts may be partial and are refined with PATCH.

    Ad groups hold the targeting, price, link and budget allocation of their creatives. Send them as the campaign adGroups, which saves the whole campaign in one transaction, or create them one by one with PUT /ad-groups/{id}. A campaign without ad groups keeps them on the campaign.

  3. Upload media. POST /assets/{id}/upload-url returns a signed URL; PUT the file bytes there with the same Content-Type, then register the asset with PUT /assets/{id}.

  4. Create creatives with PUT /creatives/{id}, the draft campaign UUID in campaign and its ad group UUID in adGroup, copying the ad group audience, url, utm and trackingTag. POST /creatives/render turns an asset into the creative markup and size.

    Change one ad group with PATCH /ad-groups/{id}, or the whole campaign with adGroups listing every ad group and ad; both copy a new targeting and link onto its creatives.

  5. Price and launch. Price the draft with POST /campaigns/quote and launch it with POST /campaigns/{id}/launch, which debits the organization balance (409 when the campaign is not a draft, 412 when it is not ready to launch or the balance is short).

  6. Pause or resume a live campaign with POST /campaigns/{id}/status.