{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/pincodes/","auth":"required","results":{"codes":[{"status":200,"language":"json","code":"{\n  \"id\": 23,//the id of the created pincode\n}","name":""}]},"settings":"","examples":{"codes":[]},"method":"post","params":[{"name":"propertyUid","type":"string","default":"","desc":"Unique id of the property","required":true,"in":"body","ref":"","_id":"57720c1b92c56c0e00b381b8"},{"name":"startDateTime","type":"datetime","default":"","desc":"Start date and time","required":true,"in":"body","ref":"","_id":"57720c1b92c56c0e00b381b7"},{"name":"endDateTime","type":"datetime","default":"","desc":"End date and time","required":true,"in":"body","ref":"","_id":"57720c1b92c56c0e00b381b6"},{"name":"pinCode","type":"string","default":"","desc":"The PIN Code to activate","required":true,"in":"body","ref":"","_id":"57720c1b92c56c0e00b381b5"},{"name":"lockType","type":"string","default":"","desc":"The type of lock (this is your company name)","required":true,"in":"body","ref":"","_id":"57720c1b92c56c0e00b381b4"},{"name":"leadUID","type":"string","default":"","desc":"The UID of the lead","required":false,"in":"body","ref":"","_id":"57720c1b92c56c0e00b381b3"},{"name":"emailAddress","type":"string","default":"","desc":"The email representing a unique user.","required":false,"in":"body","ref":"","_id":"57720c1b92c56c0e00b381b2"}]},"next":{"description":"","pages":[]},"title":"/pincodes/","type":"endpoint","slug":"pincode","excerpt":"Creates a pin code for a specific property lock. Pin code can be associated with a lead or with a user in the system (one of the two is required).","body":"","updates":[],"order":52,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5de85dbbb0b885003ddf3357","__v":2,"editedParams2":true,"githubsync":"","createdAt":"2016-06-28T05:33:15.072Z","editedParams":true,"parentDoc":null,"project":"56e3719a591f620e00bf5095","version":{"version":"1.5","version_clean":"1.5.0","codename":"Domain","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5de85dbbb0b885003ddf3334","56e7b24ad365390e007baeab","5de85dbbb0b885003ddf3335","5de85dbbb0b885003ddf3336","5de85dbbb0b885003ddf3337","5de85dbbb0b885003ddf3338"],"_id":"5de85dbbb0b885003ddf339f","__v":0,"project":"56e3719a591f620e00bf5095","forked_from":"56e3719a591f620e00bf5098","createdAt":"2016-03-12T01:32:10.751Z","releaseDate":"2016-03-12T01:32:10.751Z"},"user":"56e371538b32a10e00f79750","category":{"sync":{"isSync":false,"url":""},"pages":["5de85dbbb0b885003ddf3339","5de85dbbb0b885003ddf333a","5de85dbbb0b885003ddf333b","5de85dbbb0b885003ddf333c","5de85dbbb0b885003ddf333d","5de85dbbb0b885003ddf333e","5de85dbbb0b885003ddf333f","5de85dbbb0b885003ddf3340","5de85dbbb0b885003ddf3341","5de85dbbb0b885003ddf3342","5de85dbbb0b885003ddf3343","56e77e22911296190096de13","5de85dbbb0b885003ddf3344","5de85dbbb0b885003ddf3345","5de85dbbb0b885003ddf3346","5de85dbbb0b885003ddf3347","5de85dbbb0b885003ddf3348","5de85dbbb0b885003ddf3349","5de85dbbb0b885003ddf334a"],"title":"Documentation","slug":"documentation","order":0,"from_sync":false,"reference":false,"_id":"5de85dbbb0b885003ddf3334","project":"56e3719a591f620e00bf5095","__v":19,"createdAt":"2016-03-12T01:32:11.359Z","version":"5de85dbbb0b885003ddf339f"}}

post/pincodes/

Creates a pin code for a specific property lock. Pin code can be associated with a lead or with a user in the system (one of the two is required).

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

propertyUid:
required
string
Unique id of the property
startDateTime:
required
datetime
Start date and time
endDateTime:
required
datetime
End date and time
pinCode:
required
string
The PIN Code to activate
lockType:
required
string
The type of lock (this is your company name)
leadUID:
string
The UID of the lead
emailAddress:
string
The email representing a unique user.

Result Format


User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}