POST /work-requests/{id}/campaigns
1 min
POST
https://api.cmp.optimizely.com/v3/work-requests/{id}/campaigns
Path Parameters
- idstringrequiredExampleDescription
Body Parameters
- bodyWorkRequestCampaignRequestrequiredDescription
- titlestringrequiredExampleDescription
- descriptionstringExampleDescription
- start_datestring<date-time>ExampleDescriptionFormatdate-time
- end_datestring<date-time>ExampleDescriptionFormatdate-time
- owner_idstringExampleDescription
- parent_campaign_idstringExampleDescription
- exclude_empty_fieldsbooleanExampleDescriptionDefaulttrue
Responses
201
- WorkRequestCampaignResponse
- idstringrequiredExampleDescription
- titlestringrequiredExampleDescription
- descriptionstringrequiredExampleDescription
- start_datestring<date-time>requiredExampleDescriptionFormatdate-time
- end_datestring<date-time>requiredExampleDescriptionFormatdate-time
- reference_idstringrequiredExampleDescription
- owner_idstringrequiredExampleDescription
- parent_campaign_idstringrequiredExampleDescription
- linksobjectrequiredDescription
- selfstringrequiredExampleDescription
- briefstringrequiredExampleDescription
- parent_campaignstringrequiredExampleDescription
400
- ErrorExample
{ "message": "Unsupported arguments: a,b,c" }Description- messagestringrequiredExampleDescription
- errorsmap<string, string>Description
401
- ErrorExample
{ "message": "Unauthorized" }Description- messagestringrequiredExampleDescription
- errorsmap<string, string>Description
403
- ErrorExample
{ "message": "You do not have the permission to perform this operation" }Description- messagestringrequiredExampleDescription
- errorsmap<string, string>Description
404
- ErrorExample
{ "message": "Resource not found" }Description- messagestringrequiredExampleDescription
- errorsmap<string, string>Description
curl
curl --request POST \
--url https://api.cmp.optimizely.com/v3/work-requests/{id}/campaigns \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '{
"title": "The awesome campaign",
"exclude_empty_fields": true
}'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
var raw = JSON.stringify({
"title": "The awesome campaign",
"exclude_empty_fields": true
});
var requestOptions = {
method: 'POST',
headers: myHeaders,
body: raw,
redirect: 'follow'
};
fetch("https://api.cmp.optimizely.com/v3/work-requests/{id}/campaigns", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));ruby
require "uri"
require "json"
require "net/http"
url = URI("https://api.cmp.optimizely.com/v3/work-requests/{id}/campaigns")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
"title": "The awesome campaign",
"exclude_empty_fields": true
})
response = https.request(request)
puts response.read_body
python
import requests
import json
url = "https://api.cmp.optimizely.com/v3/work-requests/{id}/campaigns"
payload = json.dumps({
"title": "The awesome campaign",
"exclude_empty_fields": True
})
headers = {
'accept': 'application/json',
'content-type': 'application/json'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
201
// Created a campaign from a work request
{
"id": "8q7f910551b00a722e0418830cee6612",
"title": "The awesome campaign",
"description": "The awesome campaign's description",
"start_date": "2022-08-31T06:00:00Z",
"end_date": "2022-08-31T06:00:00Z",
"reference_id": "CPN-1589",
"owner_id": "8q7f910551b00a722e0418830cee6612",
"parent_campaign_id": "6679686ade80bdf1dfda5ec3ab32ddf",
"links": {
"self": "https://api.cmp.optimizely.com/v3/campaigns/8q7f910551b00a722e0418830cee6612",
"brief": "https://api.cmp.optimizely.com/v3/campaigns/8q7f910551b00a722e0418830cee6612/brief",
"parent_campaign": "https://api.cmp.optimizely.com/v3/campaigns/6679686ade80bdf1dfda5ec3ab32ddf"
}
}400
// Client error
{
"message": "Not found",
"errors": ""
}401
// Authorization error
{
"message": "Not found",
"errors": ""
}403
// Permission error
{
"message": "Not found",
"errors": ""
}404
// Not found error
{
"message": "Not found",
"errors": ""
}