\n
\n Sorry, we couldn’t find that page.
\nPerhaps there’s a problem with the link you used. Please contact your agent for assistance.
\n![](\"https://travefy-assets.s3.amazonaws.com/img/app/misc/Travefy-API-Banner.jpg\")
\n\nHere are some pre-made requests for you to explore the API using Postman.
\nYou need API credentials (keys) to use Travefy’s API. Please note that Travefy’s API is a paid product separate from seat licenses. Additionally, you can find all API pricing information here.
\nTo learn more about Travefy’s paid API or to purchase API Keys please email apisales@travefy.com
\nIf you already have API keys / credentials and are in need of support you can contact our API support team at apisupport@travefy.com
\nThere is a public key and a private key for your platform.
\nThink of your private key like a password:
\nStore it securely
\nDon't share it with anyone outside of your organization
\nDon't put it in any code on your website or in a Url that someone could find
\nUsers you've created on the platform also have a PublicKey and private AccessToken. This AccessToken is specific to your platform and acts as a password for the User, so do not share this access token. It may be revoked by the User at any time.
Different calls in the API require different keys. For example, creating and managing Users requires your platform's secret key. Creating Trips on behalf of a User requires your platform's public key and the AaccessToken for the User. Check each call for the requirements.
NOTE: You'll need to create an environment in Postman, select that environment, and enter your platform's api keys in the 0 - Setup/Environment Setup pre-request script (documentation on pre-request scripts) to set the environment variables. Also, the calls have dependencies. A Trip must be created before a TripDay, a TripDay must be created before a TripEvent, and GET/UPDATE/DELETE calls will only work after an item is created with a POST.
NOTE: The Create Full Trip request is the only request that allows child entities (days, events, and ideas) to be passed in with the parent entity. All other calls will only affect the primary entity.
\nMaking your first call
Test that you have the headers setup by making a GET request to /api/v1/echo with the X-API-PUBLIC-KEY header set to your platform's public key. Here's the Postman test for that. You should get a HTTP 200 OK response if your keys are correct.
Next, make a GET request to /api/v1/secureEcho with the X-API-PUBLIC-KEY and X-API-PRIVATE-KEY headers set to your platform's public and private keys. Here's the Postman test for that. You should get a HTTP 200 OK response if your keys are correct.
Notes:
\nYour platform will have separate API keys for each environment.
\nData created or modified in each environment will not affect the other.
\nData cannot be transfered from one environment to the other.
\nIf any breaking changes are made on an endpoint, then those change will be rolled out in a new version of the API. The version of an endpoint to use can be indicated in the request using the following methods:
\n/v1-{apiVersion}/...By adding a prefixed path to the api
Header value of X-API-VERSION: {apiVersion}
Query string of apiVersion={apiVersion}
The above methods are list in increasing precedence, e.g. if both the apiVersion={apiVersion} query string value is present and the /v1-{apiVersion}/... route is used, the version given in the apiVersion query string parameter will be used. The HTTP response, will contain the version number of the API version selected for the request in a X-API-VERSION header.
To upgrade the API version application-wide, using Methods 1 or 2 is best.
\nTo upgrade the version to user for a specific enpoint, using Methods 2 or 3 is best.
\nThe api version numbers are 8-digit encodings of their release date in the format YYYYMMDD.
Deprecated endpoints are marked with - Deprecated). The documentation for these endpoints will indicate when the endpoint was deprecated, as well as the proper alternative endpoint to use.
Furthermore, When hitting these endpoints, the HTTP response with contain the headers X-API-DEPRECATED-ON and X-API-DEPRECATED-MOVE-TO to provide this information as well.
This update now includes the Info & Documents section. Below is some information about this section:
There is no way to delete this section
\nYou can only have one Info & Documents section on a trip
The Info & Documents section cannot be renamed
The only event type that can be used in the Info & Documents section is the \"info\" event type (12)
The Info & Documents events only have 4 sections
Name
\nDescription
\nImages
\nTripIdeas
\nThe Info & Documents section is parameter isSupplemental either true or false. If you set \"isSupplemental\": false the events you created are placed on a \"normal\" day. If you set this to true, the events you created are placed in the Info & Documents section.
You will find more infomation about how this section is created or affected by a request, in that specific request's information. Below is a list of some of the requests you should be aware of:
\nCreate Trip - the Info & Documents section is automatically created
Create Full Trip - the IsSupplemental is required on all days
Create Trip Day - the IsSupplemental is not required on this request but is automatically set to false
For platforms that have it enabled, Users can be authenticated into your platform the Travefy environment from your site. To use this, POST a form to https://{{your-travefy-platform-url}}/auth/tokenBasedLogin. The User will then be authenticated and redirected to their account page.
Here is a sample HTML form:
\n <body>\n <!-- Change the host name if you are using a custom domain -->\n <form action=\"https://travefy.com/auth/tokenBasedLogin\" method=\"post\">\n <!-- add your PUBLIC key here -->\n <input type=\"hidden\" name=\"platformPublicKey\" value=\"3f3663bca6b7471281e5751d233e970e\" />\n <!-- add the user's access token here (details on the user token: https://documenter.getpostman.com/view/322751/travefy-api-public/53p#Users) -->\n <input type=\"hidden\" name=\"userAccessToken\" value='adf10ffa370b4b5a836dfd40d691df05' />\n <!-- style/name this button whatever you'd like -->\n <button type='submit'>Go To Travefy!</button>\n <!-- after clicking this button, the user will be authenticated on the Travefy platform and have their authentication cookies set -->\n </form>\n <br/>\n <a href=\"https://developer.travefy.com/#intro\">API welcome documentation</a>\n <br/>\n <a href=\"https://developer.travefy.com/#Users\">API Users documentation</a>\n </body>\nYou'll need to do a few changes from this example:
\nChange the base URL from travefy.com to your Travefy platform URL.
Add your platform's public key. NOTE: DO NOT add your Private Key to any public or user-accessible page.
\nAdd the user's access token. NOTE: This is a secure token and should be on a page that only authorized users can access.
\nStyle the button.
\nFor platforms that have it enabled, after users have completed authorization of the platform, they will be redirected to the authorization redirect url. The platform can retrieve information about user that has just completed authorization of the platform using the provided authorizationCode. This would most commonly be used associate a Travefy user account with the user account on the platform.
After the user has completed authorization they will be redirected to the platform provided authorization redirect url with the authorizationCode included in the code query parameter.
Example: https://yourdomain.com/travefy-authorization-callback?code={{authorizationCode}}
The authorizationCode will only be valid for 10 minutes. Upon redirect he platform should immediately request user information using the GET Get Users by Authorization Code request and complete the association of the Travefy user to the platform user.
If you would like to enable an authorization redirect url please contact support at apisupport@travefy.com.
\nBefore your authorization redirect url will be enabled, your redirect url must be tested by Travefy and meet the Guidelines for Authorization Redirect Url.
\nTo enable use of the Authorization Redirect Url your redirect url must meet the following guidelines.
\nUpon redirection with a valid authenticationCode:
The user must be displayed a message that indicates that authorization was successful.
\nThe user should be shown a message that explains what a successful authorization means. An example of this would be Your {platformName} account has been connected to your Travefy account. You can now send trips to your Travefy account.
The user must also be provided a link to either your application or Travefy that helps them to get back in to the application. In addition to the link you may also provide a delayed automatic redirect to the link destination.
\nUpon redirection with an invalid authenticationCode:
The user must be notified that their authentication was not successful.
\nThe user must be provide with instructions on how to attempt their authorization again.
\nThe user must be provided with support contact information for your platform.
\nProvide a method to de-authorize the platform. This should send the user to https://travefy.com/account/unauthorize/{platformSlug} so that they are able to de-authorize your platform.
The authorization redirect url must include a request throttle. More than 10 attempts an hour should not be allowed for a specific ip.
\nIf the authorizationCode provided to the authorization redirect url is not valid you must not expose the specific reason. There should be no difference to the user if your platform receives a Gone, NotFound or any other error response from the GET Get Users by Authorization Code request. Best practice would be to inform the user that their authorization is no longer valid and provide them with instructions on how to attempt again. The request endpoint exposes the specifics of the errors so that the platform assist users with issues they may experience during authorization.
Click here for information on our API pricing.
\nIf you have any questions or comments, please let us know at apisupport@travefy.com.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"API Keys","slug":"api-keys"},{"content":"Setup","slug":"setup"},{"content":"Making Your First Call","slug":"making-your-first-call"},{"content":"Environments","slug":"environments"},{"content":"Versioning","slug":"versioning"},{"content":"Deprecations","slug":"deprecations"},{"content":"Changelog","slug":"changelog"},{"content":"Single Sign-On (SSO)","slug":"single-sign-on-sso"},{"content":"Authorization Redirect Url","slug":"authorization-redirect-url"},{"content":"API Pricing","slug":"api-pricing"},{"content":"Questions/Comments/Suggestions","slug":"questionscommentssuggestions"}],"owner":"242473","collectionId":"8879628a-7be0-4d21-abfc-d678dac52ba1","publishedId":"RzZFDcZB","public":true,"customColor":{"top-bar":"44BBFF","right-sidebar":"303030","highlight":"2BEAAF"},"publishDate":"2019-03-29T18:52:38.000Z"},"item":[{"name":"v1","item":[{"name":"Setup","item":[{"name":"Environment Setup","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["//set your platform api keys here\r","postman.setEnvironmentVariable(\"platform-private-key\", \"Setup your access keys for all further requests in the Pre-request script. Don't have your access keys? Contact apisupport@travefy.com.
\nYou should only need to run this one time as these values will be stored in your Postman environment.
\n","urlObject":{"protocol":"https","path":["get"],"host":["postman-echo","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"4dab2389-94da-41e2-ad4f-c7ac29f7d5bb"},{"name":"Secure Echo","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;",""]}}],"id":"4d9b09b1-82b5-40bf-9be9-0681cf9f0a3c","request":{"method":"GET","header":[{"key":"X-API-PUBLIC-KEY","value":"{{platform-public-key}}"},{"key":"X-API-PRIVATE-KEY","value":"{{platform-private-key}}"}],"body":{"mode":"formdata","formdata":[]},"url":"{{base-api-url}}api/v1/secureEcho","description":"Test that calls with your platform's private API key succeed.
\n","urlObject":{"path":["v1","secureEcho"],"host":["{{base-api-url}}api"],"query":[],"variable":[]}},"response":[],"_postman_id":"4d9b09b1-82b5-40bf-9be9-0681cf9f0a3c"},{"name":"Echo","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;",""]}}],"id":"665d404d-df71-4f51-8393-5b56da60ed52","request":{"method":"GET","header":[{"key":"X-API-PUBLIC-KEY","value":"{{platform-public-key}}"}],"body":{"mode":"formdata","formdata":[]},"url":"{{base-api-url}}api/v1/echo","description":"Test that calls with your platform's public API key succeed.
\n","urlObject":{"path":["v1","echo"],"host":["{{base-api-url}}api"],"query":[],"variable":[]}},"response":[],"_postman_id":"665d404d-df71-4f51-8393-5b56da60ed52"}],"id":"7957aded-afde-40f4-a265-ef611af4a43d","description":"Add your API keys to the Pre-request Script and execute the Environment Setup request to setup the environment.
//set your platform api keys here\npostman.setEnvironmentVariable(\"platform-private-key\", \"<YOUR-PLATFORM-PRIVATE-API-KEY>\");\npostman.setEnvironmentVariable(\"platform-public-key\", \"<YOUR-PLATFORM-PUBLIC-API-KEY>\");\nCreate a User on the Travefy platform.
The response of this request give you a chance to store the AccessToken and PublicKey for the User. Those keys are also available on the User GET and GET by Id requests. These are automatically stored in the Postman environment for testing.
Note: if the User already has an account on Travefy, they'll need to authorize your Platform on their account. Send them to https://{{your-travefy-platform-url}}/account/authorize and they can approve access. You can then retrieve their tokens via the Get Users call.
Create a User on the Travefy platform that will authenticate using SSO.
When a user is created through the API they receive a welcome email that enables them to login through the Travefy login form. If you users are using SSO then they wont need this and it can be confusing. You can prevent the welcome email from sending by setting DisableWelcomeEmail to true.
Get a User from the Travefy platform by their Id.
### Sample Response
\n{\n \"User\": {\n \"Id\": 123456,\n \"FullName\": \"Agent Level 1 User\",\n \"ImageUrl\": \"https://s3.amazonaws.com/travefy-storage/content/default-4.gif\",\n \"Username\": \"agent1.1505227550@example.com\",\n \"IsAgent\": true,\n \"SubscriptionPeriodEnd\": \"2019-10-10T00:00:00\",\n \"AgentSubscriptionIsActive\": true,\n \"Title\": \"Travel Expert\",\n \"Phone\": \"555-555-1234\",\n \"Url\": \"https://travefy.com/\",\n \"CompanyLogoUrl\": \"https://s3.amazonaws.com/travefy-storage/link-content/companyLogo/13551d3417bd481883931d9d8ff054aa.jpg\"\n },\n \"AccessToken\": \"f33ccb599f19844e4f7047bd1088cef0\",\n \"PublicKey\": \"9318aebc16aa44e1bf552234f710e8ea\",\n \"AgentSubscriptionLevel\": 1,\n \"PartnerIdentifier\": \"user-123\",\n \"IsActive\": true,\n \"CreatedOn\": \"2017-09-12T14:45:46.397\"\n}\n\nUpdate a User. Currently, this will update Username (email), FullName, and ImageUrl.
\n","urlObject":{"path":["v1","users","{{user-id}}"],"host":["{{base-api-url}}api"],"query":[],"variable":[]}},"response":[{"id":"2beba9ef-c675-40c2-bf4f-d6f04233f705","name":"Update User","originalRequest":{"method":"PUT","header":[{"key":"X-API-PRIVATE-KEY","value":"{{platform-private-key}}"},{"key":"X-API-PUBLIC-KEY","value":"{{platform-public-key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"user\" : {\r\n \"username\" : \"updated+agent1-1763754959-updated@example.com\",\r\n \"fullName\" : \"updated test agent2\"\r\n }\r\n}\r\n\r\n"},"url":"{{base-api-url}}api/v1/users/{{user-id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"cache-control","value":"no-cache","description":""},{"key":"connection","value":"keep-alive","description":""},{"key":"content-encoding","value":"gzip","description":""},{"key":"content-length","value":"405","description":""},{"key":"content-type","value":"application/json; charset=utf-8","description":""},{"key":"date","value":"Tue, 12 Sep 2017 14:50:27 GMT","description":""},{"key":"expires","value":"-1","description":""},{"key":"pragma","value":"no-cache","description":""},{"key":"server","value":"nginx/1.10.3","description":""},{"key":"strict-transport-security","value":"max-age=31536000","description":""},{"key":"vary","value":"Accept-Encoding","description":""},{"key":"x-aspnet-version","value":"4.0.30319","description":""}],"cookie":[],"responseTime":"103","body":"{\n \"User\": {\n \"Id\": 127630,\n \"FullName\": \"updated test agent2\",\n \"ImageUrl\": null,\n \"Username\": \"updated+agent1-1505227826-updated@example.com\",\n \"IsAgent\": true,\n \"SubscriptionPeriodEnd\": \"2019-10-10T00:00:00\",\n \"AgentSubscriptionIsActive\": true,\n \"Title\": \"Travel Expert\",\n \"Phone\": \"555-555-1234\",\n \"Url\": \"https://travefy.com/\",\n \"CompanyLogoUrl\": \"https://s3.amazonaws.com/travefy-storage/link-content/companyLogo/13551d3417bd481883931d9d8ff054aa.jpg\"\n },\n \"AccessToken\": \"f33ccb599f19844e4f7047bd1088cef0\",\n \"PublicKey\": \"9318aebc16aa44e1bf552234f710e8ea\",\n \"AgentSubscriptionLevel\": 1,\n \"PartnerIdentifier\": \"user-123\",\n \"IsActive\": true,\n \"CreatedOn\": \"2017-09-12T14:45:46.397\"\n}"}],"_postman_id":"1a82b70a-50c7-47fa-982a-7eb6b13ad29d"},{"name":"Get Users","event":[{"listen":"test","script":{"id":"a6359111-11a0-4199-8e5e-0d4c33bbe711","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","","var data = JSON.parse(responseBody);","","tests[\"at least one user was returned\"] = data.length;","","var firstUser = data[0];","tests[\"Has created on\"] = firstUser.CreatedOn;","tests[\"Is Active\"] = firstUser.IsActive;",""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"e09e63b8-b06c-40f2-ab1e-a212b26b05c9","request":{"method":"GET","header":[{"key":"X-API-PRIVATE-KEY","value":"{{platform-private-key}}"},{"key":"X-API-PUBLIC-KEY","value":"{{platform-public-key}}"}],"body":{"mode":"raw","raw":"{\r\n \"asdf\": \"fdsa\"\r\n}\r\n"},"url":"{{base-api-url}}api/v1/users","description":"Get all Users that your platform has access to.
\n### Sample Response
\n[\n {\n \"User\": {\n \"Id\": 123456,\n \"FullName\": \"a test agent2\",\n \"ImageUrl\": null,\n \"Username\": \"updated+agent1-1505226542-updated@example.com\",\n \"IsAgent\": true,\n \"SubscriptionPeriodEnd\": \"2017-09-22T14:29:35\",\n \"AgentSubscriptionIsActive\": true,\n \"Title\": null,\n \"Phone\": null,\n \"Url\": null,\n \"CompanyLogoUrl\": null\n },\n \"AccessToken\": \"ced4a3f4c1822b221710afe4c2fba447\",\n \"PublicKey\": \"cb3cbdc5507c3643093fea48d21fdc49\",\n \"AgentSubscriptionLevel\": 1,\n \"PartnerIdentifier\": \"user-456\",\n \"IsActive\": false,\n \"CreatedOn\": \"2017-09-12T14:28:57.503\"\n },\n {\n \"User\": {\n \"Id\": 123457,\n \"FullName\": \"updated test agent2\",\n \"ImageUrl\": null,\n \"Username\": \"updated+agent1-1505227826-updated@example.com\",\n \"IsAgent\": true,\n \"SubscriptionPeriodEnd\": \"2019-10-10T00:00:00\",\n \"AgentSubscriptionIsActive\": true,\n \"Title\": \"Travel Expert\",\n \"Phone\": \"555-555-1234\",\n \"Url\": \"https://travefy.com/\",\n \"CompanyLogoUrl\": \"https://s3.amazonaws.com/travefy-storage/link-content/companyLogo/13551d3417bd481883931d9d8ff054aa.jpg\"\n },\n \"AccessToken\": \"f7047bd3cef5999843ccbe410884ff10\",\n \"PublicKey\": \"34f16a93e8ef51a44e7108aebc1b522a\",\n \"AgentSubscriptionLevel\": 1,\n \"PartnerIdentifier\": \"user-456\",\n \"IsActive\": true,\n \"CreatedOn\": \"2017-09-12T14:45:46.397\"\n },\n ...\n]\n\nGet a User from the Travefy platform by their expiring authorizationCode. This will return a collection with a single user if the authorizationCode is valid.
This method should be used to associate a user that was sent to Travefy to authorize your platform. If the authorizationCode is expired the response code returned will be Gone.
See Authorization Redirect Url for information on retrieving and using the authorizationCode.
-
HEADERS
X-API-PRIVATE-KEY {{platform-private-key}}
X-API-PUBLIC-KEY {{platform-public-key}}
[\n {\n \"User\": {\n \"Id\": 123456,\n \"FullName\": \"a test agent2\",\n \"ImageUrl\": null,\n \"Username\": \"updated+agent1-1505226542-updated@example.com\",\n \"IsAgent\": true,\n \"SubscriptionPeriodEnd\": \"2017-09-22T14:29:35\",\n \"AgentSubscriptionIsActive\": true,\n \"Title\": null,\n \"Phone\": null,\n \"Url\": null,\n \"CompanyLogoUrl\": null\n },\n \"AccessToken\": \"ced4a3f4c1822b221710afe4c2fba447\",\n \"PublicKey\": \"cb3cbdc5507c3643093fea48d21fdc49\",\n \"AgentSubscriptionLevel\": 1,\n \"PartnerIdentifier\": \"user-123\",\n \"IsActive\": false,\n \"CreatedOn\": \"2017-09-12T14:28:57.503\"\n }\n]\n\nGet a User from the Travefy platform by their partnerIdentifier. partnerIdentifier is a unique Id that was optionally set in the Create User call. This will return a collection with a single user if the partnerIdentifier is valid.
-
HEADERS
X-API-PRIVATE-KEY {{platform-private-key}}
X-API-PUBLIC-KEY {{platform-public-key}}
[\n {\n \"User\": {\n \"Id\": 123456,\n \"FullName\": \"a test agent2\",\n \"ImageUrl\": null,\n \"Username\": \"updated+agent1-1505226542-updated@example.com\",\n \"IsAgent\": true,\n \"SubscriptionPeriodEnd\": \"2017-09-22T14:29:35\",\n \"AgentSubscriptionIsActive\": true,\n \"Title\": null,\n \"Phone\": null,\n \"Url\": null,\n \"CompanyLogoUrl\": null\n },\n \"AccessToken\": \"ced4a3f4c1822b221710afe4c2fba447\",\n \"PublicKey\": \"cb3cbdc5507c3643093fea48d21fdc49\",\n \"AgentSubscriptionLevel\": 1,\n \"PartnerIdentifier\": \"user-123\",\n \"IsActive\": false,\n \"CreatedOn\": \"2017-09-12T14:28:57.503\"\n }\n]\n\nIn production, your platform may be charged for any created users. Sandbox users are free to create.
\nAgentSubscriptionLevel values:
After successfully creating the User, POST method returns an object with the following properties:
User - The User that was created.AccessToke - Your platform's AccessToken for this User, keep this securely stored like a password.PublicKey - The PublicKey for this User, this is a unique, non-secure identifier and should be stored.AgentSubscriptionLevel - The level of their Travefy Pro subscription.Create a Trip on the Travefy platform with a full itinerary (TripDays and TripEvents).
Create an empty Trip on the Travefy platform.
Get a Trip from the Travefy platform.
Get a Trip from the Travefy platform by PartnerIdentifier.
Get a Trip from the Travefy platform by SharedId, which is the identifier at the end of ShareUrlPath.
Get every Trip created by your platform for the given User.
Update the Trip itinerary information AND metadata (Name, TripCoverPhotoUrl, etc.). Note: do not pass up any TripDays if you only want to update the metadata.
If you pass up any TripDays, the entire trip itinerary information will be replaced. Chat messages and saved TripIdeas will be maintained, but all TripDays, TripEvents, and TripIdeas on TripEvents will be replaced.
Update the Trip itinerary metadata only (Name, TripCoverPhotoUrl, etc.). Note: do not pass up any TripDays if you only want to update the metadata.
Archives the Trip.
Deletes the Trip.
Unarchives the Trip. This request is the same as the other update and is only here so the trip will be unarchived once the test suite is finished.
This functionality is currently in beta. Please contact us for more info.
\n","urlObject":{"path":["v1","trips","copy"],"host":["{{base-api-url}}api"],"query":[],"variable":[]}},"response":[],"_postman_id":"7bc0ed26-0dd2-48f1-b222-6df381f3f2a4"}],"id":"bab51fb0-a0bb-4db0-870c-1dfd11a5ffb6","description":"Status can be set from one of the statuses the User has created in the web interface and is matched by the string provided. The match is not case-sensitive. If no matching Status is found, it is not set (\"No Status\" in the UI). Quote, Confirmed, and Paid are default statuses for all agents currently, but this is subject to change.
TripIdeas are a collection on a TripEvent and are often establishments or other info that is associated with the TripEvent. For example, the event may be \"Beachside Dinner\" with a time and reservation info and the idea may be \"Shorebird Resturant\" with the location, hours, etc. Currently these are completely stand-alone and will not connect with any existing items from the Travefy database or an agent's Content Library. See the Create Full Trip request for an example usage.
The PartnerIdentifier field on a Trip can be used to store your identifier on the Trip. For example, if you have a different identifier for the Trip in your database, you can store that here. You can then query the Trip by that identifier to get the Travefy Id for the Trip. Note: This field must be unique across your platform.
Create a TripDay on a given Trip.
NOTE: You must supply the X-TRIP-ID header with the TripId from the created Trip.
Get all the TripDays for this Trip.
NOTE: You must supply the X-TRIP-ID header with the TripId from the created Trip.
Get the specified TripDay.
NOTE: You must supply the X-TRIP-ID header with the TripId from the created Trip.
Update the specified TripDay.
NOTE: You must supply the X-TRIP-ID header with the TripId from the created Trip.
Delete the specified TripDay.
NOTE: You must supply the X-TRIP-ID header with the TripId from the created Trip.
A TripDay represents a day on the itinerary. It may have a date (e.g. 2017/01/24) or may not (e.g. Day 2).
NOTE: You must supply the X-TRIP-ID header with the TripId from the created Trip for all of these calls.
Create a TripEvent on a given TripDay.
NOTE: You must supply a valid TripDayId for the TripEvent.
NOTE: You must supply the X-TRIP-ID header with the TripId from the created Trip.
Get every TripEvent on this Trip.
NOTE: You must supply the X-TRIP-ID header with the created Trip's TripId.
Get a specified TripEvent.
NOTE: You must supply the X-TRIP-ID header with the TripId from the created Trip.
Update the metadata of a specified TripEvent.
NOTE: You must supply the X-TRIP-ID header with the TripId from the created Trip.
NOTE: do not pass up any TripDays if you only want to update the metadata.
If you pass up any TripIdeas, the entire list of TripIdeas will be replaced.
is awesome!
\",\n \"StartTimeZoneId\": null,\n \"StartTimeInMinutes\": 137,\n \"DurationInMinutes\": 120,\n \"StartTerminal\": null,\n \"StartGate\": null,\n \"EndTerminal\": null,\n \"EndGate\": null,\n \"PriceInCents\": null,\n \"CurrencyCode\": null,\n \"TransportationIdentifier\": null,\n \"EventType\": 4,\n \"IsEndingEvent\": false,\n \"IsArrival\": false,\n \"TripIdeas\": null,\n \"PartnerIdentifier\": null\n}"}],"_postman_id":"30472782-0f19-4fad-a515-79a2dfeaaff1"},{"name":"Update Trip Event","event":[{"listen":"test","script":{"id":"6aadc6b1-db38-486f-83e1-7cbbba34f0ef","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;\r","\r","var data = JSON.parse(responseBody);\r","\r","tests['Body contains Trip Event'] = data.Id;\r","tests['Body contains Trip Day'] = data.TripDayId;\r","tests['Body contains event type'] = data.EventType;\r","\r","postman.setEnvironmentVariable(\"trip-event-id\", data.Id);\r",""],"type":"text/javascript"}}],"id":"dea75865-9dab-419d-8ad2-e987ffdf61d8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"X-USER-TOKEN","value":"{{user-access-token}}"},{"key":"X-API-PUBLIC-KEY","value":"{{platform-public-key}}"},{"key":"X-TRIP-ID","value":"{{trip-id}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{ \r\n \"TripDayId\": \"{{trip-day-id}}\",\r\n \"Name\": \"Updated Event 1780225217\",\r\n \"Description\": \"is awesome!\",\r\n \"StartTimeInMinutes\": \"187\",\r\n \"EventType\": 6,\r\n \"SegmentProviderName\": \"Hilton-Kansas City\",\r\n \"SegmentProviderPhone\": \"555-867-5309\",\r\n \"SegmentProviderUrl\": \"https://hilton.com\",\r\n \"SegmentIdentifier\": \"YFHP02XVDB\",\r\n \"DurationInMinutes\": 120,\r\n \"ReservationDescription\": \"Executive Suite, One King\",\r\n \"IsActive\": true,\r\n \t\"TripIdeas\": [\r\n \t\t{\r\n \t\t\t\"Id\": {{trip-idea-id}},\r\n\t \"Name\": \"My New Place\",\r\n\t \"ImageUrl\": \"http://lorempixel.com/400/200/cats\",\r\n\t \"Url\": \"https://example.com\",\r\n\t \"Description\": \"A wonderful place to go!\",\r\n\t \"Latitude\": 34.0784796,\r\n\t \"Longitude\": -107.6184694,\r\n\t \"Address\": \"123 W Main St\",\r\n\t \"City\": \"Citytown\",\r\n\t \"State\": \"NM\",\r\n\t \"ZipCode\": \"87825\",\r\n\t \"Phone\": null,\r\n\t \"Country\": \"US\",\r\n\t \"IsActive\": true\r\n }\r\n \t]\r\n}"},"url":"{{base-api-url}}api/v1/tripEvents/{{trip-event-id}}","description":"Update a specified TripEvent and it's TripIdeas.
NOTE: You must supply the X-TRIP-ID header with the TripId from the created Trip.
NOTE: do not pass up any TripDays if you only want to update the metadata.
If you pass up any TripIdeas, the entire list of TripIdeas will be replaced.
is awesome!
\",\n \"StartTimeZoneId\": null,\n \"StartTimeInMinutes\": 137,\n \"DurationInMinutes\": 120,\n \"StartTerminal\": null,\n \"StartGate\": null,\n \"EndTerminal\": null,\n \"EndGate\": null,\n \"PriceInCents\": null,\n \"CurrencyCode\": null,\n \"TransportationIdentifier\": null,\n \"EventType\": 4,\n \"IsEndingEvent\": false,\n \"IsArrival\": false,\n \"TripIdeas\": null,\n \"PartnerIdentifier\": null\n}"}],"_postman_id":"dea75865-9dab-419d-8ad2-e987ffdf61d8"},{"name":"Delete Trip Event ","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","","tests['IsActive is false'] = !data.IsActive;",""]}}],"id":"699b69cc-01fc-44b1-8fca-7a86b53c7a18","request":{"method":"DELETE","header":[{"key":"X-USER-TOKEN","value":"{{user-access-token}}"},{"key":"X-API-PUBLIC-KEY","value":"{{platform-public-key}}"},{"key":"X-TRIP-ID","value":"{{trip-id}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"formdata","formdata":[]},"url":"{{base-api-url}}api/v1/tripEvents/{{trip-event-id}}","description":"Delete a specified TripEvent.
NOTE: You must supply the X-TRIP-ID header with the TripId from the created Trip.
is awesome!
\",\n \"StartTimeZoneId\": null,\n \"StartTimeInMinutes\": 137,\n \"DurationInMinutes\": 120,\n \"StartTerminal\": null,\n \"StartGate\": null,\n \"EndTerminal\": null,\n \"EndGate\": null,\n \"PriceInCents\": null,\n \"CurrencyCode\": null,\n \"TransportationIdentifier\": null,\n \"EventType\": 4,\n \"IsEndingEvent\": false,\n \"IsArrival\": false,\n \"TripIdeas\": null,\n \"PartnerIdentifier\": null\n}"}],"_postman_id":"699b69cc-01fc-44b1-8fca-7a86b53c7a18"}],"id":"18a8408b-9aaa-4d06-a275-828bfac1f58a","description":"A TripEvent is an item on the TripDay.
NOTE: You must supply a valid TripDayId for the TripEvent.
NOTE: You must supply the X-TRIP-ID header with the TripId from the created Trip.
TripEventType can be set to one of the following:
Here's a list of time zones (use the \"Timezone\" field): https://docs.microsoft.com/en-us/windows-hardware/manufacture/desktop/default-time-zones
\nFor the Description field, the following restrictions apply:
Allowed tags:\na, b, br, div, em, i, li, ol, p, span, strong, ul
Allowed attributes:\nhref, style
Allowed CSS properties\nbackground-color
Allowed URI Schemes:\nhttps, http, mailto, tel
The ReservationDescription field will display as \"Seat / Tickey Details\" for Flight (0) events and display \"Room Type / Bedding\" for Hotel (6) events and will not display for all others.
Create (invite) 1 or more TripUsers to a Trip. FullName and UserName (email) are required.
Currently, this will not send an invite email to them, so you will need to notify them to check their trips list if needed.
\nNOTE: You cannot invite anyone in the Organizer Role.
NOTE: You must supply the X-TRIP-ID header with the TripId from the created Trip and it must match the trip-id in the URI.
Retreive a given TripUser.
NOTE: You must supply the X-TRIP-ID header with the TripId from the created Trip and it must match the trip-id in the URI.
Retreive all TripUsers on a Trip.
NOTE: You must supply the X-TRIP-ID header with the TripId from the created Trip and it must match the trip-id in the URI.
Update the Role of a given TripUser on a Trip.
NOTE: You cannot update anyone to the Organizer Role. You cannot change the Role of an existing Organizer.
NOTE: You must supply the X-TRIP-ID header with the TripId from the created Trip and it must match the trip-id in the URI.
Update the Roles of multiple TripUsers on a Trip.
NOTE: You cannot update anyone to the Organizer Role. You cannot change the Role of an existing Organizer.
NOTE: You must supply the X-TRIP-ID header with the TripId from the created Trip and it must match the trip-id in the URI.
Delete (uninvite) a given TripUser on a Trip.
NOTE: You cannot remove anyone in the Organizer Role.
NOTE: You must supply the X-TRIP-ID header with the TripId from the created Trip and it must match the trip-id in the URI.
A TripUser represents a User on a Trip. TripUsers can be invited to a trip and have different roles depending on your subscription level. Here are the available Roles:
Available operations:
\nTripUsersTripUserTripUsers for a TripTripUserTripUsersTripUser which moves them to the Uninvited RoleNOTE: You must supply the X-TRIP-ID header with the TripId from the created Trip and it must match the trip-id in the URI. The TripUser endpoints use a slightly different URL structure than other Trip resources. We will likely move to this type of structure in the future for all Trip resources. We will version the API or allow the old style rather than making breaking changes to existing calls.
Remove a User from the Travefy platform.
Note: You will not be able to re-enable or re-create a User after calling this. The User will have to re-authorize your platform manually.
true to return only Events created by the user, false to return all Events for the User's team. Defaults to true.
EventType can be set to one of the following:
The ReservationDescription field will display as \"Seat / Tickey Details\" for Flight (0) events and display \"Room Type / Bedding\" for Hotel (6) events and will not display for all others.
Note: Attached content cannot be viewed or managed via the API at this time.
\n","_postman_id":"2e048b6c-3877-47fb-be1e-0019be0770d9"},{"name":"Content","item":[{"name":"Create Content","event":[{"listen":"test","script":{"type":"text/javascript","exec":["var data = JSON.parse(responseBody);","","tests['Content was created'] = data.Id > 0;","tests['Content is active'] = data.IsActive;","tests['Content Name'] = data.Name;","tests['Content image url'] = data.ImageUrl;","tests['Content url'] = data.Url;","tests['Content latutude'] = data.Latitude;","tests['Content longutude'] = data.Longitude;","tests['Content city'] = data.City;","tests['Content state'] = data.State;","tests['Content zip'] = data.ZipCode;","tests['Content country'] = data.Country;","tests['Content description'] = data.Description;","tests['Content description'] = data.Category;","tests['Content description'] = data.Rating;","tests['Content description'] = data.Phone;","","tests['Content partner identifier'] = data.PartnerIdentifier.startsWith(\"test-content-\");","","postman.setEnvironmentVariable(\"saved-content-id\", data.Id);","postman.setEnvironmentVariable(\"saved-content-partner-identifier\", data.PartnerIdentifier);"]}}],"id":"6cdb3d06-a158-49be-92cf-75c9775b938f","request":{"method":"POST","header":[{"key":"X-USER-TOKEN","value":"{{user-access-token}}"},{"key":"X-API-PUBLIC-KEY","value":"{{platform-public-key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Name\": \"My Place\",\n \"ImageUrl\": \"http://lorempixel.com/g/400/200/cats/content/\",\n \"Url\": \"https://example.com\",\n \"Latitude\": 46.127931,\n \"Longitude\": -76.122413,\n \"Address\": \"123 Main Street\",\n \"City\": \"Lincoln\",\n \"State\": \"NE\",\n \"ZipCode\": \"68508\",\n \"Country\": \"US\",\n \"Description\": \"This is a GREAT place to visit!\",\n \"Category\": 338,\n \"Rating\": 4.2,\n \"IsActive\": true,\n \"Phone\": \"(402) 867-5309\",\n \"PartnerIdentifier\": \"test-content-id-1780225217\"\n}"},"url":"{{base-api-url}}api/v1/library/content","urlObject":{"path":["v1","library","content"],"host":["{{base-api-url}}api"],"query":[],"variable":[]}},"response":[{"id":"31733a5e-898a-498b-9fe3-594c43e0d71e","name":"Create Content","originalRequest":{"method":"POST","header":[{"key":"X-USER-TOKEN","value":"{{user-access-token}}"},{"key":"X-API-PUBLIC-KEY","value":"{{platform-public-key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Name\": \"My Place\",\n \"ImageUrl\": \"http://lorempixel.com/g/400/200/cats/content/\",\n \"Url\": \"https://example.com\",\n \"Latitude\": 46.127931,\n \"Longitude\": -76.122413,\n \"Address\": \"123 Main Street\",\n \"City\": \"Lincoln\",\n \"State\": \"NE\",\n \"ZipCode\": \"68508\",\n \"Country\": \"US\",\n \"Description\": \"This is a GREAT place to visit!\",\n \"Category\": 338,\n \"Rating\": 4.2,\n \"IsActive\": true,\n \"Phone\": \"(402) 867-5309\",\n \"PartnerIdentifier\": \"test-content-id-1780225217\"\n}"},"url":"{{base-api-url}}api/v1/library/content"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"439","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Wed, 15 Nov 2017 21:44:41 GMT","name":"Date","description":""},{"key":"Expires","value":"-1","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"Microsoft-IIS/10.0","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""},{"key":"X-SourceFiles","value":"=?UTF-8?B?Tjpcd29ya3NwYWNlc1x0cmF2ZWZ5XHRyYXZlZnlcVHJhdmVmeS5BcGlcYXBpXHYxXGxpYnJhcnlcY29udGVudA==?=","name":"X-SourceFiles","description":""}],"cookie":[],"responseTime":"287","body":"{\n \"Id\": 261577,\n \"Name\": \"My Place\",\n \"ImageUrl\": \"http://lorempixel.com/g/400/200/cats/content/\",\n \"Url\": \"https://example.com\",\n \"Latitude\": 46.127931,\n \"Longitude\": -76.122413,\n \"Address\": \"123 Main Street\",\n \"City\": \"Lincoln\",\n \"State\": \"NE\",\n \"ZipCode\": \"68508\",\n \"Country\": \"US\",\n \"Description\": \"This is a GREAT place to visit!\",\n \"Category\": 338,\n \"Rating\": 4.2,\n \"IsActive\": true,\n \"Phone\": \"(402) 867-5309\",\n \"PartnerIdentifier\": \"test-content-id-1510782282\"\n}"}],"_postman_id":"6cdb3d06-a158-49be-92cf-75c9775b938f"},{"name":"Get All Content","event":[{"listen":"test","script":{"id":"40423847-f1e3-4306-9eae-1a2373e6e2b1","exec":["var data = JSON.parse(responseBody);","","tests['content was returned'] = data.length > 0;","","var firstContent = data[0]; ","","tests['Content was created'] = firstContent.Id > 0;","tests['Content is active'] = firstContent.IsActive;","tests['Content Name'] = firstContent.Name;","tests['Content image url'] = firstContent.ImageUrl;","tests['Content url'] = firstContent.Url;","tests['Content latutude'] = firstContent.Latitude;","tests['Content longutude'] = firstContent.Longitude;","tests['Content city'] = firstContent.City;","tests['Content state'] = firstContent.State;","tests['Content zip'] = firstContent.ZipCode;","tests['Content country'] = firstContent.Country;","tests['Content description'] = firstContent.Description;","tests['Content description'] = firstContent.Category;","tests['Content description'] = firstContent.Rating;","tests['Content description'] = firstContent.Phone;",""],"type":"text/javascript"}}],"id":"40b72fe2-05ac-4413-bdd4-2bd7ad41b83f","request":{"method":"GET","header":[{"key":"X-USER-TOKEN","value":"{{user-access-token}}"},{"key":"X-API-PUBLIC-KEY","value":"{{platform-public-key}}"}],"url":"{{base-api-url}}api/v1/library/content?createdByUser=true","urlObject":{"path":["v1","library","content"],"host":["{{base-api-url}}api"],"query":[{"description":{"content":"true to return only Content created by the user, false to return all Content for the User's team. Defaults to true.
You can now manage the Library of your Users.
\nNote, the following features are not yet available in the API:
\nPartnerIdentifierCreate an inventory record.
\n","urlObject":{"path":["v1","inventoryRecords",""],"host":["{{base-api-url}}api"],"query":[],"variable":[]}},"response":[{"id":"1ff19ecd-2d39-45c9-95f0-f0e8d2be9226","name":"Create Inventory Record","originalRequest":{"method":"POST","header":[{"key":"X-API-PUBLIC-KEY","value":"{{platform-public-key}}"},{"key":"X-API-PRIVATE-KEY","value":"{{platform-private-key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"Id\": \"test-123 1780225217\",\r\n \"Name\": \"Personalized Tours of Travefy Office\",\r\n \"Url\": \"https://travefy.com/\",\r\n \"Description\": \"See where the Travefy magic happens! \\r\\n Enjoy your lovely view of the vibrant Lincoln Haymarket.\",\r\n \"ImageUrl\": \"http://nebraskaglobal.com/images/img-contact2.jpg\",\r\n \"IsActive\": true,\r\n \"Latitude\": 40.814385,\r\n \"Longitude\": -96.710113,\r\n \"Price\": null,\r\n \"CurrencyCode\": null,\r\n \"Address\": \"151 N 8th St, #300\",\r\n \"City\": \"Lincoln\",\r\n \"State\": \"NE\",\r\n \"Country\": \"US\",\r\n \"ZipCode\": \"68506\",\r\n \"HideOnMap\": false,\r\n \"SearchAttributes\": [\r\n {\r\n \"Key\": \"Type\",\r\n \"Value\": \"Office\"\r\n },\r\n {\r\n \"Key\": \"Maximum Occupancy\",\r\n \"Value\": \"15\"\r\n }\r\n ],\r\n \"ImageUrls\": [\r\n \"https://about.travefy.com/wp-content/uploads/2015/09/team-bkgrd-2015.jpg\",\r\n \"https://about.travefy.com/wp-content/uploads/2014/08/Andrew-Badami-Travefy.jpg\",\r\n \"https://about.travefy.com/wp-content/uploads/2015/06/stephanie-leonard-travefy.jpg\"\r\n ],\r\n \"TopLevelCategories\": [\r\n \"Office Tours\"\r\n ],\r\n \"DescriptionAttributes\": [\r\n {\r\n \"Key\": \"Cost\",\r\n \"Value\": \"FREE!\"\r\n },\r\n {\r\n \"Key\": \"Hours\",\r\n \"Value\": \"30pm\"\r\n },\r\n {\r\n \"Key\": \"WiFi\",\r\n \"Value\": \"Available\"\r\n },\r\n {\r\n \"Key\": \"Parking\",\r\n \"Value\": \"On Street\"\r\n }\r\n ]\r\n}"},"url":"{{base-api-url}}api/v1/inventoryRecords/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"name":"cache-control","key":"cache-control","value":"no-cache","description":""},{"name":"connection","key":"connection","value":"keep-alive","description":""},{"name":"content-length","key":"content-length","value":"1047","description":""},{"name":"content-type","key":"content-type","value":"application/json; charset=utf-8","description":""},{"name":"date","key":"date","value":"Wed, 25 Oct 2017 18:21:49 GMT","description":""},{"name":"expires","key":"expires","value":"-1","description":""},{"name":"pragma","key":"pragma","value":"no-cache","description":""},{"name":"server","key":"server","value":"nginx/1.12.1","description":""},{"name":"strict-transport-security","key":"strict-transport-security","value":"max-age=31536000","description":""},{"name":"x-aspnet-version","key":"x-aspnet-version","value":"4.0.30319","description":""}],"cookie":[],"responseTime":"657","body":"{\"Id\":\"test-123 1508955704\",\"Name\":\"Personalized Tours of Travefy Office\",\"Url\":\"https://travefy.com/\",\"Description\":\"See where the Travefy magic happens! \\r\\n Enjoy your lovely view of the vibrant Lincoln Haymarket.\",\"ImageUrl\":\"http://nebraskaglobal.com/images/img-contact2.jpg\",\"IsActive\":true,\"Latitude\":40.814385,\"Longitude\":-96.710113,\"Price\":null,\"CurrencyCode\":null,\"Address\":\"151 N 8th St, #300\",\"City\":\"Lincoln\",\"State\":\"NE\",\"Country\":\"US\",\"ZipCode\":\"68506\",\"Phone\":null,\"HideOnMap\":false,\"SearchAttributes\":[{\"Key\":\"Type\",\"Value\":\"Office\"},{\"Key\":\"Maximum Occupancy\",\"Value\":\"15\"}],\"ImageUrls\":[\"https://about.travefy.com/wp-content/uploads/2015/09/team-bkgrd-2015.jpg\",\"https://about.travefy.com/wp-content/uploads/2014/08/Andrew-Badami-Travefy.jpg\",\"https://about.travefy.com/wp-content/uploads/2015/06/stephanie-leonard-travefy.jpg\"],\"TopLevelCategories\":[\"Office Tours\"],\"DescriptionAttributes\":[{\"Key\":\"Cost\",\"Value\":\"FREE!\"},{\"Key\":\"Hours\",\"Value\":\"30pm\"},{\"Key\":\"WiFi\",\"Value\":\"Available\"},{\"Key\":\"Parking\",\"Value\":\"On Street\"}]}"}],"_postman_id":"8c609d34-9bc3-45fe-81c2-2ed4665d7628"},{"name":"Get Inventory Record","event":[{"listen":"test","script":{"type":"text/javascript","exec":["var data = JSON.parse(responseBody);","","tests['Has record'] = data.Id;","tests['Matching id'] = data.Id === postman.getEnvironmentVariable(\"inventory-id\");",""]}}],"id":"8a1a014e-dd76-4dd8-9266-6357764f773f","request":{"method":"GET","header":[{"key":"X-API-PUBLIC-KEY","value":"{{platform-public-key}}"},{"key":"X-API-PRIVATE-KEY","value":"{{platform-private-key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"formdata","formdata":[]},"url":"{{base-api-url}}api/v1/inventoryRecords/{{inventory-id}}","description":"Get a given InventoryRecord by its Id
Get all the InventoryRecords for your platform.
Update a given InventoryRecord by Id/
Delete an InventoryRecord by Id.
If you have platform search enabled, you can manage your InventoryRecords here. Everything is keyed off of your provided Id field, so be sure that is unique and non-changing.
If you're using the CSV upload, here is the list of CSV fields: https://slack-files.com/T03PA1YTJ-F0BP4RPDW-7cd557a880
\n","_postman_id":"37b365b6-c8a6-4421-8afe-36ec6b7f7f54"}],"id":"8fca28d9-a73c-42a8-91b1-30d5060b2010","_postman_id":"8fca28d9-a73c-42a8-91b1-30d5060b2010","description":""},{"name":"v1-20190212","item":[{"name":"Setup","item":[{"name":"Environment Setup","event":[{"listen":"prerequest","script":{"id":"435adba6-e610-4a96-995d-ef71429bf959","exec":["//set your platform api keys here\r","postman.setEnvironmentVariable(\"platform-private-key\", \"Setup your access keys for all further requests in the Pre-request script. Don't have your access keys? Contact apisupport@travefy.com.
\nYou should only need to run this one time as these values will be stored in your Postman environment.
\n","urlObject":{"protocol":"https","path":["get"],"host":["postman-echo","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"df809ee7-5a3d-4e7e-800e-286b5b64cabe"},{"name":"Secure Echo","event":[{"listen":"test","script":{"id":"2e319462-068d-41fc-8fe7-fa6ca254b98e","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;",""],"type":"text/javascript"}}],"id":"1a356d2e-328a-4cce-a644-30f7b6489d3e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-PUBLIC-KEY","value":"{{platform-public-key}}"},{"key":"X-API-PRIVATE-KEY","value":"{{platform-private-key}}"}],"url":"{{base-api-url}}api/v1-{{api-version}}/secureEcho","description":"Test that calls with your platform's private API key succeed.
\n","urlObject":{"path":["v1-{{api-version}}","secureEcho"],"host":["{{base-api-url}}api"],"query":[],"variable":[]}},"response":[],"_postman_id":"1a356d2e-328a-4cce-a644-30f7b6489d3e"},{"name":"Echo","event":[{"listen":"test","script":{"id":"60224c84-3731-4ab6-8c7b-835353609422","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;",""],"type":"text/javascript"}}],"id":"df3a4743-bbd9-4043-8e40-f1eedaf606e1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-PUBLIC-KEY","value":"{{platform-public-key}}"}],"url":"{{base-api-url}}api/v1-{{api-version}}/echo","description":"Test that calls with your platform's public API key succeed.
\n","urlObject":{"path":["v1-{{api-version}}","echo"],"host":["{{base-api-url}}api"],"query":[],"variable":[]}},"response":[],"_postman_id":"df3a4743-bbd9-4043-8e40-f1eedaf606e1"}],"id":"3f7a1f41-e761-4e43-a9b4-95c1930410a9","description":"Add your API keys to the Pre-request Script and execute the Environment Setup request to setup the environment.
//set your platform api keys here\npostman.setEnvironmentVariable(\"platform-private-key\", \"<YOUR-PLATFORM-PRIVATE-API-KEY>\");\npostman.setEnvironmentVariable(\"platform-public-key\", \"<YOUR-PLATFORM-PUBLIC-API-KEY>\");\nCreate a User on the Travefy platform.
The response of this request give you a chance to store the AccessToken and PublicKey for the User. Those keys are also available on the User GET and GET by Id requests. These are automatically stored in the Postman environment for testing.
Note: if the User already has an account on Travefy, they'll need to authorize your Platform on their account. Send them to https://{{your-travefy-platform-url}}/account/authorize and they can approve access. You can then retrieve their tokens via the Get Users call.
Create a User on the Travefy platform that will authenticate using SSO.
When a user is created through the API they receive a welcome email that enables them to login through the Travefy login form. If you users are using SSO then they wont need this and it can be confusing. You can prevent the welcome email from sending by setting DisableWelcomeEmail to true.
Get a User from the Travefy platform by their Id.
{\n \"User\": {\n \"Id\": 123456,\n \"FullName\": \"Agent Level 1 User\",\n \"ImageUrl\": \"https://s3.amazonaws.com/travefy-storage/content/default-4.gif\",\n \"Username\": \"agent1.1505227550@example.com\",\n \"IsAgent\": true,\n \"SubscriptionPeriodEnd\": \"2019-10-10T00:00:00\",\n \"AgentSubscriptionIsActive\": true,\n \"Title\": \"Travel Expert\",\n \"Phone\": \"555-555-1234\",\n \"Url\": \"https://travefy.com/\",\n \"CompanyLogoUrl\": \"https://s3.amazonaws.com/travefy-storage/link-content/companyLogo/13551d3417bd481883931d9d8ff054aa.jpg\"\n },\n \"AccessToken\": \"f33ccb599f19844e4f7047bd1088cef0\",\n \"PublicKey\": \"9318aebc16aa44e1bf552234f710e8ea\",\n \"AgentSubscriptionLevel\": 1,\n \"PartnerIdentifier\": \"user-123\",\n \"IsActive\": true,\n \"CreatedOn\": \"2017-09-12T14:45:46.397\"\n}\n\nUpdate a User. Currently, this will update Username (email), FullName, and ImageUrl.
\n","urlObject":{"path":["v1-{{api-version}}","users","{{user-id}}"],"host":["{{base-api-url}}api"],"query":[],"variable":[]}},"response":[{"id":"00c7051b-9114-4cab-b4c0-a443fe4c5b48","name":"Update User","originalRequest":{"method":"PUT","header":[{"key":"X-API-PRIVATE-KEY","value":"{{platform-private-key}}"},{"key":"X-API-PUBLIC-KEY","value":"{{platform-public-key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"user\" : {\r\n \"username\" : \"updated+agent1-1780225217-updated@example.com\",\r\n \"fullName\" : \"updated test agent2\"\r\n }\r\n}\r\n\r\n"},"url":"{{base-api-url}}api/v1/users/{{user-id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"cache-control","value":"no-cache","description":""},{"key":"connection","value":"keep-alive","description":""},{"key":"content-encoding","value":"gzip","description":""},{"key":"content-length","value":"405","description":""},{"key":"content-type","value":"application/json; charset=utf-8","description":""},{"key":"date","value":"Tue, 12 Sep 2017 14:50:27 GMT","description":""},{"key":"expires","value":"-1","description":""},{"key":"pragma","value":"no-cache","description":""},{"key":"server","value":"nginx/1.10.3","description":""},{"key":"strict-transport-security","value":"max-age=31536000","description":""},{"key":"vary","value":"Accept-Encoding","description":""},{"key":"x-aspnet-version","value":"4.0.30319","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"User\": {\n \"Id\": 127630,\n \"FullName\": \"updated test agent2\",\n \"ImageUrl\": null,\n \"Username\": \"updated+agent1-1505227826-updated@example.com\",\n \"IsAgent\": true,\n \"SubscriptionPeriodEnd\": \"2019-10-10T00:00:00\",\n \"AgentSubscriptionIsActive\": true,\n \"Title\": \"Travel Expert\",\n \"Phone\": \"555-555-1234\",\n \"Url\": \"https://travefy.com/\",\n \"CompanyLogoUrl\": \"https://s3.amazonaws.com/travefy-storage/link-content/companyLogo/13551d3417bd481883931d9d8ff054aa.jpg\"\n },\n \"AccessToken\": \"f33ccb599f19844e4f7047bd1088cef0\",\n \"PublicKey\": \"9318aebc16aa44e1bf552234f710e8ea\",\n \"AgentSubscriptionLevel\": 1,\n \"PartnerIdentifier\": \"user-123\",\n \"IsActive\": true,\n \"CreatedOn\": \"2017-09-12T14:45:46.397\"\n}"}],"_postman_id":"52339c55-d94a-4e3f-b338-bc90de08c5f8"},{"name":"Get Users","event":[{"listen":"test","script":{"id":"597ff385-649a-4478-93c9-9c5abfe8e8e0","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","","var data = JSON.parse(responseBody);","","tests[\"at least one user was returned\"] = data.length;","","var firstUser = data[0];","tests[\"Has created on\"] = firstUser.CreatedOn;","tests[\"Is Active\"] = firstUser.IsActive;",""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"a832d97a-b823-4b19-a58f-4e4db73f9f92","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-PRIVATE-KEY","value":"{{platform-private-key}}"},{"key":"X-API-PUBLIC-KEY","value":"{{platform-public-key}}"}],"url":"{{base-api-url}}api/v1-{{api-version}}/users","description":"Get all Users that your platform has access to.
\n[\n {\n \"User\": {\n \"Id\": 123456,\n \"FullName\": \"a test agent2\",\n \"ImageUrl\": null,\n \"Username\": \"updated+agent1-1505226542-updated@example.com\",\n \"IsAgent\": true,\n \"SubscriptionPeriodEnd\": \"2017-09-22T14:29:35\",\n \"AgentSubscriptionIsActive\": true,\n \"Title\": null,\n \"Phone\": null,\n \"Url\": null,\n \"CompanyLogoUrl\": null\n },\n \"AccessToken\": \"ced4a3f4c1822b221710afe4c2fba447\",\n \"PublicKey\": \"cb3cbdc5507c3643093fea48d21fdc49\",\n \"AgentSubscriptionLevel\": 1,\n \"PartnerIdentifier\": \"user-123\",\n \"IsActive\": false,\n \"CreatedOn\": \"2017-09-12T14:28:57.503\"\n },\n {\n \"User\": {\n \"Id\": 123457,\n \"FullName\": \"updated test agent2\",\n \"ImageUrl\": null,\n \"Username\": \"updated+agent1-1505227826-updated@example.com\",\n \"IsAgent\": true,\n \"SubscriptionPeriodEnd\": \"2019-10-10T00:00:00\",\n \"AgentSubscriptionIsActive\": true,\n \"Title\": \"Travel Expert\",\n \"Phone\": \"555-555-1234\",\n \"Url\": \"https://travefy.com/\",\n \"CompanyLogoUrl\": \"https://s3.amazonaws.com/travefy-storage/link-content/companyLogo/13551d3417bd481883931d9d8ff054aa.jpg\"\n },\n \"AccessToken\": \"f7047bd3cef5999843ccbe410884ff10\",\n \"PublicKey\": \"34f16a93e8ef51a44e7108aebc1b522a\",\n \"AgentSubscriptionLevel\": 1,\n \"PartnerIdentifier\": \"user-456\",\n \"IsActive\": true,\n \"CreatedOn\": \"2017-09-12T14:45:46.397\"\n },\n ...\n]\n\nGet a User from the Travefy platform by their expiring authorizationCode. This will return a collection with a single user if the authorizationCode is valid.
This method should be used to associate a user that was sent to Travefy to authorize your platform. If the authorizationCode is expired the response code returned will be Gone.
See Authorization Redirect Url for information on retrieving and using the authorizationCode.
-
HEADERS
X-API-PRIVATE-KEY {{platform-private-key}}
X-API-PUBLIC-KEY {{platform-public-key}}
[\n {\n \"User\": {\n \"Id\": 123456,\n \"FullName\": \"a test agent2\",\n \"ImageUrl\": null,\n \"Username\": \"updated+agent1-1505226542-updated@example.com\",\n \"IsAgent\": true,\n \"SubscriptionPeriodEnd\": \"2017-09-22T14:29:35\",\n \"AgentSubscriptionIsActive\": true,\n \"Title\": null,\n \"Phone\": null,\n \"Url\": null,\n \"CompanyLogoUrl\": null\n },\n \"AccessToken\": \"ced4a3f4c1822b221710afe4c2fba447\",\n \"PublicKey\": \"cb3cbdc5507c3643093fea48d21fdc49\",\n \"AgentSubscriptionLevel\": 1,\n \"PartnerIdentifier\": \"user-123\",\n \"IsActive\": false,\n \"CreatedOn\": \"2017-09-12T14:28:57.503\"\n }\n]\n\nGet a User from the Travefy platform by their partnerIdentifier. partnerIdentifier is a unique Id that was optionally set in the Create User call. This will return a collection with a single user if the partnerIdentifier is valid.
-
HEADERS
X-API-PRIVATE-KEY {{platform-private-key}}
X-API-PUBLIC-KEY {{platform-public-key}}
[\n {\n \"User\": {\n \"Id\": 123456,\n \"FullName\": \"a test agent2\",\n \"ImageUrl\": null,\n \"Username\": \"updated+agent1-1505226542-updated@example.com\",\n \"IsAgent\": true,\n \"SubscriptionPeriodEnd\": \"2017-09-22T14:29:35\",\n \"AgentSubscriptionIsActive\": true,\n \"Title\": null,\n \"Phone\": null,\n \"Url\": null,\n \"CompanyLogoUrl\": null\n },\n \"AccessToken\": \"ced4a3f4c1822b221710afe4c2fba447\",\n \"PublicKey\": \"cb3cbdc5507c3643093fea48d21fdc49\",\n \"AgentSubscriptionLevel\": 1,\n \"PartnerIdentifier\": \"user-123\",\n \"IsActive\": false,\n \"CreatedOn\": \"2017-09-12T14:28:57.503\"\n }\n]\n\nIn production, your platform may be charged for any created users. Sandbox users are free to create.
\nAgentSubscriptionLevel values:
After successfully creating the User, POST method returns an object with the following properties:
User - The User that was created.AccessToke - Your platform's AccessToken for this User, keep this securely stored like a password.PublicKey - The PublicKey for this User, this is a unique, non-secure identifier and should be stored.AgentSubscriptionLevel - The level of their Travefy Pro subscription.Create an empty Trip on the Travefy platform.
IsSupplemental is not required by this request as it will be automatically created.
Create a Trip on the Travefy platform with a full itinerary (TripDays and TripEvents).
The IsSupplemental is required for this request. Be sure to add one day that \"IsSupplemental\": true. It can be as simple as below:
\"TripDays\":[\n {\n \"IsSupplemental\": true\n },\n {\n \"Name\": \"Add more days\",\n \"IsSupplemental\": false\n }\n]\nGet a Trip from the Travefy platform.
Get a Trip from the Travefy platform by PartnerIdentifier.
Get a Trip from the Travefy platform by SharedId, which is the identifier at the end of ShareUrlPath.
Get every Trip created by your platform for the given User.
Update the Trip itinerary information AND metadata (Name, TripCoverPhotoUrl, etc.). Note: do not pass up any TripDays if you only want to update the metadata.
If you pass up any TripDays, the entire trip itinerary information will be replaced. Chat messages and saved TripIdeas will be maintained, but all TripDays, TripEvents, and TripIdeas on TripEvents will be replaced.
Update the Trip itinerary metadata only (Name, TripCoverPhotoUrl, etc.). Note: do not pass up any TripDays if you only want to update the metadata.
Archives the Trip.
Deletes the Trip.
Unarchives the Trip. This request is the same as the other update and is only here so the trip will be unarchived once the test suite is finished.
This functionality is currently in beta. Please contact us for more info.
\n","urlObject":{"path":["v1-{{api-version}}","trips","copy"],"host":["{{base-api-url}}api"],"query":[],"variable":[]}},"response":[],"_postman_id":"26d6165c-5368-4088-a94f-a7c0130ff4f6"}],"id":"2b569afc-0fc0-4283-bebb-2c1b7edc59f9","description":"Status can be set from one of the statuses the User has created in the web interface and is matched by the string provided. The match is not case-sensitive. If no matching Status is found, it is not set (\"No Status\" in the UI). Quote, Confirmed, and Paid are default statuses for all agents currently, but this is subject to change.
TripIdeas are a collection on a TripEvent and are often establishments or other info that is associated with the TripEvent. For example, the event may be \"Beachside Dinner\" with a time and reservation info and the idea may be \"Shorebird Resturant\" with the location, hours, etc. Currently these are completely stand-alone and will not connect with any existing items from the Travefy database or an agent's Content Library. See the Create Full Trip request for an example usage.
The PartnerIdentifier field on a Trip can be used to store your identifier on the Trip. For example, if you have a different identifier for the Trip in your database, you can store that here. You can then query the Trip by that identifier to get the Travefy Id for the Trip. Note: This field must be unique across your platform.
Create a TripDay on a given Trip.
IsSupplemental is not required for this request. The IsSupplemental parameter will be default set to false.
NOTE: You must supply the X-TRIP-ID header with the TripId from the created Trip.
Get all the TripDays for this Trip.
NOTE: You must supply the X-TRIP-ID header with the TripId from the created Trip.
Get the specified TripDay.
NOTE: You must supply the X-TRIP-ID header with the TripId from the created Trip.
Update the specified TripDay.
NOTE: You must supply the X-TRIP-ID header with the TripId from the created Trip.
Delete the specified TripDay.
NOTE: You must supply the X-TRIP-ID header with the TripId from the created Trip.
A TripDay represents a day on the itinerary. It may have a date (e.g. 2017/01/24) or may not (e.g. Day 2).
NOTE: You must supply the X-TRIP-ID header with the TripId from the created Trip for all of these calls.
Create a TripEvent on a given TripDay.
NOTE: You must supply a valid TripDayId for the TripEvent.
NOTE: You must supply the X-TRIP-ID header with the TripId from the created Trip.
This is great!
\",\n \"StartTimeZoneId\": \"Central Standard Time\",\n \"StartTimeInMinutes\": 764,\n \"DurationInMinutes\": 90,\n \"StartTerminal\": null,\n \"StartGate\": null,\n \"EndTerminal\": null,\n \"EndGate\": null,\n \"PriceInCents\": 12345,\n \"CurrencyCode\": \"USD\",\n \"TransportationIdentifier\": null,\n \"EventType\": 5,\n \"IsEndingEvent\": true,\n \"IsArrival\": false,\n \"TripIdeas\": [],\n \"PartnerIdentifier\": null\n}"}],"_postman_id":"13f9baec-5f51-452e-b4f9-7d9cf9fc6daa"},{"name":"Get Trip Events","event":[{"listen":"test","script":{"id":"a190b281-185e-40b0-ab6e-8b8f87f6f1eb","exec":["var data = JSON.parse(responseBody);","tests['Return some trip events'] = data.length > 0; ",""],"type":"text/javascript"}}],"id":"df96aff0-ec02-4cce-b2ab-be7b2760c34c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-USER-TOKEN","value":"{{user-access-token}}"},{"key":"X-API-PUBLIC-KEY","value":"{{platform-public-key}}"},{"key":"X-TRIP-ID","value":"{{trip-id}}"},{"key":"Content-Type","value":"application/json"}],"url":"{{base-api-url}}api/v1-{{api-version}}/tripEvents/","description":"Get every TripEvent on this Trip.
NOTE: You must supply the X-TRIP-ID header with the created Trip's TripId.
Get a specified TripEvent.
NOTE: You must supply the X-TRIP-ID header with the TripId from the created Trip.
Update a specified TripEvent.
NOTE: You must supply the X-TRIP-ID header with the TripId from the created Trip.
is awesome!
\",\n \"StartTimeZoneId\": null,\n \"StartTimeInMinutes\": 137,\n \"DurationInMinutes\": 120,\n \"StartTerminal\": null,\n \"StartGate\": null,\n \"EndTerminal\": null,\n \"EndGate\": null,\n \"PriceInCents\": null,\n \"CurrencyCode\": null,\n \"TransportationIdentifier\": null,\n \"EventType\": 4,\n \"IsEndingEvent\": false,\n \"IsArrival\": false,\n \"TripIdeas\": null,\n \"PartnerIdentifier\": null\n}"}],"_postman_id":"1bd25f65-1c90-4a58-97ef-50dfda72bcc6"},{"name":"Update Trip Event","event":[{"listen":"test","script":{"id":"432d8e74-34df-411e-80a6-d2707aa8788f","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;\r","\r","var data = JSON.parse(responseBody);\r","\r","tests['Body contains Trip Event'] = data.Id;\r","tests['Body contains Trip Day'] = data.TripDayId;\r","tests['Body contains event type'] = data.EventType;\r","\r","postman.setEnvironmentVariable(\"trip-event-id\", data.Id);\r",""],"type":"text/javascript"}}],"id":"9fa969ec-36b0-4b4f-aba1-3421db733251","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"X-USER-TOKEN","value":"{{user-access-token}}"},{"key":"X-API-PUBLIC-KEY","value":"{{platform-public-key}}"},{"key":"X-TRIP-ID","value":"{{trip-id}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{ \r\n \"TripDayId\": \"{{trip-day-id}}\",\r\n \"Name\": \"Updated Event 1780225217\",\r\n \"Description\": \"is awesome!\",\r\n \"StartTimeInMinutes\": \"265\",\r\n \"EventType\": 6,\r\n \"SegmentProviderName\": \"Hilton-Kansas City\",\r\n \"SegmentProviderPhone\": \"555-867-5309\",\r\n \"SegmentProviderUrl\": \"https://hilton.com\",\r\n \"SegmentIdentifier\": \"YFHP02XVDB\",\r\n \"DurationInMinutes\": 120,\r\n \"ReservationDescription\": \"Executive Suite, One King\",\r\n \"IsActive\": true,\r\n \t\"TripIdeas\": [\r\n \t\t{\r\n \t\t\t\"Id\": {{trip-idea-id}},\r\n\t \"Name\": \"My New Place\",\r\n\t \"ImageUrl\": \"http://lorempixel.com/400/200/cats\",\r\n\t \"Url\": \"https://example.com\",\r\n\t \"Description\": \"A wonderful place to go!\",\r\n\t \"Latitude\": 34.0784796,\r\n\t \"Longitude\": -107.6184694,\r\n\t \"Address\": \"123 W Main St\",\r\n\t \"City\": \"Citytown\",\r\n\t \"State\": \"NM\",\r\n\t \"ZipCode\": \"87825\",\r\n\t \"Phone\": null,\r\n\t \"Country\": \"US\",\r\n\t \"IsActive\": true\r\n }\r\n \t]\r\n}"},"url":"{{base-api-url}}api/v1/tripEvents/{{trip-event-id}}","description":"Update a specified TripEvent and it's TripIdeas.
NOTE: You must supply the X-TRIP-ID header with the TripId from the created Trip.
NOTE: do not pass up any TripDays if you only want to update the metadata.
If you pass up any TripIdeas, the entire list of TripIdeas will be replaced.
is awesome!
\",\n \"StartTimeZoneId\": null,\n \"StartTimeInMinutes\": 137,\n \"DurationInMinutes\": 120,\n \"StartTerminal\": null,\n \"StartGate\": null,\n \"EndTerminal\": null,\n \"EndGate\": null,\n \"PriceInCents\": null,\n \"CurrencyCode\": null,\n \"TransportationIdentifier\": null,\n \"EventType\": 4,\n \"IsEndingEvent\": false,\n \"IsArrival\": false,\n \"TripIdeas\": null,\n \"PartnerIdentifier\": null\n}"}],"_postman_id":"9fa969ec-36b0-4b4f-aba1-3421db733251"},{"name":"Delete Trip Event ","event":[{"listen":"test","script":{"id":"4dec2d19-1587-42c9-a686-459ad505a10f","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","","tests['IsActive is false'] = !data.IsActive;",""],"type":"text/javascript"}}],"id":"392eede5-43c2-4550-9991-c132d87d1d87","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"X-USER-TOKEN","value":"{{user-access-token}}"},{"key":"X-API-PUBLIC-KEY","value":"{{platform-public-key}}"},{"key":"X-TRIP-ID","value":"{{trip-id}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"formdata","formdata":[]},"url":"{{base-api-url}}api/v1-{{api-version}}/tripEvents/{{trip-event-id}}","description":"Delete a specified TripEvent.
NOTE: You must supply the X-TRIP-ID header with the TripId from the created Trip.
is awesome!
\",\n \"StartTimeZoneId\": null,\n \"StartTimeInMinutes\": 137,\n \"DurationInMinutes\": 120,\n \"StartTerminal\": null,\n \"StartGate\": null,\n \"EndTerminal\": null,\n \"EndGate\": null,\n \"PriceInCents\": null,\n \"CurrencyCode\": null,\n \"TransportationIdentifier\": null,\n \"EventType\": 4,\n \"IsEndingEvent\": false,\n \"IsArrival\": false,\n \"TripIdeas\": null,\n \"PartnerIdentifier\": null\n}"}],"_postman_id":"392eede5-43c2-4550-9991-c132d87d1d87"}],"id":"0b54fd78-a812-44d6-a3e5-993ca7ab26f5","description":"A TripEvent is an item on the TripDay.
NOTE: You must supply a valid TripDayId for the TripEvent.
NOTE: You must supply the X-TRIP-ID header with the TripId from the created Trip.
TripEventType can be set to one of the following:
Here's a list of time zones (use the \"Timezone\" field): https://docs.microsoft.com/en-us/windows-hardware/manufacture/desktop/default-time-zones
\nFor the Description field, the following restrictions apply:
Allowed tags:\na, b, br, div, em, i, li, ol, p, span, strong, ul
Allowed attributes:\nhref, style
Allowed CSS properties\nbackground-color
Allowed URI Schemes:\nhttps, http, mailto, tel
The ReservationDescription field will display as \"Seat / Tickey Details\" for Flight (0) events and display \"Room Type / Bedding\" for Hotel (6) events and will not display for all others.
Create (invite) 1 or more TripUsers to a Trip. FullName and UserName (email) are required.
Currently, this will not send an invite email to them, so you will need to notify them to check their trips list if needed.
\nNOTE: You cannot invite anyone in the Organizer Role.
NOTE: You must supply the X-TRIP-ID header with the TripId from the created Trip and it must match the trip-id in the URI.
Retreive a given TripUser.
NOTE: You must supply the X-TRIP-ID header with the TripId from the created Trip and it must match the trip-id in the URI.
Retreive all TripUsers on a Trip.
NOTE: You must supply the X-TRIP-ID header with the TripId from the created Trip and it must match the trip-id in the URI.
Update the Role of a given TripUser on a Trip.
NOTE: You cannot update anyone to the Organizer Role. You cannot change the Role of an existing Organizer.
NOTE: You must supply the X-TRIP-ID header with the TripId from the created Trip and it must match the trip-id in the URI.
Update the Roles of multiple TripUsers on a Trip.
NOTE: You cannot update anyone to the Organizer Role. You cannot change the Role of an existing Organizer.
NOTE: You must supply the X-TRIP-ID header with the TripId from the created Trip and it must match the trip-id in the URI.
Delete (uninvite) a given TripUser on a Trip.
NOTE: You cannot remove anyone in the Organizer Role.
NOTE: You must supply the X-TRIP-ID header with the TripId from the created Trip and it must match the trip-id in the URI.
A TripUser represents a User on a Trip. TripUsers can be invited to a trip and have different roles depending on your subscription level. Here are the available Roles:
Available operations:
\nTripUsersTripUserTripUsers for a TripTripUserTripUsersTripUser which moves them to the Uninvited RoleNOTE: You must supply the X-TRIP-ID header with the TripId from the created Trip and it must match the trip-id in the URI. The TripUser endpoints use a slightly different URL structure than other Trip resources. We will likely move to this type of structure in the future for all Trip resources. We will version the API or allow the old style rather than making breaking changes to existing calls.
Remove a User from the Travefy platform.
Note: You will not be able to re-enable or re-create a User after calling this. The User will have to re-authorize your platform manually.
true to return only Events created by the user, false to return all Events for the User's team. Defaults to true.
EventType can be set to one of the following:
Note: Attached content cannot be viewed or managed via the API at this time.
\n","_postman_id":"cd53e0ef-e7a3-4efd-a9cd-f92999889430"},{"name":"Content","item":[{"name":"Create Content","event":[{"listen":"test","script":{"id":"d1ccf7b7-7f6a-4230-9752-ab4c455072fd","exec":["var data = JSON.parse(responseBody);","","tests['Content was created'] = data.Id > 0;","tests['Content is active'] = data.IsActive;","tests['Content Name'] = data.Name;","tests['Content image url'] = data.ImageUrl;","tests['Content url'] = data.Url;","tests['Content latutude'] = data.Latitude;","tests['Content longutude'] = data.Longitude;","tests['Content city'] = data.City;","tests['Content state'] = data.State;","tests['Content zip'] = data.ZipCode;","tests['Content country'] = data.Country;","tests['Content description'] = data.Description;","tests['Content description'] = data.Category;","tests['Content description'] = data.Rating;","tests['Content description'] = data.Phone;","","tests['Content partner identifier'] = data.PartnerIdentifier.startsWith(\"test-content-\");","","postman.setEnvironmentVariable(\"saved-content-id\", data.Id);","postman.setEnvironmentVariable(\"saved-content-partner-identifier\", data.PartnerIdentifier);"],"type":"text/javascript"}}],"id":"631002e4-91d0-4861-8e75-56712ebdcbd3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-USER-TOKEN","value":"{{user-access-token}}"},{"key":"X-API-PUBLIC-KEY","value":"{{platform-public-key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Name\": \"My Place\",\n \"ImageUrl\": \"http://lorempixel.com/g/400/200/cats/content/\",\n \"Url\": \"https://example.com\",\n \"Latitude\": 46.127931,\n \"Longitude\": -76.122413,\n \"Address\": \"123 Main Street\",\n \"City\": \"Lincoln\",\n \"State\": \"NE\",\n \"ZipCode\": \"68508\",\n \"Country\": \"US\",\n \"Description\": \"This is a GREAT place to visit!\",\n \"Category\": 338,\n \"Rating\": 4.2,\n \"IsActive\": true,\n \"Phone\": \"(402) 867-5309\",\n \"PartnerIdentifier\": \"test-content-id-1780225217\"\n}"},"url":"{{base-api-url}}api/v1-{{api-version}}/library/content","urlObject":{"path":["v1-{{api-version}}","library","content"],"host":["{{base-api-url}}api"],"query":[],"variable":[]}},"response":[{"id":"2ba01f1c-7889-4277-9b2e-02bdd44a8aff","name":"Create Content","originalRequest":{"method":"POST","header":[{"key":"X-USER-TOKEN","value":"{{user-access-token}}"},{"key":"X-API-PUBLIC-KEY","value":"{{platform-public-key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Name\": \"My Place\",\n \"ImageUrl\": \"http://lorempixel.com/g/400/200/cats/content/\",\n \"Url\": \"https://example.com\",\n \"Latitude\": 46.127931,\n \"Longitude\": -76.122413,\n \"Address\": \"123 Main Street\",\n \"City\": \"Lincoln\",\n \"State\": \"NE\",\n \"ZipCode\": \"68508\",\n \"Country\": \"US\",\n \"Description\": \"This is a GREAT place to visit!\",\n \"Category\": 338,\n \"Rating\": 4.2,\n \"IsActive\": true,\n \"Phone\": \"(402) 867-5309\",\n \"PartnerIdentifier\": \"test-content-id-1780225217\"\n}"},"url":"{{base-api-url}}api/v1/library/content"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"439","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Wed, 15 Nov 2017 21:44:41 GMT","name":"Date","description":""},{"key":"Expires","value":"-1","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"Microsoft-IIS/10.0","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""},{"key":"X-SourceFiles","value":"=?UTF-8?B?Tjpcd29ya3NwYWNlc1x0cmF2ZWZ5XHRyYXZlZnlcVHJhdmVmeS5BcGlcYXBpXHYxXGxpYnJhcnlcY29udGVudA==?=","name":"X-SourceFiles","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"Id\": 261577,\n \"Name\": \"My Place\",\n \"ImageUrl\": \"http://lorempixel.com/g/400/200/cats/content/\",\n \"Url\": \"https://example.com\",\n \"Latitude\": 46.127931,\n \"Longitude\": -76.122413,\n \"Address\": \"123 Main Street\",\n \"City\": \"Lincoln\",\n \"State\": \"NE\",\n \"ZipCode\": \"68508\",\n \"Country\": \"US\",\n \"Description\": \"This is a GREAT place to visit!\",\n \"Category\": 338,\n \"Rating\": 4.2,\n \"IsActive\": true,\n \"Phone\": \"(402) 867-5309\",\n \"PartnerIdentifier\": \"test-content-id-1510782282\"\n}"}],"_postman_id":"631002e4-91d0-4861-8e75-56712ebdcbd3"},{"name":"Get All Content","event":[{"listen":"test","script":{"id":"40423847-f1e3-4306-9eae-1a2373e6e2b1","exec":["var data = JSON.parse(responseBody);","","tests['content was returned'] = data.length > 0;","","var firstContent = data[0]; ","","tests['Content was created'] = firstContent.Id > 0;","tests['Content is active'] = firstContent.IsActive;","tests['Content Name'] = firstContent.Name;","tests['Content image url'] = firstContent.ImageUrl;","tests['Content url'] = firstContent.Url;","tests['Content latutude'] = firstContent.Latitude;","tests['Content longutude'] = firstContent.Longitude;","tests['Content city'] = firstContent.City;","tests['Content state'] = firstContent.State;","tests['Content zip'] = firstContent.ZipCode;","tests['Content country'] = firstContent.Country;","tests['Content description'] = firstContent.Description;","tests['Content description'] = firstContent.Category;","tests['Content description'] = firstContent.Rating;","tests['Content description'] = firstContent.Phone;",""],"type":"text/javascript"}}],"id":"6e07aaef-eb59-4bf1-9dca-95ed06011915","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-USER-TOKEN","value":"{{user-access-token}}"},{"key":"X-API-PUBLIC-KEY","value":"{{platform-public-key}}"}],"url":"{{base-api-url}}api/v1-{{api-version}}/library/content?createdByUser=true","urlObject":{"path":["v1-{{api-version}}","library","content"],"host":["{{base-api-url}}api"],"query":[{"description":{"content":"true to return only Content created by the user, false to return all Content for the User's team. Defaults to true.
You can now manage the Library of your Users.
\nNote, the following features are not yet available in the API:
\nPartnerIdentifierCreate an inventory record.
\n","urlObject":{"path":["v1-{{api-version}}","inventoryRecords",""],"host":["{{base-api-url}}api"],"query":[],"variable":[]}},"response":[{"id":"c5eedd13-93aa-4397-8493-dbf5e329e9a2","name":"Create Inventory Record","originalRequest":{"method":"POST","header":[{"key":"X-API-PUBLIC-KEY","value":"{{platform-public-key}}"},{"key":"X-API-PRIVATE-KEY","value":"{{platform-private-key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"Id\": \"test-123 1780225217\",\r\n \"Name\": \"Personalized Tours of Travefy Office\",\r\n \"Url\": \"https://travefy.com/\",\r\n \"Description\": \"See where the Travefy magic happens! \\r\\n Enjoy your lovely view of the vibrant Lincoln Haymarket.\",\r\n \"ImageUrl\": \"http://nebraskaglobal.com/images/img-contact2.jpg\",\r\n \"IsActive\": true,\r\n \"Latitude\": 40.814385,\r\n \"Longitude\": -96.710113,\r\n \"Price\": null,\r\n \"CurrencyCode\": null,\r\n \"Address\": \"151 N 8th St, #300\",\r\n \"City\": \"Lincoln\",\r\n \"State\": \"NE\",\r\n \"Country\": \"US\",\r\n \"ZipCode\": \"68506\",\r\n \"HideOnMap\": false,\r\n \"SearchAttributes\": [\r\n {\r\n \"Key\": \"Type\",\r\n \"Value\": \"Office\"\r\n },\r\n {\r\n \"Key\": \"Maximum Occupancy\",\r\n \"Value\": \"15\"\r\n }\r\n ],\r\n \"ImageUrls\": [\r\n \"https://about.travefy.com/wp-content/uploads/2015/09/team-bkgrd-2015.jpg\",\r\n \"https://about.travefy.com/wp-content/uploads/2014/08/Andrew-Badami-Travefy.jpg\",\r\n \"https://about.travefy.com/wp-content/uploads/2015/06/stephanie-leonard-travefy.jpg\"\r\n ],\r\n \"TopLevelCategories\": [\r\n \"Office Tours\"\r\n ],\r\n \"DescriptionAttributes\": [\r\n {\r\n \"Key\": \"Cost\",\r\n \"Value\": \"FREE!\"\r\n },\r\n {\r\n \"Key\": \"Hours\",\r\n \"Value\": \"30pm\"\r\n },\r\n {\r\n \"Key\": \"WiFi\",\r\n \"Value\": \"Available\"\r\n },\r\n {\r\n \"Key\": \"Parking\",\r\n \"Value\": \"On Street\"\r\n }\r\n ]\r\n}"},"url":"{{base-api-url}}api/v1/inventoryRecords/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"name":"cache-control","key":"cache-control","value":"no-cache","description":""},{"name":"connection","key":"connection","value":"keep-alive","description":""},{"name":"content-length","key":"content-length","value":"1047","description":""},{"name":"content-type","key":"content-type","value":"application/json; charset=utf-8","description":""},{"name":"date","key":"date","value":"Wed, 25 Oct 2017 18:21:49 GMT","description":""},{"name":"expires","key":"expires","value":"-1","description":""},{"name":"pragma","key":"pragma","value":"no-cache","description":""},{"name":"server","key":"server","value":"nginx/1.12.1","description":""},{"name":"strict-transport-security","key":"strict-transport-security","value":"max-age=31536000","description":""},{"name":"x-aspnet-version","key":"x-aspnet-version","value":"4.0.30319","description":""}],"cookie":[],"responseTime":null,"body":"{\"Id\":\"test-123 1508955704\",\"Name\":\"Personalized Tours of Travefy Office\",\"Url\":\"https://travefy.com/\",\"Description\":\"See where the Travefy magic happens! \\r\\n Enjoy your lovely view of the vibrant Lincoln Haymarket.\",\"ImageUrl\":\"http://nebraskaglobal.com/images/img-contact2.jpg\",\"IsActive\":true,\"Latitude\":40.814385,\"Longitude\":-96.710113,\"Price\":null,\"CurrencyCode\":null,\"Address\":\"151 N 8th St, #300\",\"City\":\"Lincoln\",\"State\":\"NE\",\"Country\":\"US\",\"ZipCode\":\"68506\",\"Phone\":null,\"HideOnMap\":false,\"SearchAttributes\":[{\"Key\":\"Type\",\"Value\":\"Office\"},{\"Key\":\"Maximum Occupancy\",\"Value\":\"15\"}],\"ImageUrls\":[\"https://about.travefy.com/wp-content/uploads/2015/09/team-bkgrd-2015.jpg\",\"https://about.travefy.com/wp-content/uploads/2014/08/Andrew-Badami-Travefy.jpg\",\"https://about.travefy.com/wp-content/uploads/2015/06/stephanie-leonard-travefy.jpg\"],\"TopLevelCategories\":[\"Office Tours\"],\"DescriptionAttributes\":[{\"Key\":\"Cost\",\"Value\":\"FREE!\"},{\"Key\":\"Hours\",\"Value\":\"30pm\"},{\"Key\":\"WiFi\",\"Value\":\"Available\"},{\"Key\":\"Parking\",\"Value\":\"On Street\"}]}"}],"_postman_id":"8b77fa6b-3aeb-4dc7-a715-ffc2e73c6fb2"},{"name":"Get Inventory Record","event":[{"listen":"test","script":{"id":"bbc702e0-5d47-4622-be62-df3e717ed788","exec":["var data = JSON.parse(responseBody);","","tests['Has record'] = data.Id;","tests['Matching id'] = data.Id === postman.getEnvironmentVariable(\"inventory-id\");",""],"type":"text/javascript"}}],"id":"a4bf838f-3d08-4198-aac3-7b31ea82a0a3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-PUBLIC-KEY","value":"{{platform-public-key}}"},{"key":"X-API-PRIVATE-KEY","value":"{{platform-private-key}}"},{"key":"Content-Type","value":"application/json"}],"url":"{{base-api-url}}api/v1-{{api-version}}/inventoryRecords/{{inventory-id}}","description":"Get a given InventoryRecord by its Id
Get all the InventoryRecords for your platform.
Update a given InventoryRecord by Id/
Delete an InventoryRecord by Id.
If you have platform search enabled, you can manage your InventoryRecords here. Everything is keyed off of your provided Id field, so be sure that is unique and non-changing.
If you're using the CSV upload, here is the list of CSV fields: https://slack-files.com/T03PA1YTJ-F0BP4RPDW-7cd557a880
\n","_postman_id":"5ce7ef34-5a82-4f34-a18b-56adbc235916"}],"id":"390161c2-e4ba-44ee-8776-d19985ea4eaa","event":[{"listen":"prerequest","script":{"id":"e4b67de7-69b2-4cc0-8110-cf6dae5f309a","type":"text/javascript","exec":["//preset version number","postman.setEnvironmentVariable(\"api-version\", 20190212);"]}},{"listen":"test","script":{"id":"ea9e7936-fc96-45eb-842b-9d2a5cac073b","type":"text/javascript","exec":[""]}}],"_postman_id":"390161c2-e4ba-44ee-8776-d19985ea4eaa","description":""},{"name":"v1-20241001 (Latest)","item":[{"name":"Setup","item":[{"name":"Environment Setup","event":[{"listen":"prerequest","script":{"id":"435adba6-e610-4a96-995d-ef71429bf959","exec":["//set your platform api keys here\r","postman.setEnvironmentVariable(\"platform-private-key\", \"Setup your access keys for all further requests in the Pre-request script. Don't have your access keys? Contact apisupport@travefy.com.
\nYou should only need to run this one time as these values will be stored in your Postman environment.
\n","urlObject":{"protocol":"https","path":["get"],"host":["postman-echo","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"1a810c6a-68db-4839-97b7-cee52f6750d7"},{"name":"Secure Echo","event":[{"listen":"test","script":{"id":"2e319462-068d-41fc-8fe7-fa6ca254b98e","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;",""],"type":"text/javascript","packages":{}}}],"id":"83e34dc8-0c44-4e5e-a3e9-a65bd40eafcb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-PUBLIC-KEY","value":"{{platform-public-key}}"},{"key":"X-API-PRIVATE-KEY","value":"{{platform-private-key}}"}],"url":"{{base-api-url}}api/v1-12345/secureEcho","description":"Test that calls with your platform's private API key succeed.
\n","urlObject":{"path":["v1-12345","secureEcho"],"host":["{{base-api-url}}api"],"query":[],"variable":[]}},"response":[],"_postman_id":"83e34dc8-0c44-4e5e-a3e9-a65bd40eafcb"},{"name":"Echo","event":[{"listen":"test","script":{"id":"60224c84-3731-4ab6-8c7b-835353609422","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;",""],"type":"text/javascript"}}],"id":"824c8658-7994-44c2-8fcd-d8c2efe71ae1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-PUBLIC-KEY","value":"{{platform-public-key}}"}],"url":"{{base-api-url}}api/v1-{{api-version}}/echo","description":"Test that calls with your platform's public API key succeed.
\n","urlObject":{"path":["v1-{{api-version}}","echo"],"host":["{{base-api-url}}api"],"query":[],"variable":[]}},"response":[],"_postman_id":"824c8658-7994-44c2-8fcd-d8c2efe71ae1"}],"id":"4d5136ca-ba3f-434c-bf52-28947cb08d66","description":"Add your API keys to the Pre-request Script and execute the Environment Setup request to setup the environment.
//set your platform api keys here\npostman.setEnvironmentVariable(\"platform-private-key\", \"<YOUR-PLATFORM-PRIVATE-API-KEY>\");\npostman.setEnvironmentVariable(\"platform-public-key\", \"<YOUR-PLATFORM-PUBLIC-API-KEY>\");\nCreate a User on the Travefy platform.
The response of this request give you a chance to store the AccessToken and PublicKey for the User. Those keys are also available on the User GET and GET by Id requests. These are automatically stored in the Postman environment for testing.
Note: if the User already has an account on Travefy, they'll need to authorize your Platform on their account. Send them to https://{{your-travefy-platform-url}}/account/authorize and they can approve access. You can then retrieve their tokens via the Get Users call.
Create a User on the Travefy platform that will authenticate using SSO.
When a user is created through the API they receive a welcome email that enables them to login through the Travefy login form. If you users are using SSO then they wont need this and it can be confusing. You can prevent the welcome email from sending by setting DisableWelcomeEmail to true.
Get a User from the Travefy platform by their Id.
{\n \"User\": {\n \"Id\": 123456,\n \"FullName\": \"Agent Level 1 User\",\n \"ImageUrl\": \"https://s3.amazonaws.com/travefy-storage/content/default-4.gif\",\n \"Username\": \"agent1.1505227550@example.com\",\n \"IsAgent\": true,\n \"SubscriptionPeriodEnd\": \"2019-10-10T00:00:00\",\n \"AgentSubscriptionIsActive\": true,\n \"Title\": \"Travel Expert\",\n \"Phone\": \"555-555-1234\",\n \"Url\": \"https://travefy.com/\",\n \"CompanyLogoUrl\": \"https://s3.amazonaws.com/travefy-storage/link-content/companyLogo/13551d3417bd481883931d9d8ff054aa.jpg\"\n },\n \"AccessToken\": \"f33ccb599f19844e4f7047bd1088cef0\",\n \"PublicKey\": \"9318aebc16aa44e1bf552234f710e8ea\",\n \"AgentSubscriptionLevel\": 1,\n \"PartnerIdentifier\": \"user-123\",\n \"IsActive\": true,\n \"CreatedOn\": \"2017-09-12T14:45:46.397\"\n}\n\nUpdate a User. Currently, this will update Username (email), FullName, and ImageUrl.
\n","urlObject":{"path":["v1-{{api-version}}","users","{{user-id}}"],"host":["{{base-api-url}}api"],"query":[],"variable":[]}},"response":[{"id":"474e87b9-1a6e-4dcd-a4fc-034b252aa84a","name":"Update User","originalRequest":{"method":"PUT","header":[{"key":"X-API-PRIVATE-KEY","value":"{{platform-private-key}}"},{"key":"X-API-PUBLIC-KEY","value":"{{platform-public-key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"user\" : {\r\n \"username\" : \"updated+agent1-1780225217-updated@example.com\",\r\n \"fullName\" : \"updated test agent2\"\r\n }\r\n}\r\n\r\n"},"url":"{{base-api-url}}api/v1/users/{{user-id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"cache-control","value":"no-cache","description":""},{"key":"connection","value":"keep-alive","description":""},{"key":"content-encoding","value":"gzip","description":""},{"key":"content-length","value":"405","description":""},{"key":"content-type","value":"application/json; charset=utf-8","description":""},{"key":"date","value":"Tue, 12 Sep 2017 14:50:27 GMT","description":""},{"key":"expires","value":"-1","description":""},{"key":"pragma","value":"no-cache","description":""},{"key":"server","value":"nginx/1.10.3","description":""},{"key":"strict-transport-security","value":"max-age=31536000","description":""},{"key":"vary","value":"Accept-Encoding","description":""},{"key":"x-aspnet-version","value":"4.0.30319","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"User\": {\n \"Id\": 127630,\n \"FullName\": \"updated test agent2\",\n \"ImageUrl\": null,\n \"Username\": \"updated+agent1-1505227826-updated@example.com\",\n \"IsAgent\": true,\n \"SubscriptionPeriodEnd\": \"2019-10-10T00:00:00\",\n \"AgentSubscriptionIsActive\": true,\n \"Title\": \"Travel Expert\",\n \"Phone\": \"555-555-1234\",\n \"Url\": \"https://travefy.com/\",\n \"CompanyLogoUrl\": \"https://s3.amazonaws.com/travefy-storage/link-content/companyLogo/13551d3417bd481883931d9d8ff054aa.jpg\"\n },\n \"AccessToken\": \"f33ccb599f19844e4f7047bd1088cef0\",\n \"PublicKey\": \"9318aebc16aa44e1bf552234f710e8ea\",\n \"AgentSubscriptionLevel\": 1,\n \"PartnerIdentifier\": \"user-123\",\n \"IsActive\": true,\n \"CreatedOn\": \"2017-09-12T14:45:46.397\"\n}"}],"_postman_id":"d557144f-c205-453d-9de1-0a72171328d0"},{"name":"Get Users","event":[{"listen":"test","script":{"id":"597ff385-649a-4478-93c9-9c5abfe8e8e0","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","","var data = JSON.parse(responseBody);","","tests[\"at least one user was returned\"] = data.length;","","var firstUser = data[0];","tests[\"Has created on\"] = firstUser.CreatedOn;","tests[\"Is Active\"] = firstUser.IsActive;",""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"6937ec53-50a2-49eb-ae0e-5b4e5249e4a3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-PRIVATE-KEY","value":"{{platform-private-key}}"},{"key":"X-API-PUBLIC-KEY","value":"{{platform-public-key}}"}],"url":"{{base-api-url}}api/v1-{{api-version}}/users","description":"Get all Users that your platform has access to.
\n[\n {\n \"User\": {\n \"Id\": 123456,\n \"FullName\": \"a test agent2\",\n \"ImageUrl\": null,\n \"Username\": \"updated+agent1-1505226542-updated@example.com\",\n \"IsAgent\": true,\n \"SubscriptionPeriodEnd\": \"2017-09-22T14:29:35\",\n \"AgentSubscriptionIsActive\": true,\n \"Title\": null,\n \"Phone\": null,\n \"Url\": null,\n \"CompanyLogoUrl\": null\n },\n \"AccessToken\": \"ced4a3f4c1822b221710afe4c2fba447\",\n \"PublicKey\": \"cb3cbdc5507c3643093fea48d21fdc49\",\n \"AgentSubscriptionLevel\": 1,\n \"PartnerIdentifier\": \"user-123\",\n \"IsActive\": false,\n \"CreatedOn\": \"2017-09-12T14:28:57.503\"\n },\n {\n \"User\": {\n \"Id\": 123457,\n \"FullName\": \"updated test agent2\",\n \"ImageUrl\": null,\n \"Username\": \"updated+agent1-1505227826-updated@example.com\",\n \"IsAgent\": true,\n \"SubscriptionPeriodEnd\": \"2019-10-10T00:00:00\",\n \"AgentSubscriptionIsActive\": true,\n \"Title\": \"Travel Expert\",\n \"Phone\": \"555-555-1234\",\n \"Url\": \"https://travefy.com/\",\n \"CompanyLogoUrl\": \"https://s3.amazonaws.com/travefy-storage/link-content/companyLogo/13551d3417bd481883931d9d8ff054aa.jpg\"\n },\n \"AccessToken\": \"f7047bd3cef5999843ccbe410884ff10\",\n \"PublicKey\": \"34f16a93e8ef51a44e7108aebc1b522a\",\n \"AgentSubscriptionLevel\": 1,\n \"PartnerIdentifier\": \"user-456\",\n \"IsActive\": true,\n \"CreatedOn\": \"2017-09-12T14:45:46.397\"\n },\n ...\n]\n\nGet a User from the Travefy platform by their expiring authorizationCode. This will return a collection with a single user if the authorizationCode is valid.
This method should be used to associate a user that was sent to Travefy to authorize your platform. If the authorizationCode is expired the response code returned will be Gone.
See Authorization Redirect Url for information on retrieving and using the authorizationCode.
-
HEADERS
X-API-PRIVATE-KEY {{platform-private-key}}
X-API-PUBLIC-KEY {{platform-public-key}}
[\n {\n \"User\": {\n \"Id\": 123456,\n \"FullName\": \"a test agent2\",\n \"ImageUrl\": null,\n \"Username\": \"updated+agent1-1505226542-updated@example.com\",\n \"IsAgent\": true,\n \"SubscriptionPeriodEnd\": \"2017-09-22T14:29:35\",\n \"AgentSubscriptionIsActive\": true,\n \"Title\": null,\n \"Phone\": null,\n \"Url\": null,\n \"CompanyLogoUrl\": null\n },\n \"AccessToken\": \"ced4a3f4c1822b221710afe4c2fba447\",\n \"PublicKey\": \"cb3cbdc5507c3643093fea48d21fdc49\",\n \"AgentSubscriptionLevel\": 1,\n \"PartnerIdentifier\": \"user-123\",\n \"IsActive\": false,\n \"CreatedOn\": \"2017-09-12T14:28:57.503\"\n }\n]\n\nGet a User from the Travefy platform by their partnerIdentifier. partnerIdentifier is a unique Id that was optionally set in the Create User call. This will return a collection with a single user if the partnerIdentifier is valid.
-
HEADERS
X-API-PRIVATE-KEY {{platform-private-key}}
X-API-PUBLIC-KEY {{platform-public-key}}
[\n {\n \"User\": {\n \"Id\": 123456,\n \"FullName\": \"a test agent2\",\n \"ImageUrl\": null,\n \"Username\": \"updated+agent1-1505226542-updated@example.com\",\n \"IsAgent\": true,\n \"SubscriptionPeriodEnd\": \"2017-09-22T14:29:35\",\n \"AgentSubscriptionIsActive\": true,\n \"Title\": null,\n \"Phone\": null,\n \"Url\": null,\n \"CompanyLogoUrl\": null\n },\n \"AccessToken\": \"ced4a3f4c1822b221710afe4c2fba447\",\n \"PublicKey\": \"cb3cbdc5507c3643093fea48d21fdc49\",\n \"AgentSubscriptionLevel\": 1,\n \"PartnerIdentifier\": \"user-123\",\n \"IsActive\": false,\n \"CreatedOn\": \"2017-09-12T14:28:57.503\"\n }\n]\n\nIn production, your platform may be charged for any created users. Sandbox users are free to create.
\nAgentSubscriptionLevel values:
After successfully creating the User, POST method returns an object with the following properties:
User - The User that was created.AccessToke - Your platform's AccessToken for this User, keep this securely stored like a password.PublicKey - The PublicKey for this User, this is a unique, non-secure identifier and should be stored.AgentSubscriptionLevel - The level of their Travefy Pro subscription.Create an empty Trip on the Travefy platform.
IsSupplemental is not required by this request as it will be automatically created.
Create an empty Trip as a proposal on the Travefy platform.
IsSupplemental is not required by this request as it will be automatically created.
Create a Proposalon the Travefy platform with a full proposal (TripDays and TripEvents).
The IsSupplemental is required for this request. Be sure to add one day that \"IsSupplemental\": true. It can be as simple as below:
\"TripDays\":[\n {\n \"IsSupplemental\": true\n },\n {\n \"Name\": \"Add more days\",\n \"IsSupplemental\": false\n }\n]\n\nCreate a Trip on the Travefy platform with a full itinerary (TripDays and TripEvents).
The IsSupplemental is required for this request. Be sure to add one day that \"IsSupplemental\": true. It can be as simple as below:
\"TripDays\":[\n {\n \"IsSupplemental\": true\n },\n {\n \"Name\": \"Add more days\",\n \"IsSupplemental\": false\n }\n]\nGet a Trip from the Travefy platform.
Get a Trip from the Travefy platform.
Get a Trip from the Travefy platform by PartnerIdentifier.
Get a Trip from the Travefy platform by SharedId, which is the identifier at the end of ShareUrlPath.
Get every Trip created by your platform for the given User.
Update any Trip itinerary information AND metadata (Name, TripCoverPhotoUrl, etc.). Move events to different days. Re-order days and events.
A trip has TripDays as children. A TripDay has TripEvents as children. A TripEvent has TripIdeas as children. If you do not want the children of something to be updated then you should omit the collection property on the parent. For example if you only want to update the metadata, such as the name of the trip, then you should omit the TripDays property or set it to null in the request. If you provide an empty array it will delete all of the trip days.
If you would like to update an existing TripDays, TripEvents or TripIdeas you must set the Id field on anything that you would like to be updated. If the Id field is omitted or does not belong on the trip, then a new item will be created.
If you would like to remove an item you can omit it from any of the collections. Additionally, the IsActive field can be used in any case to remove it. You should always set the IsActive field to true if you want something to be included in the trip.
If you would like to add something then you can omit the Id field.
Updating a full trip:
\nIf you pass up any TripDays, all TripDayswill be updated to match what you have provided in the request.
Chat messages and saved TripIdeas will be maintained, but all TripDays, TripEvents, and TripIdeas on TripEvents will be replaced unless the collection is omitted or set to null.
If you would only like to update the days, then all TripEvents fields should be null or omitted from the days in which you do not want to update the events. This same rule applies to TripIdeas that are attached to events.
Update the Trip itinerary metadata only (Name, TripCoverPhotoUrl, etc.). Note: do not pass up any TripDays if you only want to update the metadata.
Archives the Trip.
Deletes the Trip.
Unarchives the Trip. This request is the same as the other update and is only here so the trip will be unarchived once the test suite is finished.
This functionality is currently in beta. Please contact us for more info.
\n","urlObject":{"path":["v1-{{api-version}}","trips","copy"],"host":["{{base-api-url}}api"],"query":[],"variable":[]}},"response":[],"_postman_id":"268c2bf7-3c09-4cde-abe2-6cbfdb24caff"}],"id":"0b67dc64-89d4-4422-89c8-85afd8301f3d","description":"Status can be set from one of the statuses the User has created in the web interface and is matched by the string provided. The match is not case-sensitive. If no matching Status is found, it is not set (\"No Status\" in the UI). Quote, Confirmed, and Paid are default statuses for all agents currently, but this is subject to change.
TripIdeas are a collection on a TripEvent and are often establishments or other info that is associated with the TripEvent. For example, the event may be \"Beachside Dinner\" with a time and reservation info and the idea may be \"Shorebird Resturant\" with the location, hours, etc. Currently these are completely stand-alone and will not connect with any existing items from the Travefy database or an agent's Content Library. See the Create Full Trip request for an example usage.
The PartnerIdentifier field on a Trip can be used to store your identifier on the Trip. For example, if you have a different identifier for the Trip in your database, you can store that here. You can then query the Trip by that identifier to get the Travefy Id for the Trip. Note: This field must be unique across your platform.
Create a TripDay on a given Trip.
IsSupplemental is not required for this request. The IsSupplemental parameter will be default set to false.
NOTE: You must supply the X-TRIP-ID header with the TripId from the created Trip.
Get all the TripDays for this Trip.
NOTE: You must supply the X-TRIP-ID header with the TripId from the created Trip.
Get the specified TripDay.
NOTE: You must supply the X-TRIP-ID header with the TripId from the created Trip.
Update the specified TripDay.
NOTE: You must supply the X-TRIP-ID header with the TripId from the created Trip.
Delete the specified TripDay.
NOTE: You must supply the X-TRIP-ID header with the TripId from the created Trip.
A TripDay represents a day on the itinerary. It may have a date (e.g. 2017/01/24) or may not (e.g. Day 2).
NOTE: You must supply the X-TRIP-ID header with the TripId from the created Trip for all of these calls.
Create a TripEvent on a given TripDay.
NOTE: You must supply a valid TripDayId for the TripEvent.
NOTE: You must supply the X-TRIP-ID header with the TripId from the created Trip.
Adding optional ThirdPartyPropertyIds will do a best-effort lookup of the property in the Travefy Global Properties database. If we find a matching property, we will add our photos to the TripEvent.
Currently supported ThirdPartyPropertyIds are Giata, Leonardo, IcePortal, and Sabre.
This is great!
\",\n \"StartTimeZoneId\": \"America/Chicago\",\n \"StartTimeInMinutes\": 764,\n \"DurationInMinutes\": 90,\n \"StartTerminal\": null,\n \"StartGate\": null,\n \"EndTerminal\": null,\n \"EndGate\": null,\n \"PriceInCents\": 12345,\n \"CurrencyCode\": \"USD\",\n \"TransportationIdentifier\": null,\n \"EventType\": 5,\n \"IsEndingEvent\": true,\n \"IsArrival\": false,\n \"TripIdeas\": [],\n \"PartnerIdentifier\": null\n}"},{"id":"30b80fe5-4de5-4449-b545-ae04cd0bb159","name":"Create Trip Event","originalRequest":{"method":"POST","header":[{"key":"X-USER-TOKEN","value":"{{user-access-token}}","disabled":true},{"key":"X-API-PUBLIC-KEY","value":"{{platform-public-key}}","disabled":true},{"key":"X-TRIP-ID","value":"{{trip-id}}"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer eyJraWQiOiJlcTNUVWpaWStmN0FSMEJWVzFkSFZQVU1UeklHd1VcL2d6VGhSY1FqNFpEdz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJiNDYwNmIyYy03OGIzLTQ5NmItYjk3YS1jOThiYjRjOTI5MmYiLCJkZXZpY2Vfa2V5IjoidXMtZWFzdC0xX2MyZTFiYWI5LTQzYTctNDI2NS04ZTQwLTMyMTRkZTQ0MGJjYSIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiYXdzLmNvZ25pdG8uc2lnbmluLnVzZXIuYWRtaW4iLCJhdXRoX3RpbWUiOjE3NjUyMDU2MzksImlzcyI6Imh0dHBzOlwvXC9jb2duaXRvLWlkcC51cy1lYXN0LTEuYW1hem9uYXdzLmNvbVwvdXMtZWFzdC0xX3lUeVJpZjlSRCIsImV4cCI6MTc2NTk5MTQxNCwiaWF0IjoxNzY1OTg3ODE0LCJqdGkiOiI1YmYyODdlMy02MDE0LTQxZGYtOTJjNS0yNjM0YjkzOTI1ZGIiLCJjbGllbnRfaWQiOiIzb2hqMXVvYm4wYTh2Y2N1djNhZnJkcHFtZSIsInVzZXJuYW1lIjoiYjQ2MDZiMmMtNzhiMy00OTZiLWI5N2EtYzk4YmI0YzkyOTJmIn0.XvLuiumH8IU-vlgwglWBDhAIlF4NxeTODsLCsAZT8Xy_0IwTG8OqG0od6Kt4vjw8ISWs5xSQU-eV_avQ_yUylzKo55ha7Un6dI9adWtFD5HMNa4LlmpAL1bO8pwqjjBKKFHIZ8PQWJq2NzV2J8SR87YSlDKFOFstytmgjb33FbEkDpUZCM-DXgcbGBbirXr7-xzupOkHSS4PRWTZAsJpz3WnsCYGJr4cPtUdzxVAIeAR9lOIqe8E9LWBqgyuMB5BrtBe7QPm69GpEOog_UayNmpW18cH9eDBLqMKuTSG1bdqAj3VNbqv4D3IRln9c325WehT8ndKuZ_rxILmAMHHNg","type":"text"}],"body":{"mode":"raw","raw":"{ \r\n \"TripDayId\": \"{{trip-day-id}}\",\r\n \"Name\": \"Event 1780225217\",\r\n \"Description\": \"This is great!\",\r\n \"StartTimeInMinutes\": \"17\",\r\n \"EventType\": 5,\r\n \"SegmentProviderName\": \"Lincoln's Grand Hotel\",\r\n \"SegmentProviderPhone\": \"555-867-5309\",\r\n \"SegmentProviderUrl\": \"https://lincolnsgrandhotel.com\",\r\n \"SegmentIdentifier\": \"YFH2XVDB\",\r\n \"DurationInMinutes\": 90,\r\n \"Images\": [\"http://lorempixel.com/600/400/cats\", \"http://lorempixel.com/800/600/abstract\"],\r\n \"IsEndingEvent\": true,\r\n \"CurrencyCode\": \"USD\",\r\n \"PriceInCents\": 12345,\r\n \"StartTimeZoneId\": \"America/Chicago\",\r\n \t\"FlightUpdateInformation\": {\r\n\t\t\"AirlineIataCode\": \"UA\",\r\n \t\"FlightNumber\": \"4432\", \t\t\r\n \t\"DepartureAirportIataCode\": \"LBB\",\r\n \t\"ArrivalAirportIataCode\": \"IAH\",\r\n \t\"DepartureDateYear\": 2019,\r\n \t\"DepartureDateMonth\": 4,\r\n \t\"DepartureDateDay\": 22\r\n \t}\r\n}\r\n"},"url":"localhost:51035/api/v1/tripEvents"},"status":"Not Found","code":404,"_postman_previewlanguage":null,"header":[{"key":"Content-Length","value":"4472"},{"key":"Content-Type","value":"text/html; charset=utf-8"},{"key":"Date","value":"Wed, 17 Dec 2025 16:12:16 GMT"},{"key":"X-MiniProfiler-Ids","value":"[\"293ce2b0-70eb-4fd3-b75e-92824cc5210f\",\"ebf115c2-8fb5-4824-b7a7-056336dbfcc0\",\"9541c935-8ef2-40b0-8b0e-b79336fee04d\",\"1b2d8385-2f3f-4520-9894-07f1e0daa5c0\",\"b2a0cb24-5706-45cd-b128-70ef1175a899\",\"9fc5d73a-2a99-4e99-8697-bf10a1389673\",\"244104ff-d18a-4ce2-ae37-c6fe5ed40dee\",\"d070d72d-d519-4955-bcf3-6119226620cb\",\"3a9b0316-658b-4e6c-94c6-402c17541ffb\",\"46bb9af2-a472-417b-9785-d0e3353b88a2\",\"4f98f422-e107-4326-ac79-d67425278d4a\",\"ae605097-237f-4f6d-ad04-5596a68ce560\",\"2e180fd2-b575-48c2-845c-2fd205fcb9ed\",\"d40cc99d-2dbc-4219-9e37-29f86e5b8f4b\",\"e219aa1e-72b4-4c31-94a1-c1a5919b2405\",\"39c42952-a98a-4e4e-9557-fd7b6d9ee46d\",\"bbda5592-13c4-4a89-8e73-7c731efb0561\",\"7df06148-de77-450d-a00a-77feb6fcd939\",\"adf46806-1b15-468e-91b9-5b6bed6e38e2\",\"429d39d1-fb56-4e28-a38a-17f319509ec4\",\"1d34d4ca-ad5f-4ece-b93f-43d13c481a37\",\"09b3f710-d4d6-4409-a5fe-a54ef90d8f2c\"]"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Security-Policy","value":"object-src 'none'; script-src 'nonce-+4KYOlDwLT874QCNrdBq0kG6htwNvbzNKZiEcKxzg9I=' use.typekit.net www.googletagmanager.com 'unsafe-inline' 'unsafe-eval' 'strict-dynamic' 'report-sample' https: http:; base-uri 'none'; report-uri /logging/csp-reports; frame-ancestors 'self';"},{"key":"X-ENVIRONMENT","value":"dev"},{"key":"X-Release-Id","value":"local"},{"key":"X-Tenant","value":""},{"key":"X-Platform-Version-Result","value":"1"},{"key":"X-Response-Time","value":"147ms"}],"cookie":[],"responseTime":null,"body":"\n\n \n \nPerhaps there’s a problem with the link you used. Please contact your agent for assistance.
\nGet every TripEvent on this Trip.
NOTE: You must supply the X-TRIP-ID header with the created Trip's TripId.
Get a specified TripEvent.
NOTE: You must supply the X-TRIP-ID header with the TripId from the created Trip.
Update a specified TripEvent.
NOTE: You must supply the X-TRIP-ID header with the TripId from the created Trip.
is awesome!
\",\n \"StartTimeZoneId\": null,\n \"StartTimeInMinutes\": 137,\n \"DurationInMinutes\": 120,\n \"StartTerminal\": null,\n \"StartGate\": null,\n \"EndTerminal\": null,\n \"EndGate\": null,\n \"PriceInCents\": null,\n \"CurrencyCode\": null,\n \"TransportationIdentifier\": null,\n \"EventType\": 4,\n \"IsEndingEvent\": false,\n \"IsArrival\": false,\n \"TripIdeas\": null,\n \"PartnerIdentifier\": null\n}"}],"_postman_id":"74787c0f-babd-4c90-bd5a-07373601b866"},{"name":"Update Trip Event","event":[{"listen":"test","script":{"id":"432d8e74-34df-411e-80a6-d2707aa8788f","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;\r","\r","var data = JSON.parse(responseBody);\r","\r","tests['Body contains Trip Event'] = data.Id;\r","tests['Body contains Trip Day'] = data.TripDayId;\r","tests['Body contains event type'] = data.EventType;\r","\r","postman.setEnvironmentVariable(\"trip-event-id\", data.Id);\r",""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"1a7f777f-425e-4542-a87b-88b90bd4c78f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"X-USER-TOKEN","value":"{{user-access-token}}"},{"key":"X-API-PUBLIC-KEY","value":"{{platform-public-key}}"},{"key":"X-TRIP-ID","value":"{{trip-id}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{ \r\n \"TripDayId\": \"{{trip-day-id}}\",\r\n \"Name\": \"Updated Event 1780225217\",\r\n \"Description\": \"is awesome!\",\r\n \"StartTimeInMinutes\": \"659\",\r\n \"EventType\": 6,\r\n \"SegmentProviderName\": \"Hilton-Kansas City\",\r\n \"SegmentProviderPhone\": \"555-867-5309\",\r\n \"SegmentProviderUrl\": \"https://hilton.com\",\r\n \"SegmentIdentifier\": \"YFHP02XVDB\",\r\n \"DurationInMinutes\": 120,\r\n \"ReservationDescription\": \"Executive Suite, One King\",\r\n \"IsActive\": true,\r\n \t\"TripIdeas\": [\r\n \t\t{\r\n \t\t\t\"Id\": {{trip-idea-id}},\r\n\t \"Name\": \"My New Place\",\r\n\t \"ImageUrl\": \"http://lorempixel.com/400/200/cats\",\r\n\t \"Url\": \"https://example.com\",\r\n\t \"Description\": \"A wonderful place to go!\",\r\n\t \"Latitude\": 34.0784796,\r\n\t \"Longitude\": -107.6184694,\r\n\t \"Address\": \"123 W Main St\",\r\n\t \"City\": \"Citytown\",\r\n\t \"State\": \"NM\",\r\n\t \"ZipCode\": \"87825\",\r\n\t \"Phone\": null,\r\n\t \"Country\": \"US\",\r\n\t \"IsActive\": true\r\n }\r\n \t],\r\n \"ThirdPartyPropertyIds\": {\r\n \"Giata\": 168935\r\n }\r\n}"},"url":"{{base-api-url}}api/v1/tripEvents/{{trip-event-id}}","description":"Update a specified TripEvent and it's TripIdeas.
NOTE: You must supply the X-TRIP-ID header with the TripId from the created Trip.
NOTE: do not pass up any TripDays if you only want to update the metadata.
If you pass up any TripIdeas, the entire list of TripIdeas will be replaced.
Adding optional ThirdPartyPropertyIds will do a best-effort lookup of the property in the Travefy Global Properties database. If we find a matching property, we will add our photos to the TripEvent.
Currently supported ThirdPartyPropertyIds are Giata, Leonardo, IcePortal, and Sabre.
is awesome!
\",\n \"StartTimeZoneId\": null,\n \"StartTimeInMinutes\": 137,\n \"DurationInMinutes\": 120,\n \"StartTerminal\": null,\n \"StartGate\": null,\n \"EndTerminal\": null,\n \"EndGate\": null,\n \"PriceInCents\": null,\n \"CurrencyCode\": null,\n \"TransportationIdentifier\": null,\n \"EventType\": 4,\n \"IsEndingEvent\": false,\n \"IsArrival\": false,\n \"TripIdeas\": null,\n \"PartnerIdentifier\": null\n}"}],"_postman_id":"1a7f777f-425e-4542-a87b-88b90bd4c78f"},{"name":"Delete Trip Event ","event":[{"listen":"test","script":{"id":"4dec2d19-1587-42c9-a686-459ad505a10f","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","","tests['IsActive is false'] = !data.IsActive;",""],"type":"text/javascript"}}],"id":"e40ffad0-0c32-4ffd-ad04-a42c6d5dbde0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"X-USER-TOKEN","value":"{{user-access-token}}"},{"key":"X-API-PUBLIC-KEY","value":"{{platform-public-key}}"},{"key":"X-TRIP-ID","value":"{{trip-id}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"formdata","formdata":[]},"url":"{{base-api-url}}api/v1-{{api-version}}/tripEvents/{{trip-event-id}}","description":"Delete a specified TripEvent.
NOTE: You must supply the X-TRIP-ID header with the TripId from the created Trip.
is awesome!
\",\n \"StartTimeZoneId\": null,\n \"StartTimeInMinutes\": 137,\n \"DurationInMinutes\": 120,\n \"StartTerminal\": null,\n \"StartGate\": null,\n \"EndTerminal\": null,\n \"EndGate\": null,\n \"PriceInCents\": null,\n \"CurrencyCode\": null,\n \"TransportationIdentifier\": null,\n \"EventType\": 4,\n \"IsEndingEvent\": false,\n \"IsArrival\": false,\n \"TripIdeas\": null,\n \"PartnerIdentifier\": null\n}"}],"_postman_id":"e40ffad0-0c32-4ffd-ad04-a42c6d5dbde0"}],"id":"c3f033b9-42e7-4f0b-9498-9d201fbf20d3","description":"A TripEvent is an item on the TripDay.
NOTE: You must supply a valid TripDayId for the TripEvent.
NOTE: You must supply the X-TRIP-ID header with the TripId from the created Trip.
TripEventType can be set to one of the following:
Here's a list of IANA time zones (use the \"Timezone\" field): https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
\nFor the Description field, the following restrictions apply:
Allowed tags:a, b, br, div, em, i, li, ol, p, span, strong, ul
Allowed attributes:href, style
Allowed CSS propertiesbackground-color
Allowed URI Schemes:https, http, mailto, tel
The ReservationDescription field will display as \"Seat / Tickey Details\" for Flight (0) events and display \"Room Type / Bedding\" for Hotel (6) events and will not display for all others.
Create (invite) 1 or more TripUsers to a Trip. FullName and UserName (email) are required.
Currently, this will not send an invite email to them, so you will need to notify them to check their trips list if needed.
\nNOTE: You cannot invite anyone in the Organizer Role.
NOTE: You must supply the X-TRIP-ID header with the TripId from the created Trip and it must match the trip-id in the URI.
Retreive a given TripUser.
NOTE: You must supply the X-TRIP-ID header with the TripId from the created Trip and it must match the trip-id in the URI.
Retreive all TripUsers on a Trip.
NOTE: You must supply the X-TRIP-ID header with the TripId from the created Trip and it must match the trip-id in the URI.
Update the Role of a given TripUser on a Trip.
NOTE: You cannot update anyone to the Organizer Role. You cannot change the Role of an existing Organizer.
NOTE: You must supply the X-TRIP-ID header with the TripId from the created Trip and it must match the trip-id in the URI.
Update the Roles of multiple TripUsers on a Trip.
NOTE: You cannot update anyone to the Organizer Role. You cannot change the Role of an existing Organizer.
NOTE: You must supply the X-TRIP-ID header with the TripId from the created Trip and it must match the trip-id in the URI.
Delete (uninvite) a given TripUser on a Trip.
NOTE: You cannot remove anyone in the Organizer Role.
NOTE: You must supply the X-TRIP-ID header with the TripId from the created Trip and it must match the trip-id in the URI.
A TripUser represents a User on a Trip. TripUsers can be invited to a trip and have different roles depending on your subscription level. Here are the available Roles:
Available operations:
\nTripUsersTripUserTripUsers for a TripTripUserTripUsersTripUser which moves them to the Uninvited RoleNOTE: You must supply the X-TRIP-ID header with the TripId from the created Trip and it must match the trip-id in the URI. The TripUser endpoints use a slightly different URL structure than other Trip resources. We will likely move to this type of structure in the future for all Trip resources. We will version the API or allow the old style rather than making breaking changes to existing calls.
Remove a User from the Travefy platform.
Note: You will not be able to re-enable or re-create a User after calling this. The User will have to re-authorize your platform manually.
true to return only Events created by the user, false to return all Events for the User's team. Defaults to true.
EventType can be set to one of the following:
Note: Attached content cannot be viewed or managed via the API at this time.
\n","_postman_id":"6baf93b0-c4de-49f9-8379-42e30753641a"},{"name":"Content","item":[{"name":"Create Content","event":[{"listen":"test","script":{"id":"d1ccf7b7-7f6a-4230-9752-ab4c455072fd","exec":["var data = JSON.parse(responseBody);","","tests['Content was created'] = data.Id > 0;","tests['Content is active'] = data.IsActive;","tests['Content Name'] = data.Name;","tests['Content image url'] = data.ImageUrl;","tests['Content url'] = data.Url;","tests['Content latutude'] = data.Latitude;","tests['Content longutude'] = data.Longitude;","tests['Content city'] = data.City;","tests['Content state'] = data.State;","tests['Content zip'] = data.ZipCode;","tests['Content country'] = data.Country;","tests['Content description'] = data.Description;","tests['Content description'] = data.Category;","tests['Content description'] = data.Rating;","tests['Content description'] = data.Phone;","","tests['Content partner identifier'] = data.PartnerIdentifier.startsWith(\"test-content-\");","","postman.setEnvironmentVariable(\"saved-content-id\", data.Id);","postman.setEnvironmentVariable(\"saved-content-partner-identifier\", data.PartnerIdentifier);"],"type":"text/javascript"}}],"id":"4e40cd44-861d-4aef-817e-8d5eae4187ea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-USER-TOKEN","value":"{{user-access-token}}"},{"key":"X-API-PUBLIC-KEY","value":"{{platform-public-key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Name\": \"My Place\",\n \"ImageUrl\": \"http://lorempixel.com/g/400/200/cats/content/\",\n \"Url\": \"https://example.com\",\n \"Latitude\": 46.127931,\n \"Longitude\": -76.122413,\n \"Address\": \"123 Main Street\",\n \"City\": \"Lincoln\",\n \"State\": \"NE\",\n \"ZipCode\": \"68508\",\n \"Country\": \"US\",\n \"Description\": \"This is a GREAT place to visit!\",\n \"Category\": 338,\n \"Rating\": 4.2,\n \"IsActive\": true,\n \"Phone\": \"(402) 867-5309\",\n \"PartnerIdentifier\": \"test-content-id-1780225217\"\n}"},"url":"{{base-api-url}}api/v1-{{api-version}}/library/content","urlObject":{"path":["v1-{{api-version}}","library","content"],"host":["{{base-api-url}}api"],"query":[],"variable":[]}},"response":[{"id":"ff9c4820-a1de-4805-874f-581da406dd1b","name":"Create Content","originalRequest":{"method":"POST","header":[{"key":"X-USER-TOKEN","value":"{{user-access-token}}"},{"key":"X-API-PUBLIC-KEY","value":"{{platform-public-key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Name\": \"My Place\",\n \"ImageUrl\": \"http://lorempixel.com/g/400/200/cats/content/\",\n \"Url\": \"https://example.com\",\n \"Latitude\": 46.127931,\n \"Longitude\": -76.122413,\n \"Address\": \"123 Main Street\",\n \"City\": \"Lincoln\",\n \"State\": \"NE\",\n \"ZipCode\": \"68508\",\n \"Country\": \"US\",\n \"Description\": \"This is a GREAT place to visit!\",\n \"Category\": 338,\n \"Rating\": 4.2,\n \"IsActive\": true,\n \"Phone\": \"(402) 867-5309\",\n \"PartnerIdentifier\": \"test-content-id-1780225217\"\n}"},"url":"{{base-api-url}}api/v1/library/content"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"439","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Wed, 15 Nov 2017 21:44:41 GMT","name":"Date","description":""},{"key":"Expires","value":"-1","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"Microsoft-IIS/10.0","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""},{"key":"X-SourceFiles","value":"=?UTF-8?B?Tjpcd29ya3NwYWNlc1x0cmF2ZWZ5XHRyYXZlZnlcVHJhdmVmeS5BcGlcYXBpXHYxXGxpYnJhcnlcY29udGVudA==?=","name":"X-SourceFiles","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"Id\": 261577,\n \"Name\": \"My Place\",\n \"ImageUrl\": \"http://lorempixel.com/g/400/200/cats/content/\",\n \"Url\": \"https://example.com\",\n \"Latitude\": 46.127931,\n \"Longitude\": -76.122413,\n \"Address\": \"123 Main Street\",\n \"City\": \"Lincoln\",\n \"State\": \"NE\",\n \"ZipCode\": \"68508\",\n \"Country\": \"US\",\n \"Description\": \"This is a GREAT place to visit!\",\n \"Category\": 338,\n \"Rating\": 4.2,\n \"IsActive\": true,\n \"Phone\": \"(402) 867-5309\",\n \"PartnerIdentifier\": \"test-content-id-1510782282\"\n}"}],"_postman_id":"4e40cd44-861d-4aef-817e-8d5eae4187ea"},{"name":"Get All Content","event":[{"listen":"test","script":{"id":"40423847-f1e3-4306-9eae-1a2373e6e2b1","exec":["var data = JSON.parse(responseBody);","","tests['content was returned'] = data.length > 0;","","var firstContent = data[0]; ","","tests['Content was created'] = firstContent.Id > 0;","tests['Content is active'] = firstContent.IsActive;","tests['Content Name'] = firstContent.Name;","tests['Content image url'] = firstContent.ImageUrl;","tests['Content url'] = firstContent.Url;","tests['Content latutude'] = firstContent.Latitude;","tests['Content longutude'] = firstContent.Longitude;","tests['Content city'] = firstContent.City;","tests['Content state'] = firstContent.State;","tests['Content zip'] = firstContent.ZipCode;","tests['Content country'] = firstContent.Country;","tests['Content description'] = firstContent.Description;","tests['Content description'] = firstContent.Category;","tests['Content description'] = firstContent.Rating;","tests['Content description'] = firstContent.Phone;",""],"type":"text/javascript"}}],"id":"d2072146-841c-4773-af26-b2266dc6860e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-USER-TOKEN","value":"{{user-access-token}}"},{"key":"X-API-PUBLIC-KEY","value":"{{platform-public-key}}"}],"url":"{{base-api-url}}api/v1-{{api-version}}/library/content?createdByUser=true","urlObject":{"path":["v1-{{api-version}}","library","content"],"host":["{{base-api-url}}api"],"query":[{"description":{"content":"true to return only Content created by the user, false to return all Content for the User's team. Defaults to true.
You can now manage the Library of your Users.
\nNote, the following features are not yet available in the API:
\nPartnerIdentifierCreate an inventory record.
\n","urlObject":{"path":["v1-{{api-version}}","inventoryRecords",""],"host":["{{base-api-url}}api"],"query":[],"variable":[]}},"response":[{"id":"9ae7d776-5798-4389-b122-b02b8ffc8cc9","name":"Create Inventory Record","originalRequest":{"method":"POST","header":[{"key":"X-API-PUBLIC-KEY","value":"{{platform-public-key}}"},{"key":"X-API-PRIVATE-KEY","value":"{{platform-private-key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"Id\": \"test-123 1780225217\",\r\n \"Name\": \"Personalized Tours of Travefy Office\",\r\n \"Url\": \"https://travefy.com/\",\r\n \"Description\": \"See where the Travefy magic happens! \\r\\n Enjoy your lovely view of the vibrant Lincoln Haymarket.\",\r\n \"ImageUrl\": \"http://nebraskaglobal.com/images/img-contact2.jpg\",\r\n \"IsActive\": true,\r\n \"Latitude\": 40.814385,\r\n \"Longitude\": -96.710113,\r\n \"Price\": null,\r\n \"CurrencyCode\": null,\r\n \"Address\": \"151 N 8th St, #300\",\r\n \"City\": \"Lincoln\",\r\n \"State\": \"NE\",\r\n \"Country\": \"US\",\r\n \"ZipCode\": \"68506\",\r\n \"HideOnMap\": false,\r\n \"SearchAttributes\": [\r\n {\r\n \"Key\": \"Type\",\r\n \"Value\": \"Office\"\r\n },\r\n {\r\n \"Key\": \"Maximum Occupancy\",\r\n \"Value\": \"15\"\r\n }\r\n ],\r\n \"ImageUrls\": [\r\n \"https://about.travefy.com/wp-content/uploads/2015/09/team-bkgrd-2015.jpg\",\r\n \"https://about.travefy.com/wp-content/uploads/2014/08/Andrew-Badami-Travefy.jpg\",\r\n \"https://about.travefy.com/wp-content/uploads/2015/06/stephanie-leonard-travefy.jpg\"\r\n ],\r\n \"TopLevelCategories\": [\r\n \"Office Tours\"\r\n ],\r\n \"DescriptionAttributes\": [\r\n {\r\n \"Key\": \"Cost\",\r\n \"Value\": \"FREE!\"\r\n },\r\n {\r\n \"Key\": \"Hours\",\r\n \"Value\": \"30pm\"\r\n },\r\n {\r\n \"Key\": \"WiFi\",\r\n \"Value\": \"Available\"\r\n },\r\n {\r\n \"Key\": \"Parking\",\r\n \"Value\": \"On Street\"\r\n }\r\n ]\r\n}"},"url":"{{base-api-url}}api/v1/inventoryRecords/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"name":"cache-control","key":"cache-control","value":"no-cache","description":""},{"name":"connection","key":"connection","value":"keep-alive","description":""},{"name":"content-length","key":"content-length","value":"1047","description":""},{"name":"content-type","key":"content-type","value":"application/json; charset=utf-8","description":""},{"name":"date","key":"date","value":"Wed, 25 Oct 2017 18:21:49 GMT","description":""},{"name":"expires","key":"expires","value":"-1","description":""},{"name":"pragma","key":"pragma","value":"no-cache","description":""},{"name":"server","key":"server","value":"nginx/1.12.1","description":""},{"name":"strict-transport-security","key":"strict-transport-security","value":"max-age=31536000","description":""},{"name":"x-aspnet-version","key":"x-aspnet-version","value":"4.0.30319","description":""}],"cookie":[],"responseTime":null,"body":"{\"Id\":\"test-123 1508955704\",\"Name\":\"Personalized Tours of Travefy Office\",\"Url\":\"https://travefy.com/\",\"Description\":\"See where the Travefy magic happens! \\r\\n Enjoy your lovely view of the vibrant Lincoln Haymarket.\",\"ImageUrl\":\"http://nebraskaglobal.com/images/img-contact2.jpg\",\"IsActive\":true,\"Latitude\":40.814385,\"Longitude\":-96.710113,\"Price\":null,\"CurrencyCode\":null,\"Address\":\"151 N 8th St, #300\",\"City\":\"Lincoln\",\"State\":\"NE\",\"Country\":\"US\",\"ZipCode\":\"68506\",\"Phone\":null,\"HideOnMap\":false,\"SearchAttributes\":[{\"Key\":\"Type\",\"Value\":\"Office\"},{\"Key\":\"Maximum Occupancy\",\"Value\":\"15\"}],\"ImageUrls\":[\"https://about.travefy.com/wp-content/uploads/2015/09/team-bkgrd-2015.jpg\",\"https://about.travefy.com/wp-content/uploads/2014/08/Andrew-Badami-Travefy.jpg\",\"https://about.travefy.com/wp-content/uploads/2015/06/stephanie-leonard-travefy.jpg\"],\"TopLevelCategories\":[\"Office Tours\"],\"DescriptionAttributes\":[{\"Key\":\"Cost\",\"Value\":\"FREE!\"},{\"Key\":\"Hours\",\"Value\":\"30pm\"},{\"Key\":\"WiFi\",\"Value\":\"Available\"},{\"Key\":\"Parking\",\"Value\":\"On Street\"}]}"}],"_postman_id":"392a40ca-6fc5-4295-8410-79a69230ac7b"},{"name":"Get Inventory Record","event":[{"listen":"test","script":{"id":"bbc702e0-5d47-4622-be62-df3e717ed788","exec":["var data = JSON.parse(responseBody);","","tests['Has record'] = data.Id;","tests['Matching id'] = data.Id === postman.getEnvironmentVariable(\"inventory-id\");",""],"type":"text/javascript"}}],"id":"aeb84b98-9ceb-40c1-808f-83e823231e4e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-PUBLIC-KEY","value":"{{platform-public-key}}"},{"key":"X-API-PRIVATE-KEY","value":"{{platform-private-key}}"},{"key":"Content-Type","value":"application/json"}],"url":"{{base-api-url}}api/v1-{{api-version}}/inventoryRecords/{{inventory-id}}","description":"Get a given InventoryRecord by its Id
Get all the InventoryRecords for your platform.
Update a given InventoryRecord by Id/
Delete an InventoryRecord by Id.
If you have platform search enabled, you can manage your InventoryRecords here. Everything is keyed off of your provided Id field, so be sure that is unique and non-changing.
If you're using the CSV upload, here is the list of CSV fields: https://slack-files.com/T03PA1YTJ-F0BP4RPDW-7cd557a880
\n","_postman_id":"6aeeab9d-2b99-4c05-8aa1-5b037ff529ff"}],"id":"cab0e67e-29d8-498f-9684-1ddf63dc600c","event":[{"listen":"prerequest","script":{"id":"421e5190-6cae-48a7-af26-22457f00cff1","type":"text/javascript","exec":["//preset version number","pm.environment.set(\"api-version\", 20241001);","pm.environment.set(\"current-year\", new Date().getFullYear());","pm.environment.set(\"next-year\", new Date().getFullYear() + 1);","","utils = {"," loadTripDays: (tripDays, env) => {"," const setId = (key, el) => {"," console.log(`${key} = ${el.Id}`);"," env.set(key, el.Id);"," console.log(`${key} == ${env.get(key)}`);"," }","",""," tripDays.forEach((dayEl, dayIndex) => {"," const dayKey = `trip-day-id-${dayIndex}`;"," setId(dayKey, dayEl);"," dayEl.TripEvents?.forEach((eventEl, eventIndex) => {"," const eventKey = `${dayKey}-event-id-${eventIndex}`;"," setId(eventKey, eventEl);"," eventEl.TripIdeas?.forEach((ideaEl, ideaIndex) => {"," let ideaKey = `${eventKey}-idea-id-${ideaIndex}`;"," setId(ideaKey, ideaEl);"," });"," });"," });"," }","};",""]}},{"listen":"test","script":{"id":"a9d4ce5d-1df4-4765-be09-bcc24df88351","type":"text/javascript","exec":[""]}}],"_postman_id":"cab0e67e-29d8-498f-9684-1ddf63dc600c","description":""}],"event":[{"listen":"prerequest","script":{"id":"b7862319-03ef-464f-a096-19ae8cfbf796","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"325694f1-d1b5-445c-8cc5-8dc516f58e77","type":"text/javascript","exec":[""]}}]}