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

Set one registrant's attendance

Requires `EVENT_REGISTRATIONS_WRITE` (`CONTACTS_WRITE` also works). Send `memberId` (required for app callers) or `contactId`. The registrant must be registered. Changing attendance emits `event.attendance_classified`. App callers can only use events with `showInCommunity` on, and their response leaves out `contact` and `opportunityId`.

PUT
/events/{eventId}/attendance

Requires EVENT_REGISTRATIONS_WRITE (CONTACTS_WRITE also works). Send memberId (required for app callers) or contactId. The registrant must be registered. Changing attendance emits event.attendance_classified. App callers can only use events with showInCommunity on, and their response leaves out contact and opportunityId.

Authorization

x-api-key<token>

In: header

Path Parameters

eventId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Exactly one of memberId or contactId. App callers must send memberId. The registrant must already be registered.

Response Body

application/json

application/json

application/json

application/json

curl -X PUT "https://example.com/events/string/attendance" \  -H "Content-Type: application/json" \  -d '{    "attendance": "PENDING"  }'
{  "data": {    "id": "string",    "eventId": "string",    "contactId": "string",    "opportunityId": "string",    "paymentId": "string",    "registeredAt": "2019-08-24T14:15:22Z",    "confirmationSentAt": "2019-08-24T14:15:22Z",    "attendance": "PENDING",    "joinedAt": "2019-08-24T14:15:22Z",    "leftAt": "2019-08-24T14:15:22Z",    "classifiedAt": "2019-08-24T14:15:22Z",    "contact": {      "id": "string",      "name": "string",      "email": "string"    }  }}

Import attendance POST

Rows match registrants by email. An explicit `status` wins; otherwise no `joinedAt` is NO_SHOW, leaving before the event's `offerStartsAt` is LEFT_EARLY, and anything else is ATTENDED. Registrants with no row get `missing`. More than 200 rows returns `{ jobId }` — poll `GET /jobs/{jobId}`.

List forms GET

Requires `FORMS_READ` or `FORMS_SUBMIT` (`FORMS_WRITE` covers both). Callers holding `FORMS_SUBMIT` without `FORMS_READ`, which includes every app caller (apps can't be granted `FORMS_READ`), see only published forms with `showInCommunity` on, with the real `submissionCount` and only the render part of `settings` (`respondent`, `theme`, `css`; see `Form`). A 403 to an app names `FORMS_SUBMIT`, the scope an app can be granted.

memberId?string
contactId?string

Workspace API keys only.

attendance*AttendanceStatus

Value in

  • "PENDING"
  • "ATTENDED"
  • "LEFT_EARLY"
  • "NO_SHOW"
  • "UNCLASSIFIED"
joinedAt?string
Formatdate-time
leftAt?string
Formatdate-time