ENenvelope
Guests

Check in a guest

Records guest attendance by checking them in to the event or specific zone.

post/v1/guests/{_id}/check-in

Request

  • Base URL
    https://envelope.so/api
  • Auth
    API key in header x-api-key

Path parameters

_idstring required

Guest ID to check in.

Request body

eventIdstring required

ID of the event

incrementByinteger

Number to increment attendance by

method'qrScan' | 'manual'

Method used for check-in

zoneIdstring

ID of the zone if checking into specific zone

Response

Guest checked in successfully.

_idstring required

Guest ID

eventstring required

Event ID

confirmedAtstring date-time nullable

Date and time when the guest was confirmed

attendedAtstring date-time nullable

Date and time when the guest attended the event

starredboolean

Indicates if the guest is starred

Example response

{
  "status": {
    "confirmation": 2,
    "attendance": 1,
    "declineMessage": null,
    "givenConsents": [],
    "visitedZones": [],
    "addMethod": "publicRegistration",
    "checkInMethod": "qrScan"
  },
  "properties": {
    "firstName": "John",
    "lastName": "Doe",
    "email": "john@example.com",
    "lang": "en",
    "X62TkjiV": "My custom note",
    "yN9hzaCj": "1QLXYBlw",
    "Ybb48GO7": [
      "7bR7m2au",
      "BdwYyYmi"
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.