Update property list

Deprecated. This page documents the v2 buyer API, which is closed to new API clients and switches off on 1 December 2026. Use V3 instead: see Move a v2 buyer REST integration to V3. The conversion endpoint, Log event, stays open.

PUT /api/v2/buyer/advertisers/{advertiserId}/property-lists/{listId} Updates a list’s name and/or replaces its identifiers. There is no incremental add/remove — when you send domains or identifiers, the full set is replaced with what you submit. For an identifier change, Apostra sends update_media_buy to each seller that declares the list field, even though the reference is unchanged. This tells the seller to refresh the list contents instead of waiting for its cache to expire. Each affected buy is also checked again against the new contents, and one that no route enforces any more is paused.

Request

curl -X PUT https://api.apostra.com/api/v2/buyer/advertisers/12345/property-lists/42 \
  -H "Authorization: Bearer $SCOPE3_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "identifiers": [
      { "type": "domain", "value": "example-times.com" },
      { "type": "ios_bundle", "value": "com.exampletimes.ExampleTimes" }
    ]
  }'

{
  "name": "Q1 Campaign - UK Premium (revised)"
}

Parameters

Field	Type	Required	Notes
`advertiserId`	string	Yes	Path. Owning advertiser
`listId`	string	Yes	Path. The property list to update
`name`	string	No	Updated name (1–255 chars)
`domains`	string[]	No	Replacement domains shorthand. Up to 100,000
`identifiers`	object[]	No	Replacement typed `{ type, value }` set. Up to 100,000

Send at least one field. Providing domains and/or identifiers replaces the entire identifier set; pass the full union you want stored.

Response

{
  "propertyList": {
    "listId": "42",
    "name": "Q1 Campaign - UK Premium",
    "purpose": "include",
    "identifiers": [
      { "type": "domain", "value": "example-times.com" },
      { "type": "ios_bundle", "value": "com.exampletimes.ExampleTimes" }
    ],
    "unresolvedIdentifiers": [],
    "registeredIdentifiers": [],
    "domains": ["example-times.com"],
    "propertyCount": 12,
    "resolutionSummary": {
      "totalRequested": 2,
      "resolvedCount": 2,
      "registeredCount": 0,
      "unresolvedCount": 0,
      "resolutionRate": 1
    },
    "cascadeSummary": {
      "totalMediaBuys": 4,
      "updatedCount": 3,
      "failedCount": 1
    },
    "updatedAt": "2026-01-20T14:45:00.000Z"
  }
}

resolutionSummary and cascadeSummary appear only when identifiers change — a name-only update returns neither. cascadeSummary reports the re-check of each active buy, including any buy that was paused; see When a live buy is paused. A failed re-check does not roll back the update.

Errors

400 VALIDATION_ERROR — no fields supplied, or combined identifier total above 100,000.
404 NOT_FOUND — listId or advertiserId does not exist or is not visible to the authenticated account.

See Errors for the full error contract.

Property list tasks

All property list operations

Property Lists guide

Cascade behavior and resolution concepts

Get property list

Full resolved resource for one list

Check property list

Validate a candidate set before replacing

Start building

Core Concepts

Buyer operations

Seller operations

Cross-Cutting Reference

Buyer API reference

Seller API reference

Release Notes

Update property list

Request

Parameters

Response

Errors

Property list tasks

Property Lists guide

Get property list

Check property list

​Request

​Parameters

​Response

​Errors

​Related

Property list tasks

Property Lists guide

Get property list

Check property list

Request

Parameters

Response

Errors

Related