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

Import attendance

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}`.

POST
/events/{eventId}/attendance

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}.

Authorization

x-api-key<token>

In: header

Path Parameters

eventId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/events/string/attendance" \  -H "Content-Type: application/json" \  -d '{    "rows": [      {        "email": "string"      }    ]  }'
{  "data": {    "jobId": "string",    "counts": {      "registered": 0,      "PENDING": 0,      "ATTENDED": 0,      "LEFT_EARLY": 0,      "NO_SHOW": 0,      "UNCLASSIFIED": 0    },    "unmatchedEmails": [      "string"    ]  }}

Unregister a contact DELETE

The contact and opportunity stay.

Set one registrant's attendance PUT

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`.

missing?string
Default"NO_SHOW"

Value in

  • "NO_SHOW"
  • "UNCLASSIFIED"
rows*array<>
Itemsitems <= 20000