{"_id":"57720c1b92c56c0e00b381b1","__v":1,"editedParams2":true,"editedParams":true,"parentDoc":null,"project":"56e3719a591f620e00bf5095","version":{"_id":"56e3719a591f620e00bf5098","hasReference":true,"hasDoc":true,"__v":2,"project":"56e3719a591f620e00bf5095","createdAt":"2016-03-12T01:32:10.751Z","releaseDate":"2016-03-12T01:32:10.751Z","categories":["56e3719b591f620e00bf5099","56e7b24ad365390e007baeab"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.1.0","version":"1.1"},"user":"56e371538b32a10e00f79750","category":{"_id":"56e3719b591f620e00bf5099","pages":["56e3719c591f620e00bf509b","56e74226555c030e00a52a90","56e7447c7d693632001d5cb4","56e752bd56d59a0e00d5660e","56e755b98aa2c00e00494cd9","56e7584d911296190096dd80","56e759339b25270e001d11a0","56e7593e1b41040e009d10cf","56e7594e911296190096dd88","56e7595e8aa2c00e00494ce3","56e75d7f5669091700c5b2b4","56e77e22911296190096de13","56e77f259b25270e001d1232","56e7b2c737afb90e00e0eb9d","56ec4daf611730190000f23f","56ec4fde26db830e00afa083","56ec8f7204e8940e00966567","56f184cc9791b22d0077b9d9","56f18a2c3af4942b00bb3c47"],"project":"56e3719a591f620e00bf5095","__v":19,"version":"56e3719a591f620e00bf5098","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-03-12T01:32:11.359Z","from_sync":false,"order":0,"slug":"documentation","title":"Documentation"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-06-28T05:33:15.072Z","link_external":false,"link_url":"","githubsync":"","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":"/pincode/"},"isReference":false,"order":24,"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 }}