{"info":{"_postman_id":"83299876-32c6-426c-b137-8df6172b7bac","name":"TRYB Review API Documentation","description":"

🚀 This is the official TRYB Review API Version 1.0.0!

⚙️ API are useful to automate processes!

For example, you can automate the process of adding new seats, or automate review invitations!

AUTHORIZATION:

HOW TO FIND YOUR API TOKEN:

Log in into the webapp
Go to 'Settings' on the top-right corner
Click on 'Automate'
Click copy on the 'x-api-key'

HOW TO FIND YOUR SEAT ID:

Log in into the webapp
Go to 'Settings' on the top-right corner
Click on 'Automate'
Click on 'Seat ID' to copy the selected ID you want to use

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"27467657","collectionId":"83299876-32c6-426c-b137-8df6172b7bac","publishedId":"2s93kxdSAw","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2023-05-17T08:46:59.000Z"},"item":[{"name":"Review Invitations","item":[{"name":"Schedule review invitation","id":"ab5e08ea-3f58-4d95-9aa4-0ebe4e33d3c6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-api-key","value":"YOUR-API-TOKEN","type":"text"}],"body":{"mode":"raw","raw":"{\n \"send_datetime\":\"2021-09-23T15:52:55+02:00\",\n \"retry\":3,\n \"template\":{\n \"subject\":\"Ciao {{name}}\",\n \"html\":\"test {{name}} {{company_name}} {{review_link}}\",\n \"text\":\"test {{name}} {{company_name}} {{review_link}}\"\n },\n \"name\":\"Marco\",\n \"email\":\"mattamarco88@gmail.com\",\n \"user_defined_id\":\"xxx\",\n \"seat\":\"{{seat_api}}\"\n}"},"url":"https://server.onlinereviews.tech/public-api/v1.0.0/review/invitation","description":"

BODY DESCRIPTION:

send_datetime: DateTime,

When you want the invitation to be sent.

retry: Int,

How many time do you want to re-send this invitation if the client does not click on the review link.

Template: Dict,

subject: String,
- The subject of the email
\n
html: String,
- The text of the email: any parameters will need to be inside double brackets
\n
text:String,
- The text of the email: any parameters will need to be inside double brackets
\n

name: String,

Name of the client you want to send the invitation to.

email: String,

Email of the client.

user_defined_id: Optional, String,

If you pass this parameter, as a response to a successful invitation, we will send you back this ID, as a tracking method

seat: String,

The ID of the seat

RESPONSE DESCRIPTION:

{\n    \"id\": \"\",\n    \"tracking\": \"\",\n    \"send_datetime\": \"\",\n    \"retry\": \"\",\n    \"template\":{},\n    \"name\": \"\",\n    \"email\": \"\",\n    \"user_defined_id\": \"\",\n    \"idempotency_id\": \"\"\n}\n\n

\n","urlObject":{"protocol":"https","path":["public-api","v1.0.0","review","invitation"],"host":["server","onlinereviews","tech"],"query":[],"variable":[]}},"response":[],"_postman_id":"ab5e08ea-3f58-4d95-9aa4-0ebe4e33d3c6"},{"name":"Delete review invitation","id":"c2e65a3e-50f4-4bf3-9a49-d8c1b66ca846","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"x-api-key","value":"YOUR_API_TOKEN","type":"text"}],"url":"https://server.onlinereviews.tech/public-api/v1.0.0/review/invitation/:invitation_id","description":"

Delete the invitation.

PATH VARIABLES DESCRIPTION:

invitation_id: String,

The ID of the Invitation.

\n","urlObject":{"protocol":"https","path":["public-api","v1.0.0","review","invitation",":invitation_id"],"host":["server","onlinereviews","tech"],"query":[],"variable":[{"id":"2b29eb97-d3d4-4a16-947f-aa365d330359","type":"any","value":null,"key":"invitation_id"}]}},"response":[],"_postman_id":"c2e65a3e-50f4-4bf3-9a49-d8c1b66ca846"},{"name":"Get review Invitation","id":"713bdd6d-2881-48d8-a004-8935bacd5a6d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"YOUR_API_TOKEN","type":"text"}],"url":"https://server.onlinereviews.tech/public-api/v1.0.0/review/invitation/:invitation_id","description":"

Get invitation description.

PATH VARIABLES DESCRIPTION:

invitation_id: String,

The ID of the invitation.

RESPONSE DESCRIPTION:

{\n    \"id\": \"\",\n    \"tracking\": \"\",\n    \"send_datetime\": \"\",\n    \"retry\": \"\",\n    \"template\":{},\n    \"name\": \"\",\n    \"email\": \"\",\n    \"user_defined_id\": \"\",\n    \"idempotency_id\": \"\"\n}\n\n

\n","urlObject":{"protocol":"https","path":["public-api","v1.0.0","review","invitation",":invitation_id"],"host":["server","onlinereviews","tech"],"query":[],"variable":[{"id":"6a647e64-477f-46fe-8e79-c88ccf0645dd","type":"any","value":"","key":"invitation_id"}]}},"response":[],"_postman_id":"713bdd6d-2881-48d8-a004-8935bacd5a6d"},{"name":"Get review stats","id":"cb6414e6-a7e3-47c3-b322-d2d23853a74a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://server.onlinereviews.tech/public-api/v1.0.0/review/stats/:seat_id","description":"

Return reviews stats of your seats.

PATH VARIABLES DESCRIPTION:

seat_id: String,

The ID of the seat.

\n","urlObject":{"protocol":"https","path":["public-api","v1.0.0","review","stats",":seat_id"],"host":["server","onlinereviews","tech"],"query":[],"variable":[{"id":"13058b8a-7174-46fe-99d9-060aeb2690f1","type":"any","value":null,"key":"seat_id"}]}},"response":[],"_postman_id":"cb6414e6-a7e3-47c3-b322-d2d23853a74a"}],"id":"3e4b643b-d1ff-4908-a1ba-fbf560d7640d","description":"

Automate the review invitations.

\n","_postman_id":"3e4b643b-d1ff-4908-a1ba-fbf560d7640d"}]}