HomeGuidesAPI Reference
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference

Create a new guest visitor of a portal

Create a new guest visitor of a portal

Path Params
string
required

Portal ID of the splash page

Body Params

visitor data

string
required

Visitor account name

id
object

NA for visitor post/put method. ID of the visitor

company_name
object

Company name of the visitor

user
object
boolean
Defaults to true

Enable or disable the visitor account

boolean
Defaults to false

Visitor account will not expire when this is set to true

integer

Account validity in days

integer

Account validity in hours

integer

Account validity in minutes

boolean
Defaults to false

Flag to notify the password via email or number

string
enum
Defaults to phone

Notify to email or phone. Defualt is phone when it is provided otherwise email.

Allowed:
password
object

Password

boolean

This field provides status of the account. Returns true when enabled and not expired. NA for visitor post/put method. This is optional fields.

created_at
object

This field indicates the created date timestamp value. It is generated while creating visitor. NA for visitor post/put method. This is optional field.

expire_at
object

This field indicates expiry time timestamp value. It is generated based on the valid_till value and created_at time. NA for visitor post/put method. This is optional field

Responses

401

Unauthorized

413

Request-size limit exceeded

429

API rate limit exceeded

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