Create a new guest visitor of a portal

post

https://{api-base-url}/guest/v1/portals/{portal_id}/visitors

Path Params

portal_id

string

required

Portal ID of the splash page

Body Params

visitor data

name

string

required

Visitor account name

object

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

company_name

object

Company name of the visitor

user

object

is_enabled

boolean

Defaults to true

Enable or disable the visitor account

valid_till_no_limit

boolean

Defaults to false

Visitor account will not expire when this is set to true

valid_till_days

integer

Account validity in days

valid_till_hours

integer

Account validity in hours

valid_till_minutes

integer

Account validity in minutes

notify

boolean

Defaults to false

Flag to notify the password via email or number

notify_to

string

enum

Defaults to phone

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

Allowed:

password

object

Password

status

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

201Successful response

400Bad Request, Object already exists or Invalid Parameters

403Forbidden

404Not Found

500Internal Server Error