Skip to main content
POST
Create or resolve campaign from external source

Overview

Submit campaign source data keyed by reference_id. Requires a valid Bearer token from POST /auth/token.
  • If a campaign already exists for reference_id, the API returns 200 with campaign_link.
  • If no campaign exists, the server stores context (including optional AI extraction), creates the campaign, and returns 201 with campaign_link and campaign_id.
Use campaign_id with GET /campaign to fetch the campaign, its stats, and an app link.

Request

Headers

  • Authorization: Bearer {jwt_token} (required — obtained using your issued partner credentials)
  • Content-Type: application/json

Body Parameters

object
required
Container for campaign source metadata for your client
string[]
required
Image URLs for the campaign (at least one required)
string
required
Campaign display name (for example property address)
string
required
Your stable external id for this campaign
string
required
Landing page URL (URI)

Example Request

Response

Success (201 — new campaign)

URL to the campaign in the Targeter app
string
Campaign id (hashed id, same encoding as in app URLs)

Success (200 — existing campaign)

URL to the existing campaign in the Targeter app

Error Responses

400 - Invalid request payload

Validation errors on auth may include a details array with path and message per field.

401 - Unauthorized

Missing Authorization header, or invalid or expired token.

500 - Server Error

Partner Usage Examples

Real Estate Campaign for Client

Marketing Campaign for Client

Partner Best Practices

  • Unique Reference IDs: Use unique, meaningful reference IDs from your system to avoid conflicts
  • Client Landing Pages: Verify that client target URLs are working and relevant
  • Image URLs: Provide publicly accessible image URLs in material
  • Error Handling: Always check response status codes and handle errors appropriately
  • Client Consent: Ensure you have proper authorization to create campaigns on behalf of your clients

Authorizations

Authorization
string
header
required

Use Authorization: Bearer <token>. Obtain the token from POST /auth/token.

Body

application/json
source
object
required

Campaign source metadata for the client

Response

Campaign already exists for the given reference_id

URL to the existing campaign in the Targeter app

Example:

"https://app.targeter.tech/campaigns/AbC123xyz"