Events and invitations
Create a roster, add invitees and send invitations. Track the difference between an invitation, a signature and an arrival.
Read the implementation guideList events
/v1/eventsEvery event with its invitee counts (invited, signed, bounced). Pass status to list only the active or only the closed ones.
Create an event
/v1/eventsCreates an event against a published template and returns its two shareable URLs: publicUrl, which signers open, and rosterUrl, the tokenized attendance list staff read at the door.
Retrieve an event roster
/v1/events/{id}Invitees are returned without email, phone, or their personal invite token: those are contact details the organization uploaded, not data this API hands back.
Update an event
/v1/events/{id}Omitted fields are left alone; startsAt, endsAt, locationId, and description sent as null are cleared.
Close an event
/v1/events/{id}/closeCloses an event. Both of its signing links stop accepting signatures. the shared public link and every invitee's personal one. and no further invitations can be sent. The roster link keeps working, read-only, and waivers already signed are unaffected.
Add event invitees
/v1/events/{id}/inviteesskipped counts entries with neither an email nor a phone, and ones already invited to this event.
Send event invitations
/v1/events/{id}/sendQueues an invitation for every invitee who has never been messaged. Already-messaged invitees are reminded one at a time through POST /v1/invitees/{id}/resend. Limited to 60 calls per minute per key.
Resend an invitation
/v1/invitees/{id}/resendSends one more invitation to a single invitee. the reminder path for someone who has already been messaged. POST /v1/events/{id}/send is the initial, whole-event send. Limited to 60 calls per minute per key.
Cancel an invitation
/v1/invitees/{id}/cancelCancels an invitation so its link can no longer be used and no reminder can be sent. A waiver the invitee has already signed is unaffected.
Before you connect
Use the scopes shown on each endpoint. Read the response schema and common errors, and keep mutations separate from diagnostic read requests.
AuthenticationError handlingOpenAPI contract