API Reference
Release NotesProof ScheduleĀ®UI LibrariesClient LibrariesBlog

Create campaign

post
https://ac.cnstrc.com/v1/campaigns

šŸ” This endpoint requires HTTP authentication (either Basic or Bearer). For authenticating with Bearer token, required scopes are: searchandising.campaigns(w), searchandising.recommendations(w).

Create a campaign.

Body Params
string
enum

Request tag name to be used to activate this entity for, used only with request_tag_value.

string
length between 1 and 100

Request tag value to be used to activate this entity for, used only with request_tag_name.

date-time

The start time of the campaign.

date-time

The end time of the campaign.

string
required

The name of the campaign.

string

The description of the campaign.

refined_queries
array of objects
length ā‰¤ 100

A list of refined queries.

Refined Queries
refined_filters
array of objects
length ā‰¤ 100

A list of refined filters.

Refined Filters
refined_recommendation_contexts
array of objects
length ā‰¤ 100

A list of refined recommendation contexts.

Refined Recommendation Contexts
boost_rules
array of objects
length ā‰¤ 50

A list of boost rules.

Boost Rules
blacklist_rules
array of objects
length ā‰¤ 50

A list of blacklist rules.

Blacklist Rules
slot_rules
array of objects
length ā‰¤ 1000

A list of slot rules.

Slot Rules
content_rules
array of objects
length ā‰¤ 50

A list of content rules.

Content Rules
filters_slot_rules
array of objects
length ā‰¤ 5

A list of filters slot rules.

Filters Slot Rules
whitelist_rule

A whitelist rule.

variation_slicing_rule

A variation slicing rule.

Responses

400

Validation Error

401

Credentials are not passed or action is forbidden.

403

The supplied token does not have the required permissions.

409

Conflict

429

Rate limit breached

Updated 4 months ago

Language
Credentials
:
Response 
 Choose an example:
application/json
Updated 4 months ago