API Reference

Create a campaign

post
https://api.purchasely.io/management/v1/applications//campaigns

Create a campaign on an application.

Required scope: targeting.campaigns:create

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
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.

string

ISO8601 end datetime.

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
string

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

string
enum
required

Create a draft or running campaign. A deactivated campaign cannot be created.

Allowed:
string
required

Stable machine identifier used in SDK calls.

Responses

Updated 24 days ago

Did this page help you?
Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 24 days ago

Did this page help you?