GuidesChangelogAPI Reference
API Reference

/api/v5/campaign/

post
https://percolate.com/api/v5/campaign/

Create a campaign.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string | null

The id of user who is assigned to the campaign.

string | null

Approval group ID.

budget
object | null

Currency object.

post_workflow_ids
array of strings | null

An array of the production workflows associated with the campaign.

post_workflow_ids

Creates a copy of the specified campaign when a campaign UID is specified, or creates a campaign from a campaign template when a campaign template UID is specified.
When copying a campaign, you can override any of the attributes in the root campaign object. Below is an example of copying a campaign and changing the title.

  "copy_from_id": "campaign:1",
  "title": "This is a copy",
  "scope_id": "license:2"
} ```
copy_section_types
array of strings

Copies campaign sections matching given types. An empty array prevents campaign sections from being copied. When this attribute is omitted, all campaign sections get copied.

copy_section_types
string | null

A short description of the campaign.

string | null

The date when the campaign is scheduled to end.

metadata
array of objects | null
metadata
platform_ids
array of strings | null

An array of the platforms associated with the campaign.

platform_ids
string | null

ID of the production workflow that the campaign is attached to.

production_workflow_ids
array of strings | null

An array of the production workflows associated with the campaign.

production_workflow_ids
required
string | null

The date when the campaign is scheduled to start

term_ids
array of strings | null

An array of the terms associated with the campaign.

term_ids
string | null

An asset ID, a legacy video ID or a legacy image ID ^((asset|video):[a-zA-Z\d_]+|license:\d+:image:\d+|ownedimage:[\w=]+)$). In the future will be replaced with consistent `^asset:\d[\d-]*$`

string

The campaign title.

Responses

Retry-After header

500

Internal server error

Updated over 2 years ago

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 2 years ago