Update an Invite

Update an invite. Note that the flow and employee (if these are provided) must match up with the location, or the invite update 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
    • Your Email Address: Visitor's email
    • Company Name or Your Company: The visitor's company name
    • Additional custom fields specific to your flow configuration
  • The exact fields depend on the flow configuration. Query the flow's sign-in fields to see what's available.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The inviteId of the invite that you would like to update.

Body Params
invite
object
Response

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json