Create an Invite

Create an invite. Note that the flow and employee (if these are provided) must match up with the location, or invite creation may not succeed.

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 (you can also use the hostEmployeeId field to set this directly)
  • Purpose of visit: The reason for the visit (typically required and must match the flow name)
  • Your Full Name: Visitor's full name (may be pre-populated from the invite data)
  • Your Email Address: Visitor's email (may be pre-populated from the invite data)
  • 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.
• For employee registration flows, the host field is typically not required.