API Reference

Create Invitation

post
https://app2.keyless.rocks/api/invitations
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Form Data
string
required

Invitation name

string
required

Email to invite

int32
required

Smart Home asset id

string
required

Start date of invitation - Format (YYYY-MM-DD)

string

optional. End date of invitation - Format (YYYY-MM-DD)

string

optional. Boolean. Default false.

int64

optional. Invitation phone number

string

Integer. Passcode attached with invitation. Need to be passed if offline_invitation is false.

int32

optional. Fob number attached with invitation (Should be 10 digits long)

string

Optional; if pass in source as 'ApiAutomation', the 'added_by' field will appear as '’ (empty string) for Invitation Details and List of Invitations api.

Headers
string
enum
Defaults to Success

Generated from available response content types

Responses

401

Unauthorized

403

Forbidden

Updated over 1 year ago

Did this page help you?
Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
Success
Failure
Failure-ToDateaspastdate
Failure-Invitation already exist for email
Failure-Security code already exist
Success-From Date is past date
Failure-Name Required
Failure-Email Required
Failure-Property ID Required
Failure-Invalid Property ID
Failure-Invalid Offline Invitation parameter
Failure-Required Security Code
Failure-Invalid Security Code
Failure-Security Code for Offline Invitation
Failure-Fob Id for Offline Invitation
Failure-From date is required
Failure-From Date is invalid
Failure-To Date is invalid
Failure-Invalid date range

Updated over 1 year ago

Did this page help you?