Sign in

v1

latestOpenAPI 3.0.02026-08-04361225.7 KB
Geo Targeting

Add geo targeting to campaign

Add zip code or state-based targeting. Either zip OR state must be provided, not both. If zip is provided, optional radius in miles can be specified.

post/api/geo-targeting/campaigns/{campaignId}

Path parameters

campaignIdstring required

Campaign ID

Request body

campaignIdstring required

Campaign ID

zipstring

ZIP code for targeting (5-digit US postal code). Cannot be used with stateCode.

radiusnumber

Radius in miles around the zip code center. Requires zip to be set.

stateCodestring

State code (2 letters, e.g., CA, NY). Cannot be used with zip.

suppressboolean required

Whether to suppress (exclude) this geo area. False means include only this area. Default is false.

creativeIdnumber

Creative ID to associate with this geo targeting (Modern Postcard Creative ID)

Example request

{
  "campaignId": "123e4567-e89b-12d3-a456-426614174000",
  "zip": "90210",
  "radius": 25,
  "stateCode": "CA",
  "creativeId": 12345
}

Response

Geo targeting added