Update an event
In: header
Path Parameters
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
name, startsAt, and timezone are required on create.
Response Body
application/json
application/json
curl -X PATCH "https://example.com/events/string" \ -H "Content-Type: application/json" \ -d '{}'{ "data": { "id": "string", "workspaceId": "string", "name": "string", "slug": "string", "startsAt": "2019-08-24T14:15:22Z", "endsAt": "2019-08-24T14:15:22Z", "timezone": "string", "offerStartsAt": "2019-08-24T14:15:22Z", "status": "SCHEDULED", "formId": "string", "form": { "id": "string", "name": "string" }, "pipelineId": "string", "pipeline": { "id": "string", "name": "string" }, "productIds": [ "string" ], "showInCommunity": true, "counts": { "registered": 0, "PENDING": 0, "ATTENDED": 0, "LEFT_EARLY": 0, "NO_SHOW": 0, "UNCLASSIFIED": 0 }, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" }}Get an event GET
Requires `EVENTS_READ` (`CONTACTS_READ` or `CONTACTS_WRITE` also work). Includes `counts` by attendance. For app callers an event without `showInCommunity` is 404 "Event not shown in community.", and the response leaves out the CRM pipeline and any form apps can't see (see `Event`).
Delete an event DELETE
Deletes its registrations. Contacts and deals stay.
Planeward Docs