Skip to main content
POST
/
v1
/
guests
/
register
Register a guest
curl --request POST \
  --url https://envelope.so/api/v1/guests/register \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "eventId": "<string>",
  "formData": {
    "properties": {
      "email": "<string>",
      "firstName": "<string>",
      "lastName": "<string>"
    },
    "partners": 1,
    "givenConsents": [
      "<string>"
    ]
  },
  "guestId": "<string>",
  "pageId": "<string>"
}
'
{
  "_id": "<string>",
  "event": "<string>",
  "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"
    ]
  },
  "confirmedAt": "2023-11-07T05:31:56Z",
  "attendedAt": "2023-11-07T05:31:56Z",
  "starred": false
}

Documentation Index

Fetch the complete documentation index at: https://docs.envelope.so/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
eventId
string
required

ID of the event

​
formData
object
required
​
guestId
string

ID of existing guest if updating

​
pageId
string

ID of the page containing the form

Response

Guest registered successfully.

​
_id
string
required

Guest ID

​
event
string
required

Event ID

​
status
object
required

Guest status information including confirmation, attendance, consents and check-in details

Example:
{
  "confirmation": 2,
  "attendance": 1,
  "declineMessage": null,
  "givenConsents": [],
  "visitedZones": [],
  "addMethod": "publicRegistration",
  "checkInMethod": "qrScan"
}
​
properties
object
required

Guest properties including default required fields and any custom properties defined for the event

Example:
{
  "firstName": "John",
  "lastName": "Doe",
  "email": "john@example.com",
  "lang": "en",
  "X62TkjiV": "My custom note",
  "yN9hzaCj": "1QLXYBlw",
  "Ybb48GO7": ["7bR7m2au", "BdwYyYmi"]
}
​
confirmedAt
string<date-time> | null

Date and time when the guest was confirmed

​
attendedAt
string<date-time> | null

Date and time when the guest attended the event

​
starred
boolean
default:false

Indicates if the guest is starred