PlanewardPlaneward Docs
PlanewardPlaneward Docs
Welcome

Developers

REST APIAuthenticationWebhooksMCPEmbedded projectsTask description contentDeveloper hub

API

List events GETCreate an event POSTGet an event GETUpdate an event PATCHDelete an event DELETEList registrations GETRegister a member or contact POSTCancel a member's or contact's registration DELETEGet a contact's registration GETUpdate a registration PATCHUnregister a contact DELETEImport attendance POSTSet one registrant's attendance PUT
Events

Update an event

PATCH
/events/{eventId}

Authorization

x-api-key<token>

In: header

Path Parameters

eventId*string

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.

name?string
slug?string

Lowercase letters, numbers, dashes. Defaults to the name plus the start date.

startsAt?string
Formatdate-time
endsAt?string
Formatdate-time
timezone?string

IANA timezone.

offerStartsAt?string
Formatdate-time
status?string

Value in

  • "SCHEDULED"
  • "LIVE"
  • "ENDED"
  • "CANCELLED"
formId?string

Submissions register the contact while SCHEDULED or LIVE.

pipelineId?string

Each registration opens a deal in the first open stage.

productIds?array<string>

Products whose buyers are registered once they pay. On update, replaces the whole set; omit to keep it.

Itemsitems <= 50