OppiziDeveloper
API ReferenceCampaign Builder

Set EDDM routes and zones

POST
/client/campaigns/{id}/areas

Chooses where a direct-mail campaign is delivered: USPS carrier routes, plus the map zones they sit in.

Find routes first — around a point, by best fit or by city — and pass each route's raw object straight through.

The EDDM minimum-volume rule is checked here rather than at submit, so a selection that is too small is rejected while you can still add routes.

Needs an OAuth access token carrying the campaigns:create scope — a plain client key is refused. The campaign must be one of yours; anything else returns 404.

Authorization

campaignBuilderOAuth campaigns:create
AuthorizationBearer <token>

OAuth access token carrying the campaigns:create scope, obtained through the Oppizi consent screen (the same sign-in used by the MCP connector). A plain client key carries no scopes and is refused on these endpoints.

In: header

Scope: campaigns:create

Path Parameters

id*string

Your campaign id.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/client/campaigns/string/areas" \  -H "Content-Type: application/json" \  -d '{    "routes": null  }'
{  "success": true,  "data": {    "campaignId": 9700,    "routes": 48,    "homes": 25140  }}
Empty
Empty
Empty
Empty
Empty