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

Register a member or contact

Requires `EVENT_REGISTRATIONS_WRITE` (`CONTACTS_WRITE` also works). Send `memberId` (required for app callers) or `contactId`. Safe to repeat. Returns 201 with `created: true` for a new registration, 200 with `created: false` when already registered. When the event has a pipeline, a new registration opens a deal in its first open stage. App callers can only register for events with `showInCommunity` on, and their response leaves out `contact` and `opportunityId`. A member without a primary contact gets one: their customer's contact with the customer's own email if there is one, else a new contact from the customer record. Another contact of the customer is never made primary, and the customer record is not changed.

POST
/events/{eventId}/registrations

Requires EVENT_REGISTRATIONS_WRITE (CONTACTS_WRITE also works). Send memberId (required for app callers) or contactId. Safe to repeat. Returns 201 with created: true for a new registration, 200 with created: false when already registered. When the event has a pipeline, a new registration opens a deal in its first open stage. App callers can only register for events with showInCommunity on, and their response leaves out contact and opportunityId. A member without a primary contact gets one: their customer's contact with the customer's own email if there is one, else a new contact from the customer record. Another contact of the customer is never made primary, and the customer record is not changed.

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; a member without a contact gets one created from their customer record.

Exactly one of memberId or contactId. App callers must send memberId; a member without a contact gets one created from their customer record.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/events/string/registrations" \  -H "Content-Type: application/json" \  -d '{    "memberId": "string"  }'
{  "data": {    "registration": {      "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"      }    },    "created": true  }}

List registrations GET

Previous Page

Cancel a member's or contact's registration DELETE

Requires `EVENT_REGISTRATIONS_WRITE` (`CONTACTS_WRITE` also works). Pass exactly one of `memberId` (required for app callers) or `contactId`. Safe to repeat: `cancelled` is false when there was no registration. Emits `event.registration_cancelled`. The contact and any deal stay.

memberId*string

Community membership id. The member must be ACTIVE.