headless lms

Update an event you run

PATCH /api/member/events/{eventId}. Update an event you run. Headless LMS Events API reference.

PATCH
/api/member/events/{eventId}

Requires events:write. Changes only the fields sent; status publishes or unpublishes it. thumbnailAssetId must be a ready library image (409 conflict otherwise); null clears it. A file it does not already use must be uploaded for it, or the caller needs media:read (403 otherwise). 409 canceled when the event is canceled.

Path Parameters

eventId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/api/member/events/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "orgId": "string",  "id": "string",  "type": "event",  "title": "string",  "description": "string",  "thumbnailAssetId": "string",  "status": "draft",  "startsAt": "2019-08-24T14:15:22Z",  "endsAt": "2019-08-24T14:15:22Z",  "timeZone": "string",  "location": {    "venue": {      "name": "string",      "address": {        "line1": "string",        "line2": "string",        "city": "string",        "region": "string",        "postalCode": "string",        "country": "string"      }    },    "online": {      "url": "http://example.com",      "details": "string"    }  },  "recording": {    "url": "http://example.com",    "details": "string"  },  "settings": {    "type": "public",    "capacity": 1,    "notifications": true,    "replay": true  },  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "thumbnailUrl": "string"}
{  "error": "string",  "message": "string",  "requestId": "string",  "issues": [    {      "path": "string",      "message": "string"    }  ]}
{  "error": "string",  "message": "string",  "requestId": "string"}
{  "error": "string",  "message": "string",  "requestId": "string"}
{  "error": "string",  "message": "string",  "requestId": "string"}
{  "error": "string",  "message": "string",  "requestId": "string"}
{  "error": "string",  "message": "string",  "requestId": "string"}