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 a registration

Patch attendance, join/leave times, or the linked opportunity. Pass null on opportunityId to unlink. Contact and opportunity records stay. Changing attendance emits event.attendance_classified.

PATCH
/events/{eventId}/registrations/{contactId}

Patch attendance, join/leave times, or the linked opportunity. Pass null on opportunityId to unlink. Contact and opportunity records stay. Changing attendance emits event.attendance_classified.

Authorization

x-api-key<token>

In: header

Path Parameters

eventId*string
contactId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X PATCH "https://example.com/events/string/registrations/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "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"    }  }}

Get a contact's registration GET

404 when the contact is not registered.

Unregister a contact DELETE

The contact and opportunity stay.

attendance?AttendanceStatus

Value in

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