Skip to content

Move, cancel or end a premiere

PUT/v1/organization/{orgId}/marketing/video/premieres/{premiereId}

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

Move it (startsAt; reminders go again for the new time), cancel it (status: cancelled), stop taking questions (qaOpen: false) or end it now (end: true; on demand from this moment). This changes what visitors see. Requires write:marketing; refused for a key restricted to particular events. Also at PUT /v1/marketing/video/premieres/{premiereId}.

Request example

Terminal window
curl --request PUT \
--url 'https://public-api.sessionboard.com/v1/organization/{orgId}/marketing/video/premieres/{premiereId}' \
--header 'x-access-token: <api-token>' \
--header 'Content-Type: application/json' \
--data '{
"startsAt": "<string>",
"status": "scheduled",
"qaOpen": true,
"title": "<string>",
"end": true
}'

Try it

Authorization

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
Body application/json
PUT

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

  • orgIdstringpathrequired

    Your organization ID. Any other organization returns 404.

  • premiereIdstring<uuid>pathrequired

    The premiere

Request body

application/jsonrequired

  • startsAtstring

    ISO 8601 with a timezone offset

  • statusstring
    Allowed values
    "scheduled", "cancelled"
  • qaOpenboolean
  • titlestring
    Max length
    255
  • endboolean

    End it now

{
"startsAt": "<string>",
"status": "scheduled",
"qaOpen": true,
"title": "<string>",
"end": true
}

Responses

200application/json

payload.premiere, a Premiere

  • payloadobject
    Show child attributes
    • premierePremiere
      Show child attributes
      • idstring
      • event_idinteger
      • media_idstring
      • titlestring | null
      • starts_atstring<date-time>
      • duration_snumber
      • statusstring
        Allowed values
        "scheduled", "cancelled"
      • qa_openboolean
      • statestring
        Allowed values
        "upcoming", "live", "ended", "cancelled"
      • position_snumber | null

        While live, where everyone is (seconds)

      • remindersinteger

        People who asked for a reminder (list only)

      • questionsinteger

        Questions asked (list only)

400

A start in the past or an unknown status.

403

  • SCOPE_REQUIRED — the token lacks read:marketing (reads) or write:marketing (writes).
  • ORG_WIDE_TOKEN_REQUIRED — the token is restricted to particular events; this operation reads the whole organization.
  • FORBIDDEN — the organization's plan does not include Marketing, or the token's user cannot change goals (writes need an organization admin or the organization settings permission).

404

Not found in your organization.

Response examples

{
"payload": {
"premiere": {
"id": "<string>",
"event_id": 123,
"media_id": "<string>",
"title": "<string>",
"starts_at": "2026-01-15T09:30:00Z",
"duration_s": 123.45,
"status": "scheduled",
"qa_open": true,
"state": "upcoming",
"position_s": 123.45,
"reminders": 123,
"questions": 123
}
}
}