POST /events

1 min

POST

https://api.cmp.optimizely.com/v3/events

Experimental Create an event.

Body Parameters

bodyEventCreateRequestrequired
Description
Payload to create a new event
- titlestringrequired
  Example
  The awesome event
  Description
  Title of the event
- descriptionstring
  Example
  This awesome event is created to celebrate our clients
  Description
  Description of the event
- campaign_idstring
  Example
  8p7f91i55722y04188a30cee6612
  Description
  ID of the campaign under which the event is to be created
- is_all_daybooleanrequired
  Description
  Indicate if the event is all day long
- start_datestring<date-time>required
  Example
  1996-09-09T12:18:00Z
  Description
  Start date and time of the event in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
  Format
  date-time
- end_datestring<date-time>required
  Example
  2024-12-24T12:18:00Z
  Description
  End date and time of the event in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
  Format
  date-time
- fieldsAssetTypeObjectField[]
  Description
  List of fields to be associated with the event
  - BaseObjectField
    - typestringrequired
      Example
      checkbox
      Description
      Type of the field
    - valuesundefined[]required
      Description
      Values for the campaign field
    - idstringrequired
      Example
      41aac313bda1e40b6cde7116fc24a
      Description
      Unique identifier of the field
  - AssetTypeObjectFieldUpdatePayload
    - typestringrequired
      Example
      checkbox
      Description
      Type of the field
    - valuesundefined[]required
      Description
      Payload for fields with attachments

Responses

201Created event details

EventResponse
- idstringrequired
  Example
  674ea40a7a9cac80ff78c95c
  Description
  Unique identifier of the event
- titlestringrequired
  Example
  The awesome event
  Description
  Title of the event
- descriptionstringrequired
  Example
  The awesome event's description
  Description
  Description of the event
- campaign_idstringrequired
  Example
  66d953340019d7b86833ac6dg
  Description
  Unique identifier of the campaign associated with the event
- start_datestringrequired
  Example
  2024-11-26T11:00:34Z
  Description
  Start date of the event in ISO 8601 UTC format
- end_datestringrequired
  Example
  2024-11-26T11:30:34Z
  Description
  End date of the event in ISO 8601 UTC format
- is_all_daybooleanrequired
  Description
  Whether the event is a day long event or not
- is_archivedbooleanrequired
  Description
  Whether the event is archived or not
- created_bystringrequired
  Example
  66d837c62373533177b59db3
  Description
  Unique identifier of the user who created the event
- reference_idstringrequired
  Example
  EVT-3
  Description
  Reference ID of the event
- linksobjectrequired
  Description
  Meta links
  - selfstringrequired
    Example
    https://api.cmp.optimizely.com/v3/events/674ea40a7a9cac80ff78c95c
    Description
    URL of the event
  - campaignstringrequired
    Example
    https://api.cmp.optimizely.com/v3/campaigns/66d953340019d7b86833ac6d
    Description
    URL of the campaign associated with the event

400Client error

Error
Example
```
{
  "message": "Unsupported arguments: a,b,c"
}
```
Description
Error payload
- messagestringrequired
  Example
  Not found
  Description
  Message describing the error
- errorsmap<string, string>
  Description
  Additional information

401Authorization error

Error
Example
```
{
  "message": "Unauthorized"
}
```
Description
Error payload
- messagestringrequired
  Example
  Not found
  Description
  Message describing the error
- errorsmap<string, string>
  Description
  Additional information

403Permission error

Error
Example
```
{
  "message": "You do not have the permission to perform this operation"
}
```
Description
Error payload
- messagestringrequired
  Example
  Not found
  Description
  Message describing the error
- errorsmap<string, string>
  Description
  Additional information

404Not found error

Error
Example
```
{
  "message": "Resource not found"
}
```
Description
Error payload
- messagestringrequired
  Example
  Not found
  Description
  Message describing the error
- errorsmap<string, string>
  Description
  Additional information

422Unprocessable entity error

Error
Example
```
{
  "message": "Resource cannot be processed"
}
```
Description
Error payload
- messagestringrequired
  Example
  Not found
  Description
  Message describing the error
- errorsmap<string, string>
  Description
  Additional information

curl

curl --request POST \
     --url https://api.cmp.optimizely.com/v3/events \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "title": "The awesome event",
     "is_all_day": false,
     "start_date": "1996-09-09T12:18:00Z",
     "end_date": "2024-12-24T12:18:00Z",
     "fields": {
     "type": "checkbox",
     "values": [],
     "id": "41aac313bda1e40b6cde7116fc24a"
     }
     }'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var raw = JSON.stringify({
   "title": "The awesome event",
   "is_all_day": false,
   "start_date": "1996-09-09T12:18:00Z",
   "end_date": "2024-12-24T12:18:00Z",
   "fields": {
      "type": "checkbox",
      "values": [],
      "id": "41aac313bda1e40b6cde7116fc24a"
   }
});

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://api.cmp.optimizely.com/v3/events", 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/events")

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 event",
   "is_all_day": false,
   "start_date": "1996-09-09T12:18:00Z",
   "end_date": "2024-12-24T12:18:00Z",
   "fields": {
      "type": "checkbox",
      "values": [],
      "id": "41aac313bda1e40b6cde7116fc24a"
   }
})

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://api.cmp.optimizely.com/v3/events"

payload = json.dumps({
   "title": "The awesome event",
   "is_all_day": False,
   "start_date": "1996-09-09T12:18:00Z",
   "end_date": "2024-12-24T12:18:00Z",
   "fields": {
      "type": "checkbox",
      "values": [],
      "id": "41aac313bda1e40b6cde7116fc24a"
   }
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

201

// Created event details
{
  "id": "674ea40a7a9cac80ff78c95c",
  "title": "The awesome event",
  "description": "The awesome event's description",
  "campaign_id": "66d953340019d7b86833ac6dg",
  "start_date": "2024-11-26T11:00:34Z",
  "end_date": "2024-11-26T11:30:34Z",
  "is_all_day": false,
  "is_archived": false,
  "created_by": "66d837c62373533177b59db3",
  "reference_id": "EVT-3",
  "links": {
    "self": "https://api.cmp.optimizely.com/v3/events/674ea40a7a9cac80ff78c95c",
    "campaign": "https://api.cmp.optimizely.com/v3/campaigns/66d953340019d7b86833ac6d"
  }
}

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": ""
}

422

// Unprocessable entity error
{
  "message": "Not found",
  "errors": ""
}