Update a campaign

patch

https://api.purchasely.io/management/v1/applications/{application_id}/campaigns/{id}

Update a campaign. The request resends the full campaign object.

category_tag_ids and placement_ids, if provided, fully replace the existing set.
Omitted config, tags and placements are preserved.
A running campaign cannot change its vendor_id, content or audience, and needs complete timing.
A running campaign cannot return to draft.
Request a deactivation separately from other field changes.

Required scope: targeting.campaigns:edit

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

application_id

string

required

Public ID of the resource.

string

required

Public ID of the resource.

Query Params

fields[]

array of strings

Field selection for token economy: an explicit list of field names to include in the response, or ["*"] for every field. Omit for this endpoint's own default field set.

fields[]

Body Params

category_tag_ids

array of strings

Category tag public IDs (cat_…) to associate. Omit to leave existing category tags untouched.

category_tag_ids

config

object

Campaign configuration. Drafts may be incomplete. Launching requires what, who and when; when must include frequency_cap, impression_cap and exposure_window. Reference persisted IDs, not vendor IDs.

ends_at

string

ISO8601 end datetime.

name

string

required

Display name shown in console.

placement_ids

array of strings

Placement public IDs (plac_…) this campaign targets. For Management/MCP drafts, saves the selection for the console editor; delivery starts only when running. Pass IDs returned by placements_create/list. Omit to leave existing placements untouched; [] clears them.

placement_ids

starts_at

string

ISO8601 start datetime. Required by the model when status is running.

status

string

enum

required

draft, running, or deactivated.

Allowed:

vendor_id

string

required

Stable machine identifier used in SDK calls.

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success.

403FORBIDDEN (missing/insufficient scope, wrong tenant) or, for feature-gated operations, FEATURE_NOT_ENABLED.

422VALIDATION_FAILED — one or more parameters were missing or invalid.

429RATE_LIMITED — the coarse per-key, per-write, per-heavy-read, or per-moderate-read rate limit tier was exceeded.