Draft a team sharing kit

POST/v1/event/{eventId}/sharing/team-kit

US Region: https://public-api.sessionboard.com · EU Region: https://public-api-eu.sessionboard.com

Drafts a kit your team shares: one LinkedIn post per image with its copy. Before the webinar starts it uses the share cards ("Save your seat", spread over the days left); after, the recording's clips ("Watch on-demand"; clip_ids picks them, else the first three). Returns the draft's dispatch_id and url (a relative admin path) where a person picks the team and sends it. Nothing is sent; the webinar's open draft is returned instead of a second one. Requires write:marketing.

Request example

cURL

curl --request POST \
  --url 'https://public-api.sessionboard.com/v1/event/{eventId}/sharing/team-kit' \
  --header 'x-access-token: <api-token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "channel": "email"
}'

JavaScript

const response = await fetch('https://public-api.sessionboard.com/v1/event/{eventId}/sharing/team-kit', {
  method: 'POST',
  headers: {
    "x-access-token": "<api-token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "channel": "email"
  }),
});

const data = await response.json();
console.log(data);

Python

import requests

response = requests.request(
    "POST",
    "https://public-api.sessionboard.com/v1/event/{eventId}/sharing/team-kit",
    headers={
        "x-access-token": "<api-token>",
        "Content-Type": "application/json"
    },
    json={
        "channel": "email"
    },
)

print(response.json())

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://public-api.sessionboard.com/v1/event/{eventId}/sharing/team-kit",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_POSTFIELDS => '{
  "channel": "email"
}',
    CURLOPT_HTTPHEADER => [
        "x-access-token: <api-token>",
        "Content-Type: application/json",
    ],
]);

$response = curl_exec($curl);
curl_close($curl);

echo $response;

Go

package main

import (
  "fmt"
  "io"
  "net/http"
  "strings"
)

func main() {
  req, _ := http.NewRequest("POST", "https://public-api.sessionboard.com/v1/event/{eventId}/sharing/team-kit", strings.NewReader(`{
  "channel": "email"
}`))
  req.Header.Add("x-access-token", "<api-token>")
  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))
}

Java

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://public-api.sessionboard.com/v1/event/{eventId}/sharing/team-kit"))
    .header("x-access-token", "<api-token>")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\n  \"channel\": \"email\"\n}"))
    .build();

HttpResponse<String> response = HttpClient.newHttpClient()
    .send(request, HttpResponse.BodyHandlers.ofString());

System.out.println(response.body());

Try it

RegionUS Region — https://public-api.sessionboard.comEU Region — https://public-api-eu.sessionboard.com

Authorization

Send asAPI token (x-access-token)OAuth access token (Bearer)

Token

Your token stays in this page. It is sent only to the region above and is never saved; it is gone when you leave or reload the page.

Path parameters

eventId*

Body application/json

{ "channel": "email" }

POST

Send request

Authorizations

• x-access-tokenstringheader

  Organization API token. Generate from Organization Settings → API Tokens.

• AuthorizationBearer <token>headeror

  OAuth 2.1 access token. Obtained via the OAuth PKCE flow at /oauth/token.

Send one of these. See Authentication.

Path parameters

• eventIdintegerpathrequired

  The webinar's event id.

Request body

application/jsonrequired

• channelstringrequired

  How the team will get it (both = chat and email). Preselects the recipients tab.

  Allowed values

  "email", "slack", "teams", "both"

• clip_idsstring[]

  Max items

  10

Example

{
  "channel": "email"
}

Responses

201application/json

The draft.

• successboolean
• payloadobject
  Show child attributes

  • dispatch_idstring
  • urlstring

403

• SCOPE_REQUIRED: the token lacks read:events (reads) or write:marketing (writes).
• EVENT_NOT_ALLOWED: the event is outside the token's event allow-list.
• Otherwise the token's user cannot read (or edit) sharing on this webinar.

409

The event is not a webinar.

Response examples

201

{
  "success": true,
  "payload": {
    "dispatch_id": "<string>",
    "url": "<string>"
  }
}