NOTE: This API is for property managers only. If you are a partner who needs access to our partner API please contact support.
\nThe Tokeet Client API (CAPI) allows you to programmatically interact with the Tokeet vacation rental platform. It exposes all of the core functionality of the platform to external applications and allows you to build systems that interact with your Tokeet data. Please be very careful while interacting with your data while using the CAPI as deleted or updated data cannot be recovered.
\nThe CAPI is accessible via the below URL. You must also provide your API key and account id on each request.
\n\n\n\n
Please note the HTTPS protocol used in the URL. The Tokeet CAPI require all requests to use secure HTTP connections. All plain HTTP requests will be forwarded to the corresponding secure endpoints.
\nAccess to the Client API is handled via HTTP Basic Authentication using your Tokeet account api key. Each Tokeet account has an API Key which is accessible via the Tokeet front end.
\n\n\ncurl -H 'Accept: application/json' -H 'Authorization:
\nyour-api-token' https://capi.tokeet.com/v1/user?account={{account_id}}
To access your API key simply log into Tokeet, go to the Settings menu and select Account Info. There, at the top of the first table, you will see a section for your api key. Please click Generate Key if tyou don't currently see an api key. Please take note of your API key and keep it secure. The key will only be visible for the remainder of your session. If you misplace or loose your key you must generate a new one and this automatically disables any existing key.
\nYour account id is located right next to your api key.
\nYour api key should be placed in the Authorization header of every request to the CAPI. You should also provide your account id on the query string of each request and only access the CAPI via secure SSL over HTTPS. Any requests via standard HTTP will be redirected to HTTPS.
\nThe API accepts standard HTTP requests. You can pass values to the API via the URL query string or the request body, when required by an endpoint. The request body, if present, is always assumed to be a JSON document. The Content-Type and Acceptheaders are ignored.
\nThe Tokeet CAPI uses standard HTTP status codes where ever possible. Each response also includes a JSON payload with the requested data or an appropriate error message if the request failed.
\nMost requests will respond with a status of 2xx to singal that the request was successful.
400 means the request was invalid401 means you were not authenticated404 means the requested item was not found in your account500 means the server had an error and you should report it to supportPlease review all error messages returned by the CAPI before consulting the support team for help.
\nWhen a request is valid but a data type in your JSON payload is invalid or missing, the CAPI will let you know with a 400 error. The Tokeet CAPI strictly enforces data types where indicated, and also enforces data value options.
\nBelow is an example the response JSON payload. The error attribute is only available if an error occured.
{ data: {…}, error: { message: '...', code: xxx }} }
This endpoint allows you to create a new expense in your account. This request must include a JSON payload. The possible attributes in the payload are listed below.
\nrequired number An epoch timestamp of the date of the expense.number An epoch timestamp of when the expense is due.required The id of the rental associated with this expense.required A category for the expense. The defaults are below. You may create your own.required number The monetary amount of the expense.number The status of the expense. 1=unpaid, 2=paid.This endpoint creates multiple expenses simultaneously. It accepts an array of JSON objects. The required fields can be seen in the expense creation endpoint description.
\n","urlObject":{"protocol":"https","path":["v1","expense","batch"],"host":["capi","tokeet","com"],"query":[{"key":"account","value":"{{account}}"}],"variable":[]}},"response":[],"_postman_id":"ba2fa022-f41b-0e73-0bfb-b00a6a75457e"},{"name":"Retrieve An Expense","id":"5eabc719-6d18-fd46-5f41-92491a70f54e","request":{"method":"GET","header":[{"key":"Authorization","value":"{{apikey}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://capi.tokeet.com/v1/expense/{{expense_pkey}}?account={{account}}","description":"Retrieve an expense with the specified expense id. This method returns a JSON object with the expense data.
\n","urlObject":{"protocol":"https","path":["v1","expense","{{expense_pkey}}"],"host":["capi","tokeet","com"],"query":[{"key":"account","value":"{{account}}"}],"variable":[]}},"response":[],"_postman_id":"5eabc719-6d18-fd46-5f41-92491a70f54e"},{"name":"Retrieve All Expenses","id":"bfc154d7-8714-39b3-916f-414f3e89346a","request":{"method":"GET","header":[{"key":"Authorization","value":"{{apikey}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://capi.tokeet.com/v1/expense?account={{account}}&limit=10&skip=0&sort=-1","description":"Retrieve all expneses in your account. We highly recommend using the pagination query parameters if you have many expenses in your account. The following query parameters may optionally by used.
\nThis endpoint updates an existing expense object. A JSON payload must be included with this request. The possible fields and values are detailed in the expense creation endpoint description. There are no required fields for this endpoint.
\n","urlObject":{"protocol":"https","path":["v1","expense","{{expense_pkey}}"],"host":["capi","tokeet","com"],"query":[{"key":"account","value":"{{account}}"}],"variable":[]}},"response":[],"_postman_id":"2547a5e8-e9d2-aa3d-6be4-3e45af69c640"},{"name":"Delete An Expense","id":"e15eb480-2f53-fd38-9e01-7b2368a54009","request":{"method":"DELETE","header":[{"key":"Authorization","value":"{{apikey}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://capi.tokeet.com/v1/expense/{{expense_pkey}}?account={{account}}","description":"This endpoint allows you to delete an existing expense using the expense id (pkey).
\n","urlObject":{"protocol":"https","path":["v1","expense","{{expense_pkey}}"],"host":["capi","tokeet","com"],"query":[{"key":"account","value":"{{account}}"}],"variable":[]}},"response":[],"_postman_id":"e15eb480-2f53-fd38-9e01-7b2368a54009"}],"id":"78832a3b-8245-7aa4-2539-a11fcb4254cf","description":"An expense is is resource within the Tokeet platform. It represents a fee or charge related to your rental business which you must pay. These API endpoints allow you to create, retrieve, update, and delete expenses within your Tokeet account. These api requests have the same afffect as using the Tokeet web or mobile applications.
\n","_postman_id":"78832a3b-8245-7aa4-2539-a11fcb4254cf"},{"name":"Guests","item":[{"name":"Create A Guest","id":"570bc224-a27c-4494-f84f-f44ae8b33a75","request":{"method":"POST","header":[{"key":"Authorization","value":"{{apikey}}"}],"body":{"mode":"raw","raw":"{\n \"name\": \"John Smith\",\n \"email\": \"john@smith.com\"\n}"},"url":"https://capi.tokeet.com/v1/guest?account={{account}}","description":"This endpoint creates a guest within your account. This request must include a JSON payload. The required fields in the payload are name and email. All other fields are optional.
\nrequired The guest full name.required A JSON object containing the guest address.email The primary email of the guest.array A JSON array of strings.date(MM/DD/YYY) A date in the indicated format.This endpoint allows you to create many guests at once within your account. This request must include a JSON array as payload. The required fields for each JSON object in the array are name and email. All other fields are optional. Please see the Create Guest endpoint for details.
\n","urlObject":{"protocol":"https","path":["v1","guest","batch"],"host":["capi","tokeet","com"],"query":[{"key":"account","value":"{{account}}"}],"variable":[]}},"response":[],"_postman_id":"b2aaa08c-ac20-27de-cee6-0d50c09ef5d3"},{"name":"Retrieve A Guest","id":"1e943f06-56fd-89f7-061c-8466fbf0ec60","request":{"method":"GET","header":[{"key":"Authorization","value":"{{apikey}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://capi.tokeet.com/v1/guest/{{pkey}}?account={{account}}","description":"Retrieves a guest with the specific guest id (pkey).
\n","urlObject":{"protocol":"https","path":["v1","guest","{{pkey}}"],"host":["capi","tokeet","com"],"query":[{"key":"account","value":"{{account}}"}],"variable":[]}},"response":[],"_postman_id":"1e943f06-56fd-89f7-061c-8466fbf0ec60"},{"name":"Retrieve A Guest By Email","id":"c0d9497a-0292-b668-3494-9addec888f36","request":{"method":"GET","header":[{"key":"Authorization","value":"{{apikey}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://capi.tokeet.com/v1/guest/email/{{email}}?account={{account}}","description":"This endpoint retrieves a guest with the specific email address as their primary email.
\n","urlObject":{"protocol":"https","path":["v1","guest","email","{{email}}"],"host":["capi","tokeet","com"],"query":[{"key":"account","value":"{{account}}"}],"variable":[]}},"response":[],"_postman_id":"c0d9497a-0292-b668-3494-9addec888f36"},{"name":"Retrieve All Guests","id":"cd4156ed-4ee6-31b8-045d-08535ea63041","request":{"method":"GET","header":[{"key":"Authorization","value":"{{apikey}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://capi.tokeet.com/v1/guest?account={{account}}&limit=100&skip=0&sort=1&booked=1&unbooked=0&source=airbnb&name=mary","description":"This endpoint retrieves all guests within your account. It returns an array of JSON objects or an empty array. We highly recommend using pagination (skip & limit) with this request if you have many guests within your account. The following parameters may be included on the query string.
\nThis endpoint updates a guest object using the guest id (okey). The request must also include a JSON payload. The possible fields that may be included in the payload are described in the guest creation endpoint description.
\n","urlObject":{"protocol":"https","path":["v1","guest","{{guest_pkey}}"],"host":["capi","tokeet","com"],"query":[{"key":"account","value":"{{account}}"}],"variable":[]}},"response":[],"_postman_id":"fb7d560d-8b7f-476f-9e76-c3b41cc306be"},{"name":"Delete A Guest","id":"4f636331-146b-7af0-ebfa-632fbc937e7b","request":{"method":"DELETE","header":[{"key":"Authorization","value":"{{apikey}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://capi.tokeet.com/v1/guest/{{guest_pkey}}?account={{account}}","description":"This endpoint allows you to delete a guest from your account by providing the guest id. Please note that deletions are immediate and permanent. So please use this endpoint carefully.
\n","urlObject":{"protocol":"https","path":["v1","guest","{{guest_pkey}}"],"host":["capi","tokeet","com"],"query":[{"key":"account","value":"{{account}}"}],"variable":[]}},"response":[],"_postman_id":"4f636331-146b-7af0-ebfa-632fbc937e7b"},{"name":"Record A Guest Interaction","id":"d248bc03-3a91-196c-0037-a19eb44e659a","request":{"method":"POST","header":[{"key":"Authorization","value":"{{apikey}}"}],"body":{"mode":"raw","raw":"{\n \"type\":\"phone call\",\n \"date\": 1507694400,\n \"comment\": \"This is a test.\"\n}"},"url":"https://capi.tokeet.com/v1/guest/{{guest_pkey}}/interaction?account={{account}}","description":"This endpoint allows you to record an interaction you had with your guest. You must include a JSON payload with your reuqest. The following fields are required.
\nDelete a previously recorded interaction with a guest. You must provide the guest id and interaction key in the URI.
\n","urlObject":{"protocol":"https","path":["v1","guest","{{guest_pkey}}","interaction","{{interaction_key}}"],"host":["capi","tokeet","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"eb63ecbb-692e-3438-bd84-871ab6a36c60"},{"name":"Archive A Guest","id":"ab50bfde-d561-fcba-fc0e-1d101491a041","request":{"method":"PUT","header":[{"key":"Authorization","value":"{{apikey}}"}],"body":{"mode":"raw","raw":"{}"},"url":"https://capi.tokeet.com/v1/guest/{{guest_pkey}}/archive?account={{account}}","description":"This endpoint archives the guest specified by the guest id. Archive guests do not show by default in the web and mobile applications. This method should be accompanied by an empty JSON body.
\n","urlObject":{"protocol":"https","path":["v1","guest","{{guest_pkey}}","archive"],"host":["capi","tokeet","com"],"query":[{"key":"account","value":"{{account}}"}],"variable":[]}},"response":[],"_postman_id":"ab50bfde-d561-fcba-fc0e-1d101491a041"},{"name":"Unarchive A Guest","id":"18eaa586-d468-a57f-0bd3-b8f44baf583b","request":{"method":"PUT","header":[{"key":"Authorization","value":"{{apikey}}"}],"body":{"mode":"raw","raw":"{}"},"url":"https://capi.tokeet.com/v1/guest/{{guest_pkey}}/unarchive?account={{account}}","description":"This endpoint archives the guest specified by the guest id. Archive guests do not show by default in the web and mobile applications. This method should be accompanied by an empty JSON payload.
\n","urlObject":{"protocol":"https","path":["v1","guest","{{guest_pkey}}","unarchive"],"host":["capi","tokeet","com"],"query":[{"key":"account","value":"{{account}}"}],"variable":[]}},"response":[],"_postman_id":"18eaa586-d468-a57f-0bd3-b8f44baf583b"},{"name":"Record A Guest Note","id":"ff2bfed5-5d65-d335-27c0-dc58ac17f67c","request":{"method":"POST","header":[{"key":"Authorization","value":"{{apikey}}"}],"body":{"mode":"raw","raw":"{\n \"note\":\"This is my note.\"\n}"},"url":"https://capi.tokeet.com/v1/guest/{{guest_pkey}}/note?account={{account}}","description":"This endpoint allows you to create a note on a guest. Notes are used to keep track of information regarding a guest for future reference. You must supply a JSON payload with this request. There is only one parameter, which is reqiured.
\nThis endpoint allows you to update a previously saved guest note.
\n","urlObject":{"protocol":"https","path":["v1","guest","{{guest_pkey}}","note"],"host":["capi","tokeet","com"],"query":[{"key":"account","value":"{{account}}"}],"variable":[]}},"response":[],"_postman_id":"3a2a94c9-5f49-365a-8021-63b58a0a0134"},{"name":"Delete A Guest Note","id":"5ebe0015-edc0-8e66-35cd-dc2b757ec97c","request":{"method":"DELETE","header":[{"key":"Authorization","value":"{{apikey}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://capi.tokeet.com/v1/guest/{{guest_pkey}}/note/{{note_key}}?account={{account}}","description":"This endpoint allows you to delete a previously saved guest note. You must provide the guest id and note key.
\n","urlObject":{"protocol":"https","path":["v1","guest","{{guest_pkey}}","note","{{note_key}}"],"host":["capi","tokeet","com"],"query":[{"key":"account","value":"{{account}}"}],"variable":[]}},"response":[],"_postman_id":"5ebe0015-edc0-8e66-35cd-dc2b757ec97c"},{"name":"Add A Guest Phone","id":"3da343da-b902-1c1f-51c0-ae88cceea633","request":{"method":"POST","header":[{"key":"Authorization","value":"{{apikey}}"}],"body":{"mode":"raw","raw":"{\n \"phone\":\"1-101-212-3333\"\n}"},"url":"https://capi.tokeet.com/v1/guest/{{guest_pkey}}/phone?account={{account}}","description":"This endpoint adds a phone number to the list of phone numbers for the specified guest. This request must contain a JSON payload. There is only one field and it is required.
\nThis endpoint deletes a previously stored phone number in the specified guest.
\n","urlObject":{"protocol":"https","path":["v1","guest","{{guest_pkey}}","phone","{{phone}}"],"host":["capi","tokeet","com"],"query":[{"key":"account","value":"{{account}}"}],"variable":[]}},"response":[],"_postman_id":"7cfed154-ae1b-cc2d-5277-6a4f8cddf28a"},{"name":"Add An Email","id":"2fbc90dc-6827-0847-12e7-34d021c0df1f","request":{"method":"POST","header":[{"key":"Authorization","value":"{{apikey}}"}],"body":{"mode":"raw","raw":"{\n \"email\": \"test@email.com\"\n}"},"url":"https://capi.tokeet.com/v1/guest/email/{{guest_pkey}}?account={{account}}","description":"This endpoint allows you to add an email address to the list of email addresses for the specified guest. A JSON payload must be included with this request. There is one required field.
\nThis endpoint removes the specified email address from the specified guest. It does nothing if the email is currently not associated with this guest.
\n","urlObject":{"protocol":"https","path":["v1","guest","email","{{guest_pkey}}","test@email.com"],"host":["capi","tokeet","com"],"query":[{"key":"account","value":"{{account}}"}],"variable":[]}},"response":[],"_postman_id":"897da8ad-9713-75ad-c1ca-47c482cd568b"}],"id":"9572274a-c79e-05e9-0c4a-de40899f702f","description":"A guest is is resource within the Tokeet platform. It represents someone who rents, or is interested in renting, your property. These API endpoints allow you to create, retrieve, update, and delete guests within your Tokeet account. These api requests have the same afffect as using the Tokeet web or mobile applications.
\n","_postman_id":"9572274a-c79e-05e9-0c4a-de40899f702f"},{"name":"Rates","item":[{"name":"Create A Standard Rate","id":"9b1542ec-823d-ee4a-61df-e23f580558c5","request":{"method":"POST","header":[{"key":"Authorization","value":"{{apikey}}"}],"body":{"mode":"raw","raw":"{\n \"name\": \"rate 2\",\n \"nightly\": 300,\n \"rental_id\": \"d47782bd-ae16-48d9-bb36-9a23ad7c3585\",\n\n \"start\": \"2017-12-23\",\n \"end\": \"2017-12-26\",\n \"category\": \"default\",\n\n \"type\": \"standard\",\n\n \"additionalFeeAmount\": 50,\n \"additionalFeeThreshold\": 6,\n\n \"minimum\": 2,\n \"maximum\": 30,\n \"maxguests\": 10,\n \"monthly\": 8400,\n \"weekly\": 2100,\n \n \"dayspecifics\": [\n {\n \"price\": \"100\", \n \"threshold\": 4, \n \"days\": [\n 1, \n 2 \n ],\n \"thresholdfee\": 20 \n }\n ]\n}"},"url":"https://capi.tokeet.com/v1/rate?account={{account}}","description":"This endpoint creates a standard rate within your account. \nThis request must include a JSON payload. \nThe required fields in the payload are name, start, end, rental_id, type, and category. \nYou must also specify a rate of either nightly, weekly, or monthly. All other fields are optional.
\nIt is highly recommended that you become familiar with Tokeet rates and read the help center before creating rates via the client API.
\nThis endpoint returns the newly created rate object with a status of 200 on success.
\nrequired The rate name. This can be alphanumeric, but cannot be a number with max length of 20 characters.required date(YYYY-MM-DD) The start date of the rate in the form YYYY-MM-DD.required date(YYYY-MM-DD) The end date of the rate in the form YYYY-MM-DD.required A category to which the rate belongs. This can be any alphanumeric string with max length of 20 characters.required The pkey of the rental to which the rate will be added.required This is the type of the rate. Options are (standard, promotion, dynamic). This should be set to standard for standard rates.number The nightly rate.number The weekly rate.number The monthly rate.number The minimum length of stay.number The maximum length of stay.number The maximum number of the guests.number The number of guests above which the additional guest fee will be applied.number The additional guest fee to be applied for each guest above additionalFeeThreshold.array An array of day specific pricing objects.number The price for the specific days. array An array of days (numbers) to which the price should be applied. 0 = Monday.number The number of guests above which the additional guest fee will be applied.number The additional guest fee to be applied for each guest above threshold.This endpoint creates a promotion rate within your account. \nThis request must include a JSON payload. \nThe required fields in the payload are name, start, end, rental_id, type, and category. \nYou must also specify a rate of either nightly, weekly, or monthly. All other fields are optional.
\nIt is highly recommended that you become familiar with Tokeet rates and read the help center before creating rates via the client API.
\nThis endpoint returns the newly created rate object with a status of 200 on success.
\nrequired The rate name. This can be alphanumeric, but cannot be a number with max length 20 characters.required date(YYYY-MM-DD) The start date of the rate in the form YYYY-MM-DD.required date(YYYY-MM-DD) The end date of the rate in the form YYYY-MM-DD.required An array of categories to which the rate belongs. These can be any alphanumeric string with max length of 20 characters.required The pkey of the rental to which the rate will be added.required This is the type of the rate. Options are (standard, promotion, dynamic). This should be set to promotion for promotional rates.number The nightly rate.number The weekly rate.number The monthly rate.number The minimum length of stay.number The maximum length of stay.number The maximum number of the guests.number The number of guests above which the additional guest fee will be applied.number The additional guest fee to be applied for each guest above additionalFeeThreshold.array An array of day specific pricing objects.number The price for the specific days. array An array of days (numbers) to which the price should be applied. 0 = Monday.number The number of guests above which the additional guest fee will be applied.number The additional guest fee to be applied for each guest above threshold.This endpoint creates a dynamic rate within your account. \nThis request must include a JSON payload. \nThe required fields in the payload are described below. All other fields are optional.
\nIt is highly recommended that you become familiar with Tokeet rates and read the help center before creating rates via the client API.
\nThis endpoint returns the newly created rate object with a status of 200 on success.
\nname - required The rate name. This can be alphanumeric, but cannot be a number with max length 20 characters.
start - required date(YYYY-MM-DD) The start date of the rate in the form YYYY-MM-DD.
end - required date(YYYY-MM-DD) The end date of the rate in the form YYYY-MM-DD.
category - required A category to which the rate belongs. This can be any alphanumeric string with ax length 20 characters.
rental_id - required The pkey of the rental to which the rate will be added.
type - required This is the type of the rate. Options are (standard, promotion, dynamic).
low_rate - required number The lowest nightly rate of the dynamic price range.
high_rate - required number The highest nightly rate of the dynamic price range.
low_threshold - required number The occupancy level at which the dynamic pricing begins.
high_threshold - required number The occupancy level at which the dynamic pricing ends.
minimum - number The minimum length of stay.
maximum - number The maximum length of stay.
maxguests - number The maximum number of the guests.
additionalFeeThreshold - number The number of guests above which the additional guest fee will be applied.
additionalFeeAmount - number The additional guest fee to be applied for each guest above additionalFeeThreshold.
dayspecifics - array An array of day specific pricing objects.
price - number The price for the specific days.
days - array An array of days (numbers) to which the price should be applied. 0 = Monday.
threshold - number The number of guests above which the additional guest fee will be applied.
thresholdfee - number The additional guest fee to be applied for each guest above threshold.
This endpoint creates a base rate within your account. \nThis request must include a JSON payload. \nThe required fields in the payload are name, rental_id, nightly, and minimum. \nYou must also specify a rate of either nightly, weekly, or monthly. All other fields are optional.
\nIt is highly recommended that you become familiar with Tokeet rates and read the help center before creating rates via the client API.
\nThis endpoint returns the newly created rate object with a status of 200 on success.
\nrequired The rate name. This can be alphanumeric, but cannot be a number with max length 15 characters.required The pkey of the rental to which the rate will be added.required number The nightly rate.number The weekly rate.number The weekend rate.number The monthly rate.required number The minimum length of stay.number The number of guests above which the additional guest fee will be applied.number The additional guest fee to be applied for each guest above additionalFeeThreshold.Retrieve all standard, dynamic, and promotional rates from the specified rental.
\nWe highly recommend using the pagination query parameters if you have many rates in your account. The following query parameters may optionally by used.
\nskip - The number of items to skip in the results. This is used for pagination. limit - The maximum number of items to return. This is used for pagination. sort - A value of 1 or -1 which represents the sort order of the results based on the creation date.
\n","urlObject":{"protocol":"https","path":["v1","rate","{{rental_pkey}}"],"host":["capi","tokeet","com"],"query":[{"key":"account","value":"{{account}}"}],"variable":[]}},"response":[{"id":"67fded2e-d545-49c6-bf6b-f26e13ca3f5b","name":"Get All Rates","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{apikey}}"},{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"https://capi.tokeet.com/v1/rate/{{rental_pkey}}?account={{account}}","protocol":"https","host":["capi","tokeet","com"],"path":["v1","rate","{{rental_pkey}}"],"query":[{"key":"account","value":"{{account}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"796d4046-deaa-e4e6-398d-c437e3c6db19"},{"name":"Update A Standard Rate","id":"39acd885-01b2-65f8-16b5-2d7354d1f2b0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"{{apikey}}"}],"body":{"mode":"raw","raw":"{\n \"name\": \"rate 2\",\n \"nightly\": 400,\n \"rental_id\": \"d47782bd-ae16-48d9-bb36-9a23ad7c3585\",\n\n \"start\": \"2017-12-23\",\n \"end\": \"2017-12-26\",\n \"category\": \"default\",\n\n \"type\": \"standard\",\n\n \"additionalFeeAmount\": 50,\n \"additionalFeeThreshold\": 6,\n\n \"minimum\": 2,\n \"maximum\": 30,\n \"maxguests\": 10,\n \"monthly\": 8400,\n \"weekly\": 2100,\n \n \"dayspecifics\": [\n {\n \"price\": \"100\", \n \"threshold\": 4, \n \"days\": [\n 1, \n 2 \n ],\n \"thresholdfee\": 30 \n }\n ]\n}"},"url":"https://capi.tokeet.com/v1/rate/{{rental_pkey}}/{{rate_key}}?account={{account}}","description":"This endpoint updates an existing standard rate in your account. A JSON payload must be included with this request. The possible fields and values are detailed in the rate creation endpoint description.
\n","urlObject":{"protocol":"https","path":["v1","rate","{{rental_pkey}}","{{rate_key}}"],"host":["capi","tokeet","com"],"query":[{"key":"account","value":"{{account}}"}],"variable":[]}},"response":[{"id":"87315dbb-d03c-44f3-82f1-78d183b37e3e","name":"Update A Standard Rate","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"{{apikey}}"}],"body":{"mode":"raw","raw":"{\n \"name\": \"rate 2\",\n \"nightly\": 400,\n \"rental_id\": \"d47782bd-ae16-48d9-bb36-9a23ad7c3585\",\n\n \"start\": \"2017-12-23\",\n \"end\": \"2017-12-26\",\n \"category\": \"default\",\n\n \"type\": \"standard\",\n\n \"additionalFeeAmount\": 50,\n \"additionalFeeThreshold\": 6,\n\n \"minimum\": 2,\n \"maximum\": 30,\n \"maxguests\": 10,\n \"monthly\": 8400,\n \"weekly\": 2100,\n \n \"dayspecifics\": [\n {\n \"price\": \"100\", \n \"threshold\": 4, \n \"days\": [\n 1, \n 2 \n ],\n \"thresholdfee\": 30 \n }\n ]\n}"},"url":{"raw":"https://capi.tokeet.com/v1/rate/{{rental_pkey}}/{{rate_key}}?account={{account}}","protocol":"https","host":["capi","tokeet","com"],"path":["v1","rate","{{rental_pkey}}","{{rate_key}}"],"query":[{"key":"account","value":"{{account}}"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"39acd885-01b2-65f8-16b5-2d7354d1f2b0"},{"name":"Update A Dynamic Rate","id":"76d74a3c-0c65-3814-7d4d-7bc58c256c67","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"{{apikey}}"}],"body":{"mode":"raw","raw":"{\n \"name\": \"rate dynamic 2\",\n \"rental_id\": \"d47782bd-ae16-48d9-bb36-9a23ad7c3585\",\n\n \"start\": \"2017-12-27\",\n \"end\": \"2017-12-29\",\n \"category\": \"default\",\n\n \"type\": \"dynamic\",\n \n \"low_threshold\": 100,\n \"high_threshold\": 200,\n\n \"threshold_type\": \"monthly\",\n\n \"low_rate\": 100,\n \"high_rate\": 200,\n\n \"additionalFeeAmount\": 50,\n \"additionalFeeThreshold\": 6,\n \n \"minimum\": 5,\n \"maximum\": 30,\n \"maxguests\": 8,\n \n \"dayspecifics\": [\n {\n \"price\": 120, \n \"threshold\": 4, \n \"days\": [\n 1, \n 2 \n ],\n \"thresholdfee\": 20 \n }\n ]\n}"},"url":"https://capi.tokeet.com/v1/rate/{{rental_pkey}}/{{rate_key}}/dynamic?account={{account}}","description":"This endpoint updates an existing dynamic rate in your account. A JSON payload must be included with this request. The possible fields and values are detailed in the rate creation endpoint description.
\n","urlObject":{"protocol":"https","path":["v1","rate","{{rental_pkey}}","{{rate_key}}","dynamic"],"host":["capi","tokeet","com"],"query":[{"key":"account","value":"{{account}}"}],"variable":[]}},"response":[],"_postman_id":"76d74a3c-0c65-3814-7d4d-7bc58c256c67"},{"name":"Update A Promotion Rate","id":"127f18a3-bc7b-a995-9589-957fad5dcef7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"{{apikey}}"}],"body":{"mode":"raw","raw":"{\n \"name\": \"rate promotion 2\",\n \"nightly\": 202,\n \"monthly\": 8400,\n \"weekly\": 2100,\n \"rental_id\": \"d47782bd-ae16-48d9-bb36-9a23ad7c3585\",\n\n \"start\": \"2017-12-23\",\n \"end\": \"2017-12-26\",\n \"categories\": [\"default\"],\n\n \"type\": \"promotion\",\n\n \"additionalFeeAmount\": 50,\n \"additionalFeeThreshold\": 6,\n\n \"minimum\": 5,\n \"maximum\": 30,\n \"maxguests\": 8,\n \n \"dayspecifics\": [\n {\n \"price\": 120, \n \"threshold\": 4, \n \"days\": [\n 1, \n 2 \n ],\n \"thresholdfee\": 20 \n }\n ]\n}"},"url":"https://capi.tokeet.com/v1/rate/{{rental_pkey}}/{{rate_key}}/promotion?account={{account}}","description":"This endpoint updates an existing promotion rate in your account. A JSON payload must be included with this request. The possible fields and values are detailed in the rate creation endpoint description.
\n","urlObject":{"protocol":"https","path":["v1","rate","{{rental_pkey}}","{{rate_key}}","promotion"],"host":["capi","tokeet","com"],"query":[{"key":"account","value":"{{account}}"}],"variable":[]}},"response":[],"_postman_id":"127f18a3-bc7b-a995-9589-957fad5dcef7"},{"name":"Delete All Rates","id":"48ef4b31-318d-008c-931d-705819465541","request":{"method":"DELETE","header":[{"key":"Authorization","value":"{{apikey}}"}],"body":{"mode":"raw","raw":""},"url":"https://capi.tokeet.com/v1/rate/{{rental_pkey}}?account={{account}}","description":"This endpoint deletes all standard, dynamic, and promotional rates from the specified rental.
\n","urlObject":{"protocol":"https","path":["v1","rate","{{rental_pkey}}"],"host":["capi","tokeet","com"],"query":[{"key":"account","value":"{{account}}"}],"variable":[]}},"response":[],"_postman_id":"48ef4b31-318d-008c-931d-705819465541"},{"name":"Delete A Standard Rate","id":"9b5f2f78-c11f-2629-0179-0f624f339183","request":{"method":"DELETE","header":[{"key":"Authorization","value":"{{apikey}}"}],"body":{"mode":"raw","raw":"{\n}"},"url":"https://capi.tokeet.com/v1/rate/{{rental_pkey}}/{{rate_key}}?account={{account}}","description":"This endpoint deletes an existing standard or dynamic rate in your account based on the rate pkey.
\n","urlObject":{"protocol":"https","path":["v1","rate","{{rental_pkey}}","{{rate_key}}"],"host":["capi","tokeet","com"],"query":[{"key":"account","value":"{{account}}"}],"variable":[]}},"response":[],"_postman_id":"9b5f2f78-c11f-2629-0179-0f624f339183"},{"name":"Delete A Promotion Rate","id":"412b32e1-38f8-0913-6f8e-9bd6377afeb1","request":{"method":"DELETE","header":[{"key":"Authorization","value":"{{apikey}}"}],"body":{"mode":"raw","raw":"{\n}"},"url":"https://capi.tokeet.com/v1/rate/{{rental_pkey}}/{{rate_key}}/promotion?account={{account}}","description":"This endpoint deletes an existing promotion rate in your account based on the rate pkey.
\n","urlObject":{"protocol":"https","path":["v1","rate","{{rental_pkey}}","{{rate_key}}","promotion"],"host":["capi","tokeet","com"],"query":[{"key":"account","value":"{{account}}"}],"variable":[]}},"response":[],"_postman_id":"412b32e1-38f8-0913-6f8e-9bd6377afeb1"},{"name":"Delete A Dynamic Rate","id":"72c0f182-2539-5021-e551-f5cd75ea4609","request":{"method":"DELETE","header":[{"key":"Authorization","value":"{{apikey}}"}],"body":{"mode":"raw","raw":""},"url":"https://capi.tokeet.com/v1/rate/{{rental_pkey}}/{{rate_key}}/dynamic?account={{account}}","description":"This endpoint deletes an existing dynamic rate in your account based on the rate pkey.
\n","urlObject":{"protocol":"https","path":["v1","rate","{{rental_pkey}}","{{rate_key}}","dynamic"],"host":["capi","tokeet","com"],"query":[{"key":"account","value":"{{account}}"}],"variable":[]}},"response":[],"_postman_id":"72c0f182-2539-5021-e551-f5cd75ea4609"},{"name":"Delete Base Rate","id":"167eb626-2c0b-53a8-ee27-0b1f959d31e4","request":{"method":"DELETE","header":[{"key":"Authorization","value":"{{apikey}}"}],"body":{"mode":"raw","raw":"{\n}"},"url":"https://capi.tokeet.com/v1/rate/{{rental_pkey}}/base?account={{account}}","description":"This endpoint deletes an existing base rate in your account based on the rate pkey.
\n","urlObject":{"protocol":"https","path":["v1","rate","{{rental_pkey}}","base"],"host":["capi","tokeet","com"],"query":[{"key":"account","value":"{{account}}"}],"variable":[]}},"response":[],"_postman_id":"167eb626-2c0b-53a8-ee27-0b1f959d31e4"}],"id":"57bac2cb-376a-8c99-e50e-3828c833d942","description":"A Rate is a resource within the Tokeet platform. It represents the prices for booking a rental over a set period of time. Rates may be static or dynamic depending on their type and configuration. They are bound to a specific rental and may be grouped with rate categories.
\nIf you have created rate maps between your rental and specific channels then each time you update your rates via the client API Tokeet will sync your rates. You may turn off auto synchronization of your rate map to stop this at anytime. You cannot create rate maps via the client API so you must create your maps in Tokeet then update your rates via the API.
\nWe highly recommend reading the various rates related help articles in the Tokeet help center before manipulating rates via the client API. Many of the checks and restrictions that exist on the front end are not implemented via the client API so you should be careful. There is no safety net when using the client API.
\nThere are three types of rates in Tokeet, Standard Rates, Promotion Rates, and Dynamic Rates. You should read about how they work in the help center.
\nThese API endpoints allow you to create, retrieve, update, and delete rates within a Tokeet account. The requests have the same impact as using the Tokeet web or mobile applications.
\n","_postman_id":"57bac2cb-376a-8c99-e50e-3828c833d942"},{"name":"Rentals","item":[{"name":"Create A Rental","id":"fc3b25d1-48c3-7acb-0098-a44cbb59b199","request":{"method":"POST","header":[{"key":"Authorization","value":"{{apikey}}"}],"body":{"mode":"raw","raw":"{ \"name\": \"My Test Rental\",\n \"email\": \"sadewa@saltfish.dev.tokeetmail.com\",\n \"phone\": 12312124124124\n}"},"url":"https://capi.tokeet.com/v1/rental?account={{account}}","description":"This endpoint allows you to create a new rental in your account. This request must include a JSON payload. The possible attributes in the payload are listed below.
\nname - required The name of the rental.
email - required The rental's Tokeet email address. This must use your Tokeet account domain and be a well formatted email address.
display_name - The display name of the rental on your Tokeet website and other places.
\nphone - required The phone number of the rental.
address - The address of your rental. It should include the following components
\nbedrooms - number The number of bedrooms in the rental.
bathrooms - number The number of bathrooms in the rental.
sleep_min - number The minimum number of guests the rental can sleep.
sleep_max - number The maximum number of guests the rental can sleep.
description - A description of the rental.
\ntype - The type of rental unit. The possible options are as follows:
\nsize - number The size of the rental.
size_metric - The unit used for the rental size. Possible values are as follows:
\npayment_terms - The payment terms of the rental.
\npayment_instructions - The payment instructions of the rental.
\ngps - The GPS coordinates of the rental expressed as a hash of two values.
\nnumber The lattitude of the rental.number The longitude of the rental.tags - array An array of strings, which are tags of the rental.
custom1 - A custom string content.
\ncustom2 - A custom string content.
\ncustom3 - A custom string content.
\ncustom4 - A custom string content.
\ncustom5 - A custom string content.
\nRetrieve a rental with the specified rental id (pkey). This method returns a JSON object with the rental data.
\n","urlObject":{"protocol":"https","path":["v1","rental","{{rental_pkey}}"],"host":["capi","tokeet","com"],"query":[{"key":"account","value":"{{account}}https://"}],"variable":[]}},"response":[],"_postman_id":"6e9898ea-0924-b70b-8b2a-d0e3e0fca06a"},{"name":"Get All Rentals","id":"d3b1bef3-f5bc-9a0b-d2f4-99a92ec2dbbc","request":{"method":"GET","header":[{"key":"Authorization","value":"{{apikey}}"}],"body":{"mode":"raw","raw":"{}"},"url":"https://capi.tokeet.com/v1/rental?account={{account}}","description":"Retrieve all rentals in your account. We highly recommend using the pagination query parameters if you have many rentals in your account. The following query parameters may optionally by used.
\nskip - The number of items to skip in the results. This is used for pagination.\nlimit - The maximum number of items to return in the results. This is used for pagination.\nsort - A value of 1 or -1 which represents the sort order of the results based on rental name.
\n","urlObject":{"protocol":"https","path":["v1","rental"],"host":["capi","tokeet","com"],"query":[{"key":"account","value":"{{account}}"}],"variable":[]}},"response":[],"_postman_id":"d3b1bef3-f5bc-9a0b-d2f4-99a92ec2dbbc"},{"name":"Get All Rentals By Owner","id":"1a73707e-728c-1d89-02ba-7bff18144e39","request":{"method":"GET","header":[{"key":"Authorization","value":"{{apikey}}"}],"body":{"mode":"raw","raw":"{}"},"url":"https://capi.tokeet.com/v1/rental/owner/{{owner_pkey}}?account={{account}}","description":"Retrieve all rentals belonging to the specified owner.
\n","urlObject":{"protocol":"https","path":["v1","rental","owner","{{owner_pkey}}"],"host":["capi","tokeet","com"],"query":[{"key":"account","value":"{{account}}"}],"variable":[]}},"response":[],"_postman_id":"1a73707e-728c-1d89-02ba-7bff18144e39"},{"name":"Get A Rental Availability","id":"ab89fdee-df6a-eaa0-d576-6c925fc821db","request":{"method":"GET","header":[{"key":"Authorization","value":"{{apikey}}"}],"body":{"mode":"raw","raw":"{}"},"url":"https://capi.tokeet.com/v1/rental/{{rental_pkey}}/availability?account={{account}}","description":"Retrieve the open and blocked dates for a given rental over the upcoming 2 years.
\n","urlObject":{"protocol":"https","path":["v1","rental","{{rental_pkey}}","availability"],"host":["capi","tokeet","com"],"query":[{"key":"account","value":"{{account}}"}],"variable":[]}},"response":[],"_postman_id":"ab89fdee-df6a-eaa0-d576-6c925fc821db"},{"name":"Update A Rental","id":"895c2657-cc4a-c130-0e5e-89a4b3d5750f","request":{"method":"PUT","header":[{"key":"Authorization","value":"{{apikey}}"}],"body":{"mode":"raw","raw":"{ \"bedrooms\": \"yes\"}"},"url":"https://capi.tokeet.com/v1/rental/{{rental_pkey}}?account={{account}}","description":"This endpoint updates an existing rental in your account. A JSON payload must be included with this request. The possible fields and values are detailed in the rental creation endpoint description.
\n","urlObject":{"protocol":"https","path":["v1","rental","{{rental_pkey}}"],"host":["capi","tokeet","com"],"query":[{"key":"account","value":"{{account}}"}],"variable":[]}},"response":[],"_postman_id":"895c2657-cc4a-c130-0e5e-89a4b3d5750f"},{"name":"Delete A Rental","id":"c0858442-feaa-2ef0-78de-4a3257792513","request":{"method":"DELETE","header":[{"key":"Authorization","value":"{{apikey}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://capi.tokeet.com/v1/rental/{{rental_pkey}}?account={{account}}","description":"Permanently delete a rental from your account.
\n","urlObject":{"protocol":"https","path":["v1","rental","{{rental_pkey}}"],"host":["capi","tokeet","com"],"query":[{"key":"account","value":"{{account}}"}],"variable":[]}},"response":[],"_postman_id":"c0858442-feaa-2ef0-78de-4a3257792513"},{"name":"Add An Owner To A Rental","id":"992fcd3b-17f9-a0aa-6d25-46280ea99ce2","request":{"method":"PUT","header":[{"key":"Authorization","value":"{{apikey}}"}],"body":{"mode":"raw","raw":"{ \"owner\" : \"{{owner_pkey}}\" }"},"url":"https://capi.tokeet.com/v1/rental/{{rental_pkey}}/owner?account={{account}}","description":"This endpoint adds an existing owner to an existing rental in your account. The payload should be an empty JSON object.
\n","urlObject":{"protocol":"https","path":["v1","rental","{{rental_pkey}}","owner"],"host":["capi","tokeet","com"],"query":[{"key":"account","value":"{{account}}"}],"variable":[]}},"response":[],"_postman_id":"992fcd3b-17f9-a0aa-6d25-46280ea99ce2"},{"name":"Delete An Owner From A Rental","id":"4591444d-1f44-e2d3-2cd5-14b17d95e9c4","request":{"method":"DELETE","header":[{"key":"Authorization","value":"{{apikey}}"}],"body":{"mode":"raw","raw":""},"url":"https://capi.tokeet.com/v1/rental/{{rental_pkey}}/owner/{{owner_pkey}}?account={{account}}","description":"This endpoint removes an existing owner from an existing rental in your account.
\n","urlObject":{"protocol":"https","path":["v1","rental","{{rental_pkey}}","owner","{{owner_pkey}}"],"host":["capi","tokeet","com"],"query":[{"key":"account","value":"{{account}}"}],"variable":[]}},"response":[],"_postman_id":"4591444d-1f44-e2d3-2cd5-14b17d95e9c4"},{"name":"Restrict A User From A Rental","id":"2ed3c8d0-48bf-fd74-3325-bb6b7aa5699a","request":{"method":"PUT","header":[{"key":"Authorization","value":"{{apikey}}"}],"body":{"mode":"raw","raw":"{ \"user\":\"{{user_pkey}}\" }"},"url":"https://capi.tokeet.com/v1/rental/{{rental_pkey}}/restriction?account={{account}}","description":"This endpoint restricts an existing user frmo accessing data of an existing rental in your account. The payload should be an empty JSON object.
\n","urlObject":{"protocol":"https","path":["v1","rental","{{rental_pkey}}","restriction"],"host":["capi","tokeet","com"],"query":[{"key":"account","value":"{{account}}"}],"variable":[]}},"response":[],"_postman_id":"2ed3c8d0-48bf-fd74-3325-bb6b7aa5699a"},{"name":"Delete A User Restriction","id":"922ee685-ca5f-be9e-dd81-805fa9188744","request":{"method":"DELETE","header":[{"key":"Authorization","value":"{{apikey}}"}],"body":{"mode":"raw","raw":""},"url":"https://capi.tokeet.com/v1/rental/{{rental_pkey}}/restriction/{{user_pkey}}?account={{account}}","description":"This endpoint removes an existing user from the restrictions of an existing rental in your account.
\n","urlObject":{"protocol":"https","path":["v1","rental","{{rental_pkey}}","restriction","{{user_pkey}}"],"host":["capi","tokeet","com"],"query":[{"key":"account","value":"{{account}}"}],"variable":[]}},"response":[],"_postman_id":"922ee685-ca5f-be9e-dd81-805fa9188744"}],"id":"ac1a8638-ad20-b820-c853-068fe51da327","description":"A rental is a property resource (house, villa, apartment, etc) within the Tokeet platform. These API endpoints allow you to create, retrieve, updated, and delete rentals within your Tokeet account.
\n","_postman_id":"ac1a8638-ad20-b820-c853-068fe51da327"},{"name":"Tasks","item":[{"name":"Create A Task","id":"237232a9-c7c2-0d08-1673-fbdbeeffb177","request":{"method":"POST","header":[{"key":"Authorization","value":"{{apikey}}"}],"body":{"mode":"raw","raw":"{ \"name\": \"My Test Task\",\n \"list\": \"Some list\",\n \"due\": 12312124124124\n}"},"url":"https://capi.tokeet.com/v1/task?account={{account}}","description":"This endpoint allows you to create a new task in your account. This request must include a JSON payload. The possible attributes in the payload are listed below.
\nrequired The name of the task.required An epoch timestamp representing the date and time the task is due. required The name of the list to which the task should be added. Retrieve a task with the specified task id. This method returns a JSON object which represents the task data.
\n","urlObject":{"protocol":"https","path":["v1","task","{{task_pkey}}"],"host":["capi","tokeet","com"],"query":[{"key":"account","value":"{{account}}"}],"variable":[]}},"response":[],"_postman_id":"4deaa10c-297d-06ba-1119-35b1752c0abb"},{"name":"Get All Tasks","id":"e37dfebb-5db6-20c5-732f-a91165e6c8f0","request":{"method":"GET","header":[{"key":"Authorization","value":"{{apikey}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://capi.tokeet.com/v1/task?account={{account}}","description":"Retrieve all tasks in your account. We highly recommend using the pagination query parameters if you have many tasks in your account. The following query parameters may optionally by used.
\nskip - The number of items to skip in the results. This is used for pagination.\nlimit - The maximum number of items to return. This is used for pagination.\nsort - A value of 1 or -1 which represents the sort order of the results based on the task name.
\n","urlObject":{"protocol":"https","path":["v1","task"],"host":["capi","tokeet","com"],"query":[{"key":"account","value":"{{account}}"}],"variable":[]}},"response":[],"_postman_id":"e37dfebb-5db6-20c5-732f-a91165e6c8f0"},{"name":"Update A Task","id":"305dfb7e-c7a0-c8d8-52d7-534c6305bb4c","request":{"method":"PUT","header":[{"key":"Authorization","value":"{{apikey}}"}],"body":{"mode":"raw","raw":"{ \"name\": \"My new name\"}"},"url":"https://capi.tokeet.com/v1/task/{{task_pkey}}?account={{account}}","description":"This endpoint updates an existing task in your account. A JSON payload must be included with this request. The possible fields and values are detailed in the task creation endpoint description.
\n","urlObject":{"protocol":"https","path":["v1","task","{{task_pkey}}"],"host":["capi","tokeet","com"],"query":[{"key":"account","value":"{{account}}"}],"variable":[]}},"response":[],"_postman_id":"305dfb7e-c7a0-c8d8-52d7-534c6305bb4c"},{"name":"Delete A Task","id":"89eb96eb-58a9-c342-dcc8-bcd00567bd5d","request":{"method":"DELETE","header":[{"key":"Authorization","value":"{{apikey}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://capi.tokeet.com/v1/task/{{task_pkey}}?account={{account}}","description":"Permanently delete a task from your account.
\n","urlObject":{"protocol":"https","path":["v1","task","{{task_pkey}}"],"host":["capi","tokeet","com"],"query":[{"key":"account","value":"{{account}}"}],"variable":[]}},"response":[],"_postman_id":"89eb96eb-58a9-c342-dcc8-bcd00567bd5d"}],"id":"7a9a6014-18ea-8290-75d2-4bc47626a7dc","description":"An Task is a resource within the Tokeet platform. It represents a bit of work that must be done in relation to your rentals. These API endpoints allow you to create, retrieve, update, and delete tasks within your Tokeet account. The requests have the same afffect as using the Tokeet web or mobile applications.
\n","_postman_id":"7a9a6014-18ea-8290-75d2-4bc47626a7dc"},{"name":"Templates","item":[{"name":"Create A Template","id":"dd313f13-d727-7aea-4973-8a57bf4be52f","request":{"method":"POST","header":[{"key":"Authorization","value":"{{apikey}}"}],"body":{"mode":"raw","raw":""},"url":"https://capi.tokeet.com/v1/template?account={{account}}","description":"This endpoint allows you to create a new template in your account. This request must include a JSON payload. The possible attributes in the payload are listed below.
\nname - required The name of the task.
body - required The text based body of the template.
type - required The type of the template. Possible values are listed below.
description - A description of the template.
\nsubject - A subject line for the template.
\nnotes - A note about the task.
\narchived - number An epoch timestamp of when the template was archived, or 0 if it is not.
Retrieve a template with the specified template id. This method returns a JSON object which represents the template data.
\n","urlObject":{"protocol":"https","path":["v1","template","{{template_pkey}}"],"host":["capi","tokeet","com"],"query":[{"key":"account","value":"{{account}}"}],"variable":[]}},"response":[],"_postman_id":"9bc2aac2-4e14-2539-0e61-6050a1c1cadc"},{"name":"Get All Templates","id":"37aa49d2-a53e-e7b0-3335-d8baf76d6659","request":{"method":"GET","header":[{"key":"Authorization","value":"{{apikey}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://capi.tokeet.com/v1/template?account={{account}}","description":"Retrieve all templates in your account. We highly recommend using the pagination query parameters if you have many templates in your account. The following query parameters may optionally by used.
\nskip - The number of items to skip in the results. This is used for pagination.\nlimit - The maximum number of items to return. This is used for pagination.\nsort - A value of 1 or -1 which represents the sort order of the results based on the task name.\ntype - A template type to limit the results. Only templates of this type will be in the results.
\n","urlObject":{"protocol":"https","path":["v1","template"],"host":["capi","tokeet","com"],"query":[{"key":"account","value":"{{account}}"}],"variable":[]}},"response":[],"_postman_id":"37aa49d2-a53e-e7b0-3335-d8baf76d6659"},{"name":"Update A Template","id":"3707efd4-4715-0b5b-c171-b52bc8890e05","request":{"method":"PUT","header":[{"key":"Authorization","value":"{{apikey}}"}],"body":{"mode":"raw","raw":"{ \"name\": \"My new template name\" }"},"url":"https://capi.tokeet.com/v1/template/{{template_pkey}}?account={{account}}","description":"This endpoint updates an existing template in your account. A JSON payload must be included with this request. The possible fields and values are detailed in the template creation endpoint description.
\n","urlObject":{"protocol":"https","path":["v1","template","{{template_pkey}}"],"host":["capi","tokeet","com"],"query":[{"key":"account","value":"{{account}}"}],"variable":[]}},"response":[],"_postman_id":"3707efd4-4715-0b5b-c171-b52bc8890e05"},{"name":"Delete A Template","id":"25cca4bd-674f-95ed-c67d-b5408686d1b1","request":{"method":"DELETE","header":[{"key":"Authorization","value":"{{apikey}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://capi.tokeet.com/v1/template/{{template_pkey}}?account={{account}}","description":"Permanently delete a template from your account.
\n","urlObject":{"protocol":"https","path":["v1","template","{{template_pkey}}"],"host":["capi","tokeet","com"],"query":[{"key":"account","value":"{{account}}"}],"variable":[]}},"response":[],"_postman_id":"25cca4bd-674f-95ed-c67d-b5408686d1b1"}],"id":"8467c0c0-9089-814b-a55c-f23d117754e7","description":"A Template is a resource within the Tokeet platform. It represents a document or other form of text which will be used during communication between Tokeet and third parties. These API endpoints allow you to create, retrieve, update, and delete templates within your Tokeet account. The requests have the same afffect as using the Tokeet web or mobile applications.
\n","_postman_id":"8467c0c0-9089-814b-a55c-f23d117754e7"},{"name":"Triggers","item":[{"name":"Create A Trigger","id":"dac1075d-0e6a-7402-9c7f-0eb665a0d508","request":{"method":"POST","header":[{"key":"Authorization","value":"{{apikey}}"}],"body":{"mode":"raw","raw":"{\n \"users\": [111],\n \"rental_id\": \"55220531-8f72-4dba-9ba5-0b19015bd0db\",\n \"event\": \"inquiry.book\",\n \"template\": \"8469bac7-f7b0-4c58-a415-32db455f7925\",\n \"handler\": \"Handlers::EmailHandler\",\n \"hours\": 4\n}"},"url":"https://capi.tokeet.com/v1/trigger?account={{account}}","description":"This endpoint allows you to create a new trigger in your account. This request must include a JSON payload. The possible attributes in the payload are listed below.
\nusers - required array This is an array of user ids that will receive the trigger notification. To send this trigger to the associated guest, please use the id '111'.
event - required This is the event to which the trigger is subscribed. You may enter either an event or timeevent when creating and updating triggers. The possible values are.
guest.create
\nguest.update
\nguest.delete
\nmessage.create
\ninquiry.create
\ninquiry.book
\ninquiry.cancel
\nevent.create
\nevent.delete
\ninvoice.create
\ninvoice.paid
\ninvoice.cancel
\ncontract.signed
\ncontract.rejected
\nsystem.error.ical.refresh
\nsystem.error
\ntimeevent - This is the time based event to which the trigger is subscribed. You may enter either an event or timeevent when creating and updating triggers. The possible values are.
\ntime.before.invoice.due
\ntime.after.invoice.due
\ntime.before.booking.start
\ntime.after.booking.start
\ntime.before.booking.end
\ntime.after.booking.end
\nrental - The id of the rental associated with this trigger.
\ntemplate - required The id of the template associated with this trigger.
handler - required A handler which represents the action you wish to perform. The possible options.
Handlers::EmailHandler
\nHandlers::ContractHandler
\nHandlers::SMSHandler
\nHandlers::WebhookHandler
\nHandlers::MobilePushHandler
\nhours - required number The number of hours associated with the trigger.
days - number The number of days associated with this trigger.
channel - The channel to which this trigger will apply. The current possible values are:
\nwidget
\ntokeet
\nairbnb
\nexpedia
\nbooking
\nwebsite
\nstatus - number The status of the expense. 0=paused, 1=active.
archived - number A value indicating if the trigger is archived. 0 means NOT archived, any non-zero value means archived.
Retrieve all triggers in your account. We highly recommend using the pagination query parameters if you have many tasks in your account. The following query parameters may optionally by used.
\nskip - The number of items to skip in the results. This is used for pagination. limit - The maximum number of items to return. This is used for pagination. sort - A value of 1 or -1 which represents the sort order of the results based on the creation date.
\n","urlObject":{"protocol":"https","path":["v1","trigger"],"host":["capi","tokeet","com"],"query":[{"key":"account","value":"{{account}}"}],"variable":[]}},"response":[],"_postman_id":"700d49d3-80eb-ccf4-d113-69f406ec15ac"},{"name":"Get A Trigger","id":"9f4e70bf-bf7c-3d09-7ea0-fc1dad75f9d4","request":{"method":"GET","header":[{"key":"Authorization","value":"{{apikey}}"}],"body":{"mode":"raw","raw":"{\n \"users\": [111],\n \"rental_id\": \"55220531-8f72-4dba-9ba5-0b19015bd0db\",\n \"event\": \"inquiry.book\",\n \"template\": \"8469bac7-f7b0-4c58-a415-32db455f7925\",\n \"handler\": \"Handlers::EmailHandler\",\n \"hours\": 4\n}"},"url":"https://capi.tokeet.com/v1/trigger/0a6cd097-9738-4003-8c5c-aab80511e60d?account={{account}}","description":"Retrieve a trigger with the specified trigger id. This method returns a JSON object which represents the trigger data.
\n","urlObject":{"protocol":"https","path":["v1","trigger","0a6cd097-9738-4003-8c5c-aab80511e60d"],"host":["capi","tokeet","com"],"query":[{"key":"account","value":"{{account}}"}],"variable":[]}},"response":[],"_postman_id":"9f4e70bf-bf7c-3d09-7ea0-fc1dad75f9d4"},{"name":"Update A Trigger","id":"4c2f81b5-707a-4b2d-e72f-796725f02c56","request":{"method":"PUT","header":[{"key":"Authorization","value":"{{apikey}}"}],"body":{"mode":"raw","raw":"{\n \"users\": [111],\n \"rental_id\": \"55220531-8f72-4dba-9ba5-0b19015bd0db\",\n \"event\": \"inquiry.book\",\n \"template\": \"8469bac7-f7b0-4c58-a415-32db455f7925\",\n \"handler\": \"Handlers::EmailHandler\",\n \"hours\": 4\n}"},"url":"https://capi.tokeet.com/v1/trigger/0a6cd097-9738-4003-8c5c-aab80511e60d?account={{account}}","description":"This endpoint updates an existing trigger in your account. A JSON payload must be included with this request. The possible fields and values are detailed in the trigger creation endpoint description.
\n","urlObject":{"protocol":"https","path":["v1","trigger","0a6cd097-9738-4003-8c5c-aab80511e60d"],"host":["capi","tokeet","com"],"query":[{"key":"account","value":"{{account}}"}],"variable":[]}},"response":[],"_postman_id":"4c2f81b5-707a-4b2d-e72f-796725f02c56"},{"name":"Pause A Trigger","id":"cb8afcd3-3b45-025d-f5f3-3a8e4489aaba","request":{"method":"PUT","header":[{"key":"Authorization","value":"{{apikey}}"}],"body":{"mode":"raw","raw":"{\n}"},"url":"https://capi.tokeet.com/v1/trigger/0a6cd097-9738-4003-8c5c-aab80511e60d/pause?account={{account}}","description":"This endpoint pauses an existing trigger in your account. An empty JSON payload must be included with this request.
\n","urlObject":{"protocol":"https","path":["v1","trigger","0a6cd097-9738-4003-8c5c-aab80511e60d","pause"],"host":["capi","tokeet","com"],"query":[{"key":"account","value":"{{account}}"}],"variable":[]}},"response":[],"_postman_id":"cb8afcd3-3b45-025d-f5f3-3a8e4489aaba"},{"name":"Resume A Trigger","id":"45d7011f-ddfe-8f54-0be6-d8f36ea6a694","request":{"method":"PUT","header":[{"key":"Authorization","value":"{{apikey}}"}],"body":{"mode":"raw","raw":"{\n}"},"url":"https://capi.tokeet.com/v1/trigger/0a6cd097-9738-4003-8c5c-aab80511e60d/resume?account={{account}}","description":"This endpoint resumes an existing trigger in your account. An empty JSON payload must be included with this request.
\n","urlObject":{"protocol":"https","path":["v1","trigger","0a6cd097-9738-4003-8c5c-aab80511e60d","resume"],"host":["capi","tokeet","com"],"query":[{"key":"account","value":"{{account}}"}],"variable":[]}},"response":[],"_postman_id":"45d7011f-ddfe-8f54-0be6-d8f36ea6a694"},{"name":"Archive A Trigger","id":"135b2c0c-17f2-af8a-f653-aba86d5a974b","request":{"method":"PUT","header":[{"key":"Authorization","value":"{{apikey}}"}],"body":{"mode":"raw","raw":"{\n}"},"url":"https://capi.tokeet.com/v1/trigger/0a6cd097-9738-4003-8c5c-aab80511e60d/archive?account={{account}}","description":"This endpoint archives an existing trigger in your account. An empty JSON payload must be included with this request.
\n","urlObject":{"protocol":"https","path":["v1","trigger","0a6cd097-9738-4003-8c5c-aab80511e60d","archive"],"host":["capi","tokeet","com"],"query":[{"key":"account","value":"{{account}}"}],"variable":[]}},"response":[],"_postman_id":"135b2c0c-17f2-af8a-f653-aba86d5a974b"},{"name":"Unarchive A Trigger","id":"ee40eba1-24d6-cdc7-c634-02f01c36375f","request":{"method":"PUT","header":[{"key":"Authorization","value":"{{apikey}}"}],"body":{"mode":"raw","raw":"{\n}"},"url":"https://capi.tokeet.com/v1/trigger/0a6cd097-9738-4003-8c5c-aab80511e60d/unarchive?account={{account}}","description":"This endpoint unarchives an existing trigger in your account. An empty JSON payload must be included with this request.
\n","urlObject":{"protocol":"https","path":["v1","trigger","0a6cd097-9738-4003-8c5c-aab80511e60d","unarchive"],"host":["capi","tokeet","com"],"query":[{"key":"account","value":"{{account}}"}],"variable":[]}},"response":[],"_postman_id":"ee40eba1-24d6-cdc7-c634-02f01c36375f"},{"name":"Delete A Trigger","id":"2836174d-e8ec-d106-e83c-04b065e01902","request":{"method":"DELETE","header":[{"key":"Authorization","value":"{{apikey}}"}],"body":{"mode":"raw","raw":"{\n}"},"url":"https://capi.tokeet.com/v1/trigger/0a6cd097-9738-4003-8c5c-aab80511e60d?account={{account}}","description":"This endpoint deletes an existing trigger in your account based on the trigger pkey.
\n","urlObject":{"protocol":"https","path":["v1","trigger","0a6cd097-9738-4003-8c5c-aab80511e60d"],"host":["capi","tokeet","com"],"query":[{"key":"account","value":"{{account}}"}],"variable":[]}},"response":[],"_postman_id":"2836174d-e8ec-d106-e83c-04b065e01902"}],"id":"184c6680-0ec0-015c-dfa2-7cce72c07957","description":"A Trigger is a resource within the Tokeet platform. It's an instruction to Tokeet to perform a particular action when an event occurs. For example, triggers can be used to notify you via email or SMS when a new booking is received or to automatically reply to guests. These API endpoints allow you to create, retrieve, update, and delete triggers within your Tokeet account. These api requests have the same afffect as using the Tokeet web or mobile applications.
\n","_postman_id":"184c6680-0ec0-015c-dfa2-7cce72c07957"},{"name":"Users","item":[{"name":"Create A User","id":"c98fe501-c6fe-08a5-037b-e19e796e86fd","request":{"method":"POST","header":[{"key":"Authorization","value":"{{apikey}}"}],"body":{"mode":"raw","raw":"{\n \"firstname\": \"Adam\",\n \"lastname: \"Smith\",\n \"email\": \"adam@smith.com\"\n}\n"},"url":"https://capi.tokeet.com/v1/user?account={{account}}","description":"This endpoint allows you to create a new user in your account. This request must include a JSON payload. The possible attributes in the payload are listed below.
\nusername - A username for the user. This is the user's email address by default.
\nfirstname - required The user's first name.
lastname - required The user's last name.
email - required email The user's primary email. This will be converted to primaryemail then added to the users email array.
roles - An array of roles or user types for this user. The possible values are as follows:
\naddress - This is a hash of address components. The values in the hash should be as follows:
\nphone - The user's phone number.
\nnotes - array An array of notes about the user.
This endpoint allows you to create a note on a user. Notes are used to keep track of information regarding a user for future reference. You must supply a JSON payload with this request. There is only one parameter, which is reqiured.
\nRetrieve a user with the specified user pkey. This method returns a JSON object which represents the user data.
\n","urlObject":{"protocol":"https","path":["v1","user","{{user_pkey}}"],"host":["capi","tokeet","com"],"query":[{"key":"account","value":"{{account}}"}],"variable":[]}},"response":[],"_postman_id":"45779765-7a97-9e0b-a9f8-f766f0c72e35"},{"name":"Get Current User","id":"aee56201-fd14-22e9-5cee-bbe02ae6633f","request":{"method":"GET","header":[{"key":"Authorization","value":"{{apikey}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://capi.tokeet.com/v1/user/me?account={{account}}","description":"Retrieve the current user associated with your API calls. This method returns a JSON object which represents the user data.
\n","urlObject":{"protocol":"https","path":["v1","user","me"],"host":["capi","tokeet","com"],"query":[{"key":"account","value":"{{account}}"}],"variable":[]}},"response":[],"_postman_id":"aee56201-fd14-22e9-5cee-bbe02ae6633f"},{"name":"Get All Users","id":"8aa4ba4f-797e-7b83-3335-62941c7d5b66","request":{"method":"GET","header":[{"key":"Authorization","value":"{{apikey}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://capi.tokeet.com/v1/user?account={{account}}","description":"Retrieve all users in your account. We highly recommend using the pagination query parameters if you have many users in your account. The following query parameters may optionally by used.
\nskip - The number of items to skip in the results. This is used for pagination.\nlimit - The maximum number of items to return. This is used for pagination.
\n","urlObject":{"protocol":"https","path":["v1","user"],"host":["capi","tokeet","com"],"query":[{"key":"account","value":"{{account}}"}],"variable":[]}},"response":[],"_postman_id":"8aa4ba4f-797e-7b83-3335-62941c7d5b66"},{"name":"Get All Users Notes","id":"dba59ad8-8362-2aec-7045-ef511b40ead6","request":{"method":"GET","header":[{"key":"Authorization","value":"{{apikey}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://capi.tokeet.com/v1/user/{{user_pkey}}/note?account={{account}}","description":"Retrieve all user notes for a specific user.
\n","urlObject":{"protocol":"https","path":["v1","user","{{user_pkey}}","note"],"host":["capi","tokeet","com"],"query":[{"key":"account","value":"{{account}}"}],"variable":[]}},"response":[],"_postman_id":"dba59ad8-8362-2aec-7045-ef511b40ead6"},{"name":"Update A User","id":"08e9c8c9-9a8c-0c4d-a889-0d40a041a3be","request":{"method":"PUT","header":[{"key":"Authorization","value":"{{apikey}}"}],"body":{"mode":"raw","raw":""},"url":"https://capi.tokeet.com/v1/user/{{user_pkey}}?account={{account}}","description":"This endpoint updates an existing user in your account. A JSON payload must be included with this request. The possible fields and values are detailed in the user creation endpoint description.
\n","urlObject":{"protocol":"https","path":["v1","user","{{user_pkey}}"],"host":["capi","tokeet","com"],"query":[{"key":"account","value":"{{account}}"}],"variable":[]}},"response":[],"_postman_id":"08e9c8c9-9a8c-0c4d-a889-0d40a041a3be"},{"name":"Update A User Note","id":"7f46c8e8-ce9f-de8d-0770-dfad4452bcb6","request":{"method":"PUT","header":[{"key":"Authorization","value":"{{apikey}}"}],"body":{"mode":"raw","raw":"{\n \"key\":\"3453f3452345334r\",\n \"note\":\"This is my update\"\n}"},"url":"https://capi.tokeet.com/v1/user/{{user_pkey}}/note/{{notekey}}?account={{account}}","description":"This endpoint updates an existing user note . A JSON payload must be included with this request. The required fields are:
\nThis endpoint allows you to delete a previously saved user note. You must provide the guest id and note key.
\n","urlObject":{"protocol":"https","path":["v1","user","{{user_pkey}}","note","{{note_key}}"],"host":["capi","tokeet","com"],"query":[{"key":"account","value":"{{account}}"}],"variable":[]}},"response":[],"_postman_id":"b43a8f68-2db8-045d-e8ee-2f281f5ac20d"},{"name":"Delete A User","id":"dc465fba-17cc-c7b5-0841-9bf3bc290e17","request":{"method":"DELETE","header":[{"key":"Authorization","value":"{{apikey}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://capi.tokeet.com/v1/user/{{user_pkey}}?account={{account}}","description":"Permanently delete a user from your account.
\n","urlObject":{"protocol":"https","path":["v1","user","{{user_pkey}}"],"host":["capi","tokeet","com"],"query":[{"key":"account","value":"{{account}}"}],"variable":[]}},"response":[],"_postman_id":"dc465fba-17cc-c7b5-0841-9bf3bc290e17"}],"id":"bb2cc9b8-a561-5601-3ae4-b2fda08321fd","description":"A User is a resource within the Tokeet platform. It represents a person who is authorized to access your Tokeet account and make changes to specified data. These API endpoints allow you to create, retrieve, update, and delete users within your Tokeet account. The requests have the same afffect as using the Tokeet web or mobile applications.
\n","_postman_id":"bb2cc9b8-a561-5601-3ae4-b2fda08321fd"}],"event":[{"listen":"prerequest","script":{"id":"094cf84b-0d0d-42e1-86b8-5a7d6d347988","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c7b636b3-af5f-49ff-8427-189e38e73016","type":"text/javascript","exec":[""]}}]}