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

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 }}