curl --request POST \
--url https://api.zuddl.com/v1/events \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"title": "<string>",
"startDateTime": "2023-11-07T05:31:56Z",
"tz": "<string>",
"teamId": "<string>",
"description": "<string>",
"endDateTime": "2023-11-07T05:31:56Z",
"brandKitId": "<string>",
"salesforceCampaignId": "<string>",
"tagNames": [
"<string>"
],
"languageCodes": [
"<string>"
]
}
'import requests
url = "https://api.zuddl.com/v1/events"
payload = {
"title": "<string>",
"startDateTime": "2023-11-07T05:31:56Z",
"tz": "<string>",
"teamId": "<string>",
"description": "<string>",
"endDateTime": "2023-11-07T05:31:56Z",
"brandKitId": "<string>",
"salesforceCampaignId": "<string>",
"tagNames": ["<string>"],
"languageCodes": ["<string>"]
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: '<string>',
startDateTime: '2023-11-07T05:31:56Z',
tz: '<string>',
teamId: '<string>',
description: '<string>',
endDateTime: '2023-11-07T05:31:56Z',
brandKitId: '<string>',
salesforceCampaignId: '<string>',
tagNames: ['<string>'],
languageCodes: ['<string>']
})
};
fetch('https://api.zuddl.com/v1/events', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.zuddl.com/v1/events",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'title' => '<string>',
'startDateTime' => '2023-11-07T05:31:56Z',
'tz' => '<string>',
'teamId' => '<string>',
'description' => '<string>',
'endDateTime' => '2023-11-07T05:31:56Z',
'brandKitId' => '<string>',
'salesforceCampaignId' => '<string>',
'tagNames' => [
'<string>'
],
'languageCodes' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.zuddl.com/v1/events"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"startDateTime\": \"2023-11-07T05:31:56Z\",\n \"tz\": \"<string>\",\n \"teamId\": \"<string>\",\n \"description\": \"<string>\",\n \"endDateTime\": \"2023-11-07T05:31:56Z\",\n \"brandKitId\": \"<string>\",\n \"salesforceCampaignId\": \"<string>\",\n \"tagNames\": [\n \"<string>\"\n ],\n \"languageCodes\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.zuddl.com/v1/events")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"startDateTime\": \"2023-11-07T05:31:56Z\",\n \"tz\": \"<string>\",\n \"teamId\": \"<string>\",\n \"description\": \"<string>\",\n \"endDateTime\": \"2023-11-07T05:31:56Z\",\n \"brandKitId\": \"<string>\",\n \"salesforceCampaignId\": \"<string>\",\n \"tagNames\": [\n \"<string>\"\n ],\n \"languageCodes\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zuddl.com/v1/events")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"<string>\",\n \"startDateTime\": \"2023-11-07T05:31:56Z\",\n \"tz\": \"<string>\",\n \"teamId\": \"<string>\",\n \"description\": \"<string>\",\n \"endDateTime\": \"2023-11-07T05:31:56Z\",\n \"brandKitId\": \"<string>\",\n \"salesforceCampaignId\": \"<string>\",\n \"tagNames\": [\n \"<string>\"\n ],\n \"languageCodes\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"status": "NEEDS_INPUT",
"eventId": "<string>",
"eventUrl": "<string>"
}{
"timestamp": "2023-11-07T05:31:56Z",
"message": "<string>",
"description": "<string>",
"code": "<string>",
"params": {},
"errors": {}
}{
"timestamp": "2023-11-07T05:31:56Z",
"message": "<string>",
"description": "<string>",
"code": "<string>",
"params": {},
"errors": {}
}{
"timestamp": "2023-11-07T05:31:56Z",
"message": "<string>",
"description": "<string>",
"code": "<string>",
"params": {},
"errors": {}
}{
"timestamp": "2023-11-07T05:31:56Z",
"message": "<string>",
"description": "<string>",
"code": "<string>",
"params": {},
"errors": {}
}Create an event
Creates a conference, virtual event, webinar, field event or third-party event. The kind is set by eventType, and for a STANDARD event the eventFormat separates a Conference (HYBRID) from a Virtual event (VIRTUAL). Returns 422 with every problem at once when something is missing or ambiguous.
Required API key scopes: WRITE
This API can only be called with an access key that was generated for Backend usage.
curl --request POST \
--url https://api.zuddl.com/v1/events \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"title": "<string>",
"startDateTime": "2023-11-07T05:31:56Z",
"tz": "<string>",
"teamId": "<string>",
"description": "<string>",
"endDateTime": "2023-11-07T05:31:56Z",
"brandKitId": "<string>",
"salesforceCampaignId": "<string>",
"tagNames": [
"<string>"
],
"languageCodes": [
"<string>"
]
}
'import requests
url = "https://api.zuddl.com/v1/events"
payload = {
"title": "<string>",
"startDateTime": "2023-11-07T05:31:56Z",
"tz": "<string>",
"teamId": "<string>",
"description": "<string>",
"endDateTime": "2023-11-07T05:31:56Z",
"brandKitId": "<string>",
"salesforceCampaignId": "<string>",
"tagNames": ["<string>"],
"languageCodes": ["<string>"]
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: '<string>',
startDateTime: '2023-11-07T05:31:56Z',
tz: '<string>',
teamId: '<string>',
description: '<string>',
endDateTime: '2023-11-07T05:31:56Z',
brandKitId: '<string>',
salesforceCampaignId: '<string>',
tagNames: ['<string>'],
languageCodes: ['<string>']
})
};
fetch('https://api.zuddl.com/v1/events', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.zuddl.com/v1/events",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'title' => '<string>',
'startDateTime' => '2023-11-07T05:31:56Z',
'tz' => '<string>',
'teamId' => '<string>',
'description' => '<string>',
'endDateTime' => '2023-11-07T05:31:56Z',
'brandKitId' => '<string>',
'salesforceCampaignId' => '<string>',
'tagNames' => [
'<string>'
],
'languageCodes' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.zuddl.com/v1/events"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"startDateTime\": \"2023-11-07T05:31:56Z\",\n \"tz\": \"<string>\",\n \"teamId\": \"<string>\",\n \"description\": \"<string>\",\n \"endDateTime\": \"2023-11-07T05:31:56Z\",\n \"brandKitId\": \"<string>\",\n \"salesforceCampaignId\": \"<string>\",\n \"tagNames\": [\n \"<string>\"\n ],\n \"languageCodes\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.zuddl.com/v1/events")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"startDateTime\": \"2023-11-07T05:31:56Z\",\n \"tz\": \"<string>\",\n \"teamId\": \"<string>\",\n \"description\": \"<string>\",\n \"endDateTime\": \"2023-11-07T05:31:56Z\",\n \"brandKitId\": \"<string>\",\n \"salesforceCampaignId\": \"<string>\",\n \"tagNames\": [\n \"<string>\"\n ],\n \"languageCodes\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zuddl.com/v1/events")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"<string>\",\n \"startDateTime\": \"2023-11-07T05:31:56Z\",\n \"tz\": \"<string>\",\n \"teamId\": \"<string>\",\n \"description\": \"<string>\",\n \"endDateTime\": \"2023-11-07T05:31:56Z\",\n \"brandKitId\": \"<string>\",\n \"salesforceCampaignId\": \"<string>\",\n \"tagNames\": [\n \"<string>\"\n ],\n \"languageCodes\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"status": "NEEDS_INPUT",
"eventId": "<string>",
"eventUrl": "<string>"
}{
"timestamp": "2023-11-07T05:31:56Z",
"message": "<string>",
"description": "<string>",
"code": "<string>",
"params": {},
"errors": {}
}{
"timestamp": "2023-11-07T05:31:56Z",
"message": "<string>",
"description": "<string>",
"code": "<string>",
"params": {},
"errors": {}
}{
"timestamp": "2023-11-07T05:31:56Z",
"message": "<string>",
"description": "<string>",
"code": "<string>",
"params": {},
"errors": {}
}{
"timestamp": "2023-11-07T05:31:56Z",
"message": "<string>",
"description": "<string>",
"code": "<string>",
"params": {},
"errors": {}
}Authorizations
Provide your API key secret in the Authorization header
Body
Event type, in the public taxonomy shared with every /v1 read: EVENT covers both Conference and Virtual event (eventFormat distinguishes them), FIELD_EVENT, WEBINAR, THIRD_PARTY_EVENT. Determines which other fields apply.
EVENT, FIELD_EVENT, WEBINAR, THIRD_PARTY_EVENT Name of the event.
400IANA timezone of the event, e.g. Asia/Kolkata. Required.
50Identifier of the owning team. Required.
1Description of the event. Required. Rich-text HTML.
20000End of the event. Required, and must be after startDateTime.
VIRTUAL, IN_PERSON or HYBRID. Applies to EVENT only — it is what separates a Conference from a Virtual event. Set by the server for every other type.
VIRTUAL, IN_PERSON, HYBRID Show child attributes
Show child attributes
Identifier of a published brand kit to apply.
Salesforce campaign ID to link. Some organizations require it; a 422 says so.
Names of existing organization tags. Maximum 10. Never created implicitly.
10Names of existing organization tags. Maximum 10. Never created implicitly.
Response
Event created
Result of a successful create. A request that cannot proceed is a 422 ApiErrorResponse instead.
NEEDS_INPUT when the request cannot proceed, CREATED when the event exists.
NEEDS_INPUT, CREATED Identifier of the created event. Present only when status is CREATED.
Link to the created event's setup page. Present only when status is CREATED.
Was this page helpful?