Create an Entry

Create an entry (visitor sign-in).

Required Fields:

  • locationId: The location where the entry is being created
  • flowId: The sign-in flow to use for this entry
  • fullName: Full name of the visitor

Optional Fields:

  • email: Email address of the visitor
  • signedInAt: DateTime when the visitor signed in (defaults to current time if not provided)
  • photoBase64: Base64-encoded photo of the visitor
  • printBadge: Trigger badge printing (defaults to false)
  • notifyHost: Send notification to host employee (defaults to false)
  • customFields: Array of custom field responses (see below)

Important Notes about customFields:

  • The customFields parameter is an array of custom field responses that correspond to the sign-in fields configured in the flow
  • Common fields include:
    • Host: The name of the employee hosting the visitor (the system will automatically look up the employee by name)
    • Purpose of visit: The reason for the visit
    • Your Full Name: Visitor's full name (may be pre-populated)
    • Your Email Address: Visitor's email (may be pre-populated)
    • Company Name or Your Company: The visitor's company name
    • Additional custom fields specific to your flow configuration
  • The exact fields required depend on the flow configuration. Query the flow's sign-in fields to see what's expected.
Language
Credentials
Click Try It! to start a request and see the response here!