(Required)
\n","type":"text/plain"},"key":"merchant_id","value":"12345"},{"description":{"content":"(Required) Number of people in the reservation
\n","type":"text/plain"},"key":"party_size","value":"5"},{"description":{"content":"(Required) Timestamp to center the availability search
\n","type":"text/plain"},"key":"search_ts","value":"2020-05-11T18:15:00-04:00"},{"key":"search_window_minutes","value":"180"}],"variable":[]}},"response":[{"id":"2362e136-2aa8-4207-a8d2-3d8d5fbff476","name":"OK","originalRequest":{"method":"GET","header":[{"description":"(Required) Bearer Token","key":"Authorization","value":"Bearer eyJraW...."}],"url":{"raw":"{{base_gateway_url}}/reservations/availability?merchant_id=12345&party_size=5&search_ts=2020-05-11T18:15:00-04:00&search_window_minutes=180","host":["{{base_gateway_url}}"],"path":["reservations","availability"],"query":[{"key":"merchant_id","value":"12345"},{"key":"party_size","value":"5"},{"key":"search_ts","value":"2020-05-11T18:15:00-04:00"},{"key":"search_window_minutes","value":"180"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"availability_types\": [\n {\n \"id\": 1234,\n \"name\": \"Dinner Reservation\",\n \"description\": \"This is customizable text\",\n \"is_default\": true,\n \"slots\": [\n {\n \"timestamp\": \"2020-05-11T18:00:00-04:00\",\n \"is_available\": false\n },\n {\n \"timestamp\": \"2020-05-11T18:15:00-04:00\",\n \"is_available\": true\n },\n {\n \"timestamp\": \"2020-05-11T18:30:00-04:00\",\n \"is_available\": false\n }\n ]\n },\n {\n \"id\": 4321,\n \"name\": \"Mother's Day Brunch ($40 per person)\",\n \"description\": \"Enjoy a Special 3 Course Meal (Appetizer, Entree, Dessert) to celebrate mother's day!\",\n \"prepaid_fee\": 40,\n \"is_flat_fee\": false,\n \"is_default\": false,\n \"slots\": [\n {\n \"timestamp\": \"2020-05-11T18:00:00-04:00\",\n \"is_available\": true\n },\n {\n \"timestamp\": \"2020-05-11T18:15:00-04:00\",\n \"is_available\": true\n },\n {\n \"timestamp\": \"2020-05-11T18:30:00-04:00\",\n \"is_available\": true\n }\n ]\n }\n ]\n}"}],"_postman_id":"e70c737d-f705-4b2e-987e-3542f54d9e72"},{"name":"Get existing reservation","id":"97da3da4-ed85-4fce-9326-f6af8927369c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"(Required) Bearer Token
\n","key":"Authorization","value":"Bearer eyJraW...."}],"url":"{{base_gateway_url}}/guest/reservations/:id","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":"(Required)
\n","type":"text/plain"},"type":"any","value":"12345","key":"id"}]}},"response":[{"id":"57a27353-5371-4a45-af31-cc59ee553541","name":"OK","originalRequest":{"method":"GET","header":[{"description":"(Required) Bearer Token","key":"Authorization","value":"Bearer eyJraW...."}],"url":{"raw":"{{base_gateway_url}}/guest/reservations/:id","host":["{{base_gateway_url}}"],"path":["guest","reservations",":id"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"party\": {\n \"id\": \"523f43xdsa\",\n \"name\": \"John Snow\",\n \"party_size\": 2,\n \"phone\": \"+15551234567\",\n \"email\": \"email@test.com\",\n \"status\": \"BOOKED\",\n \"notes\": \"We would like to request a booth near the window please!\",\n \"reserved_at\": \"2020-05-11T18:15:00-04:00\",\n \"created_at\": \"2020-05-03T13:12:23-04:00\",\n \"updated_at\": \"2020-05-03T13:12:23-04:00\",\n \"deleted_at\": \"proident\",\n \"booking_url\": \"https://...\",\n \"modify_url\": \"https://...\",\n \"cancellation_url\": \"https://...\"\n }\n}"}],"_postman_id":"97da3da4-ed85-4fce-9326-f6af8927369c"},{"name":"Create new reservation","id":"80d17d65-6044-4108-bbd3-05f0668c98ad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"(Required) Bearer Token
\n","key":"Authorization","value":"Bearer eyJraW...."},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"merchant_id\": 1,\n \"name\": \"Jessica Smith\",\n \"party_size\": 2,\n \"phone\": \"+12025550109\",\n \"email\": \"hello@test.com\",\n \"availability_type_id\": 1234,\n \"reserved_at\": \"2020-05-11T18:15:00-04:00\",\n \"notes\": \"We would like a table near the window please!\"\n}"},"url":"{{base_gateway_url}}/guest/reservations","description":"Please view the information under GET /reservations/availability to get the correct availability_type_id
(Required)
\n","type":"text/plain"},"type":"any","value":"12345","key":"id"}]}},"response":[{"id":"56d530ed-fe0e-43a8-8975-dd3d2c8ca766","name":"CONFLICT","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Jessica Smith\",\n \"party_size\": 2,\n \"phone\": \"+12025550109\",\n \"email\": \"test@test.com\",\n \"reserved_at\": \"2020-05-11T18:15:00-04:00\"\n}"},"url":{"raw":"{{base_gateway_url}}/guest/reservations/:id","host":["{{base_gateway_url}}"],"path":["guest","reservations",":id"],"variable":[{"key":"id"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"There is no availability for the requested time slot\"\n}"},{"id":"dcc68cd3-e879-4a55-8445-220e2fd452a1","name":"OK","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Jessica Smith\",\n \"party_size\": 2,\n \"phone\": \"+12025550109\",\n \"email\": \"test@test.com\",\n \"reserved_at\": \"2020-05-11T18:15:00-04:00\"\n}"},"url":{"raw":"{{base_gateway_url}}/guest/reservations/:id","host":["{{base_gateway_url}}"],"path":["guest","reservations",":id"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"party\": {\n \"id\": \"523f43xdsa\",\n \"name\": \"John Snow\",\n \"party_size\": 2,\n \"phone\": \"+15551234567\",\n \"email\": \"email@test.com\",\n \"status\": \"BOOKED\",\n \"notes\": \"We would like to request a booth near the window please!\",\n \"reserved_at\": \"2020-05-11T18:15:00-04:00\",\n \"created_at\": \"2020-05-03T13:12:23-04:00\",\n \"updated_at\": \"2020-05-03T13:12:23-04:00\",\n \"deleted_at\": \"proident\",\n \"booking_url\": \"https://...\",\n \"modify_url\": \"https://...\",\n \"cancellation_url\": \"https://...\"\n }\n}"},{"id":"e0756f74-e383-4f0d-9e2a-5480406ab439","name":"INTERNAL SERVER ERROR","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Jessica Smith\",\n \"party_size\": 2,\n \"phone\": \"+12025550109\",\n \"email\": \"test@test.com\",\n \"reserved_at\": \"2020-05-11T18:15:00-04:00\"\n}"},"url":{"raw":"{{base_gateway_url}}/guest/reservations/:id","host":["{{base_gateway_url}}"],"path":["guest","reservations",":id"],"variable":[{"key":"id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"An unexpected error occured\"\n}"}],"_postman_id":"0152a59f-9319-43a7-93a8-b3b5b846ccf2"},{"name":"Remove existing reservation","id":"7911fea8-be5a-4e28-a494-b71a965e92d5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"{{base_gateway_url}}/guest/reservations/:id","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":"(Required)
\n","type":"text/plain"},"type":"any","value":"12345","key":"id"}]}},"response":[{"id":"25cbc130-944c-4752-9381-77ca2e938cb1","name":"OK","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{base_gateway_url}}/guest/reservations/:id","host":["{{base_gateway_url}}"],"path":["guest","reservations",":id"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"party\": {\n \"id\": \"523f43xdsa\",\n \"name\": \"John Snow\",\n \"party_size\": 2,\n \"phone\": \"+15551234567\",\n \"email\": \"email@test.com\",\n \"status\": \"BOOKED\",\n \"notes\": \"We would like to request a booth near the window please!\",\n \"reserved_at\": \"2020-05-11T18:15:00-04:00\",\n \"created_at\": \"2020-05-03T13:12:23-04:00\",\n \"updated_at\": \"2020-05-03T13:12:23-04:00\",\n \"deleted_at\": \"proident\",\n \"booking_url\": \"https://...\",\n \"modify_url\": \"https://...\",\n \"cancellation_url\": \"https://...\"\n }\n}"}],"_postman_id":"7911fea8-be5a-4e28-a494-b71a965e92d5"},{"name":"Upsert Buyout Event","id":"af1e7dc8-4cbc-4f74-a69b-d3ecd8a1906d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Charity dinner update\",\n \"location_source_id\": \"123abc\",\n \"source\": \"tripleseat\",\n \"source_id\": \"test_bug_fix\",\n \"contact_phone\": \"+14077449871\",\n \"event_start\": \"2022-04-16T09:00:00-06:00\",\n \"event_end\": \"2022-01-16T20:33:54+0000\",\n \"guest_count\": 5,\n \"status\": \"TENTATIVE\",\n \"room_ids\": [\n 1\n ],\n \"notes\": \"Please make sure to set up sound system. They will be doing a speech.\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_gateway_url}}/host/buyouts","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":"Wisely provides a drop-in HTML snippet to display the Reservations flow on your website. If you would like to create a more custom experience, our API allows you to perform all of the same actions.
\nUsing this API you will be able to query reservation availability and create, update and delete reservations. Along with reservations you can attach any custom fields that are unique to your custom experience.
\nAuthorization
\nThis API will require a OAuth Bearer Token. Omitting the token will result in a 401 Unauthorized Response. See Get Bearer Token for details.
\n","_postman_id":"55c56594-a456-4986-ac71-bde92a8ff77f","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":"(Required) Bearer Token
\n","key":"Authorization","value":"Bearer eyJraW...."}],"url":"{{base_gateway_url}}/waitlist/waittime?merchant_id=12345&party_size=5","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":"(Required) identifier for merchant
\n","type":"text/plain"},"key":"merchant_id","value":"12345"},{"description":{"content":"(Required) number of guests in the waitlist party
\n","type":"text/plain"},"key":"party_size","value":"5"}],"variable":[]}},"response":[{"id":"b59eb162-56d8-4b72-8541-031d6e7a1865","name":"OK","originalRequest":{"method":"GET","header":[{"description":"(Required) Bearer Token","key":"Authorization","value":"Bearer eyJraW...."}],"url":{"raw":"{{base_gateway_url}}/waitlist/waittime?merchant_id=12345&party_size=5","host":["{{base_gateway_url}}"],"path":["waitlist","waittime"],"query":[{"key":"merchant_id","value":"12345"},{"key":"party_size","value":"5"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"raw_quote\": 13.98,\n \"wait_min\": 10,\n \"wait_max\": 15\n}"}],"_postman_id":"99b7822a-cf3b-4eef-8ded-06d845f0630a"},{"name":"Get merchant tags","id":"dc3bb413-fd36-4281-b585-e32c9f7c01c7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"(Required) Bearer Token
\n","key":"Authorization","value":"Bearer eyJraW...."}],"url":"{{base_gateway_url}}/waitlist/waittime?merchant_id=12345&party_size=5","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":"(Required) identifier for merchant
\n","type":"text/plain"},"key":"merchant_id","value":"12345"},{"description":{"content":"(Required) number of guests in the waitlist party
\n","type":"text/plain"},"key":"party_size","value":"5"}],"variable":[]}},"response":[{"id":"a753a960-f31f-4363-afc9-99d667b6f44a","name":"OK","originalRequest":{"method":"GET","header":[{"description":"(Required) Bearer Token","key":"Authorization","value":"Bearer eyJraW...."}],"url":{"raw":"{{base_gateway_url}}/waitlist/waittime?merchant_id=12345&party_size=5","host":["{{base_gateway_url}}"],"path":["waitlist","waittime"],"query":[{"key":"merchant_id","value":"12345"},{"key":"party_size","value":"5"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"raw_quote\": 13.98,\n \"wait_min\": 10,\n \"wait_max\": 15\n}"}],"_postman_id":"dc3bb413-fd36-4281-b585-e32c9f7c01c7"},{"name":"Get waitlist status","id":"ea870eb3-a214-4c90-9573-aaa314b212fe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"(Required) Bearer Token
\n","key":"Authorization","value":"Bearer eyJraW...."}],"url":"{{base_gateway_url}}/waitlist/status?merchant_id=12345","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":"(Required) Bearer Token
\n"}],"url":"{{base_gateway_url}}/host/waitlist/queue/{{merchant_id}}?page=1","description":"This endpoint is designed to give merchants detalied information about the status of guests on the waitlist.
\nIn the response, the party_status property can be one of the following:
- \n
‘Called Ahead’
\n- \n
- The party has called ahead. Corresponds to the “Called Ahead” status in the Host App, triggered by the host. \n
\n'Checked In'
\n- \n
- The party has checked in. Corresponds to the “Walk In (Arrived)“ status in the Host App. This is the default status when a party is added to the waitlist in the Host App. \n
\n‘Confirmed’
\n- \n
- The party has a booked reservation and has confirmed their reservation. Corresponds to the “Confirmed” status in the Host App, manually set by the host. \n
\n'Notified'
\n- \n
- The party has been notified via the Host App that their table is ready. It is worth noting that once notified,
party_statuswill always returnNotifiedregardless of status set in the Host App. \n
\n- The party has been notified via the Host App that their table is ready. It is worth noting that once notified,
‘On The Way’
\n- \n
- The party is on the way. Corresponds to the “On The Way” status in the Host App, manually set by the host. \n
\n'Partially Checked In'
\n- \n
- The party is partially checked in. Corresponds to the “Partially Arrived” status in the Host App, manually set by the host. \n
\n‘Reserved’
\n- \n
- The party has a booked reservation. This is the default status when a reservation for a party is created. \n
\n'Unspecified'
\n- \n
- None of the above apply. \n
\n
(Required) Bearer Token
\n"}],"url":"{{base_gateway_url}}/guest/waitlist/:id","description":"This endpoint is designed to give the guests information about their waitlist status. A brand can use this data to pass along to guests.
\nIn the response, the status property can be one of the following:
- \n
WAITING
\n- \n
- If no other conditions are met, this is the status \n
\nCANCELED
\n- \n
- The party has been removed and the reason for removal was a cancellation \n
\nCHECKED_IN
\n- \n
- The party is active, but not yet seated \n
\nSEATED
\n- \n
- The party is active and seated \n
\nFINISHED
\n- \n
- The party is no longer active and has previously been seated \n
\n
This is the party token assigned to the guest upon being added to the waitlist
\n","type":"text/plain"},"type":"any","value":"string","key":"id"}]}},"response":[{"id":"9438df47-f618-4acf-8c40-04fd43ba5bf5","name":"OK","originalRequest":{"method":"GET","header":[{"description":"(Required) Bearer Token","key":"Authorization","value":"Bearer eyJraW...."}],"url":{"raw":"{{base_gateway_url}}/guest/waitlist/:id","host":["{{base_gateway_url}}"],"path":["guest","waitlist",":id"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"party\": {\n \"id\": \"5ksc23mdsa\",\n \"name\": \"John Snow\",\n \"party_size\": 1,\n \"phone\": \"+15551234567\",\n \"email\": \"email@test.com\",\n \"status\": \"WAITING\",\n \"merchant_id\": \"1\",\n \"wait_min\": 0,\n \"wait_max\": 30,\n \"expected_seat_at\": \"2020-05-11T18:45:00-04:00\",\n \"created_at\": \"2020-05-11T18:15:00-04:00\",\n \"updated_at\": \"2020-05-11T18:15:00-04:00\",\n \"deleted_at\": \"fugiat Duis adipisicing qui elit\"\n }\n}"}],"_postman_id":"7fa40de7-5e52-4a32-8e4e-2fb5283cd4f8"},{"name":"Create a waitlist party","id":"3e4eb97d-e2ed-4ab3-bb63-82f44eca95a7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJraW....","description":"(Required) Bearer Token
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"merchant_id\": 273675,\n \"name\": \"Jessica Smith\",\n \"party_size\": 2,\n \"phone\": \"+12025550109\",\n \"email\": \"hello@test.com\",\n \"origin\": \"api\",\n \"notes\": \"Test Note\",\n \"custom_fields\": {\n \"special_request\": [\"Highchair\", \"Wheelchair Accessible\"],\n \"special_occasion\": [\"Birthday\", \"Anniversary\"]\n }\n}"},"url":"{{base_gateway_url}}/guest/waitlist","description":"This endpoint will add a guest to the waitlist for a given merchant (location).
\n","urlObject":{"path":["guest","waitlist"],"host":["{{base_gateway_url}}"],"query":[],"variable":[]}},"response":[{"id":"bb5fad5e-8df7-42a4-9914-9138b7a11625","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJraW....","description":"(Required) Bearer Token"}],"body":{"mode":"raw","raw":"{\n \"merchant_id\": 1,\n \"name\": \"Jessica Smith\",\n \"party_size\": 2,\n \"phone\": \"+12025550109\",\n \"email\": \"hello@test.com\",\n \"origin\": \"api\",\n \"notes\": \"Test Note\",\n \"custom_fields\": {\n \"special_request\": [\"Highchair\", \"Wheelchair Accessible\"],\n \"special_occasion\": [\"Birthday\", \"Anniversary\"]\n }\n}"},"url":"{{base_gateway_url}}/guest/waitlist"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"party\": {\n \"id\": \"42992ec769362bd4\",\n \"uuid\": \"c16244a2-7a42-4422-8a6e-154a52321008\",\n \"name\": \"Jessica Smith\",\n \"party_size\": 2,\n \"phone\": \"+12025550109\",\n \"email\": \"hello@test.com\",\n \"wait_min\": 0,\n \"wait_max\": 5,\n \"merchant_id\": \"1\",\n \"expected_seat_at\": \"2025-03-24T16:47:26-04:00\",\n \"status\": \"WAITING\",\n \"created_at\": \"2025-03-24T16:42:26-04:00\",\n \"updated_at\": \"2025-03-24T16:42:26-04:00\",\n \"deleted_at\": null,\n \"notes\": \"Test Note\",\n \"custom_fields\": {\n \"special_request\": [\n \"Highchair\",\n \"Wheelchair Accessible\"\n ],\n \"special_occasion\": [\n \"Birthday\",\n \"Anniversary\"\n ]\n }\n }\n}"}],"_postman_id":"3e4eb97d-e2ed-4ab3-bb63-82f44eca95a7"},{"name":"Update existing waitlist party","id":"ae904bbb-5546-4d9a-baee-c3c952d7cd91","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer eyJraW....","description":"(Required) Bearer Token
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Jessica Smith\",\n \"party_size\": 2,\n \"phone\": \"+12025550110\",\n // \"status\": \"CHECKED_IN\",\n \"notes\": \"Test Note\",\n \"custom_fields\": {\n \"special_request\": [],\n \"special_occasion\": []\n },\n \"tags\": [],\n \"section_preferences\": [\"0\"]\n}"},"url":"{{base_gateway_url}}/host/guest/waitlist/59f6acbb91156ed3","description":"This endpoint will update a waitlistparty for a given party id.
\nThe id parameter of the URL is required and is the id from the response to the create party endpoint.
(Required) Bearer Token
\n","key":"Authorization","value":"Bearer eyJraW...."}],"url":"{{base_gateway_url}}/guest/waitlist/:id","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":"(Required) identifier returned by POST /guest/waitlist
\n","type":"text/plain"},"type":"any","value":"12345","key":"id"}]}},"response":[{"id":"f14d9e9b-9776-471f-a89b-27687d83c9e7","name":"OK","originalRequest":{"method":"DELETE","header":[{"description":"(Required) Bearer Token","key":"Authorization","value":"Bearer eyJraW...."}],"url":{"raw":"{{base_gateway_url}}/guest/waitlist/:id","host":["{{base_gateway_url}}"],"path":["guest","waitlist",":id"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"party\": {\n \"id\": \"5ksc23mdsa\",\n \"name\": \"John Snow\",\n \"party_size\": 1,\n \"phone\": \"+15551234567\",\n \"email\": \"email@test.com\",\n \"status\": \"WAITING\",\n \"wait_min\": 0,\n \"wait_max\": 30,\n \"expected_seat_at\": \"2020-05-11T18:45:00-04:00\",\n \"created_at\": \"2020-05-11T18:15:00-04:00\",\n \"updated_at\": \"2020-05-11T18:15:00-04:00\",\n \"deleted_at\": \"fugiat Duis adipisicing qui elit\"\n }\n}"}],"_postman_id":"2a82fed5-dcd4-46f1-bf9e-df98df07d476"}],"id":"777a5b62-2bdd-44c4-a322-27a3df1be182","description":"Wisely provides a drop-in HTML snippet to display the Waitlist flow on your website. If you would like to create a more custom experience, our API allows you to perform all of the same actions.
\nUsing this API you will be able to query the current wait time, whether the waitlist has been closed, and create, update, and delete parties. You can also pass any custom fields that are unique to your custom experience.
\nAuthorization
\nThis API will require a OAuth Bearer Token. Omitting the token will result in a 401 Unauthorized Response. See Get Bearer Token for details.
\n","_postman_id":"777a5b62-2bdd-44c4-a322-27a3df1be182","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":"Description
\nUse this request to save order, ticket, and guest data to Wisely.
\nConceptually, an order contains an array of tickets. Each ticket must have a customer object, which represents who ordered the items on the check
\nRate Limit:
Soft limit of 30 requests per second per store.
Request body
\n\n
order (required | object)
\n\n","urlObject":{"path":["pos","orders"],"host":["{{base_gateway_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f0c8094b-1f0e-4536-9e81-1c1a76dbb663"},{"name":"Create Order Bulk","id":"b20241ac-5c32-470a-b301-3eefbb88d10e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"
Description
\nUse this request to save order, ticket, and guest data to Wisely.
\nConceptually, an order contains an array of tickets. Each ticket must have a customer object, which represents who ordered the items on the check
\nRate Limit:
Soft limit of 25 requests per second per store.
Request body
\n\n
order (required | object)
\n\n","urlObject":{"path":["orders","batch"],"host":["{{base_gateway_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"b20241ac-5c32-470a-b301-3eefbb88d10e"}],"id":"568658df-8cb2-4bd4-a129-d5f187ba69fe","description":"
Authorization
\nThis API will require a OAuth Bearer Token. Omitting the token will result in a 401 Unauthorized Response. See Get Bearer Token for details.
\n","_postman_id":"568658df-8cb2-4bd4-a129-d5f187ba69fe","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":"Description
\nUse this request to retrieve a guest's profile.
\nRate Limit:
Soft limit of 30 requests per second per store.
Request body
\n\n
identifiers (required | object)
\n\n
You must pass at least one identifier in whether it is email ,phone or user_uuid.
\nResponse body
\n\n
These fields are not guaranteed to exist.
\n{\n \"user\": {\n \"email_marketing_opt_in\": true,\n \"sms_marketing_opt_in\": true,\n \"program_id\": \"1\",\n \"user_uuid\": \"9792f7a8-87ed-4ed3-840a-0c792c91e53c\",\n \"fname\": \"Example\",\n \"lname\": \"User\",\n \"phone\": \"+15555555555\",\n \"email\": \"sample@email.com\",\n \"company\": \"Olo\",\n \"title\": \"Engineer\",\n \"birth_year\": 1970,\n \"birth_month\": 1,\n \"birth_day\": 1,\n \"anniversary_year\": 1970,\n \"anniversary_month\": 1,\n \"anniversary_day\": 1,\n \"facebook_url\": \"https://facebook.com/profile\",\n \"twitter_url\": \"https://twitter.com/profile\",\n \"instagram_url\": \"https://instagram.com/profile\",\n \"linkedin_url\": \"https://linkedin.com/profile\",\n \"marketing_opt_in\": null,\n \"zipcode\": \"12345\",\n \"updated_ts\": \"123456790123\",\n \"member_id\": \"1\",\n \"pic_url\": \"https://picture.com/picture.png\",\n \"tags\": [\"sample tag 1\", \"sample tag 2\"],\n \"user_selected_merchant_id\": \"123456\",\n \"updated_at\": \"2022-06-06T21:33:19.915Z\",\n \"deleted_at\": null,\n \"created_at\": \"2022-06-06T15:07:58.298Z\",\n \"user_source_id\": 1,\n \"custom_fields\": {\n \"custom field 1\": \"value 1\",\n \"custom field 2\": \"value 2\"\n }\n }\n}\n\nResponse Descriptions
\n","urlObject":{"path":["guest","search"],"host":["{{base_gateway_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"8cfdde00-630d-4fb0-9ef7-b82e5fcc5cf1"},{"name":"Email and SMS opt in","id":"753540bf-6816-4836-bad5-18827e4d49c9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Wisely offers an email and SMS signup form integration from your website or app to feed the Wisely CRM guest data for Marketing Automation email campaigns.
\nNote: This is the endpoint to use for any guest-facing opt in channel. Only this endpoint will trigger the double opt-in confirmation for SMS opt-ins, which is required to be compliant with SMS marketing laws.
\nWhat you need from Wisely:
\n- \n
- Wisely API key \n
- Widget ID for each location \n
Reach out to your CSM or support@getwisely.com for access to the above
\nTechnical Details
\nBefore getting started please note that the following are required to be integers (strings won't work):
\nSMS Opt-in
\nIf you intend to collect phone numbers for SMS marketing purposes, you MUST include a dedicated opt-in check box tied to the \"sms_marketing_opt_in\" body field. Consent for email and SMS are required by law to be two distinct actions by the guest.
\nThe minimum required opt-in copy is as follows:
\n\"By checking this box, you consent to receive text messages sent by an automatic telephone dialing system. Consent to these terms is not a condition of purchase. Message frequency varies.\"
\nPlease consult with you legal team to ensure you're following all applicable laws
\nExample opt-in flow:
\nBoth fname and lname are required, yet we only serve one field called 'name'. why?
\nA: Our web widget form splits the name into first and last name, natively, based on whitespace:
\nfname, lname = name.gsub(/[^0-9A-Za-z]/, ' ').split
However, our API does NOT do any splitting. The first and last name is only split by our frontend code for the Wisely-provided web widget.
\nOur API tests that:
\n- \n
- At LEAST one of fname or lname is filled out \n
- AND that the name doesn't contain any numbers: \n
if((fname.length == 0 && lname.length == 0) || regexnum.test(fname) || regexnum.test(lname)){\n logger.debug(\"this name could be supplied by a bot : \"+fname + ' '+lname)\n res.sendStatus(202)\n return;\n}\n\nI'm getting a 401 Unauthorized Error. Why?
\nCheck that:
\n- \n
- The right wisely API key is being used for that program \n
- The headers are included (PLEASE make sure headers are included) \n
- The request is a POST, not a GET \n
I'm getting a 202 Request Accepted. Why?
\nThis means that request didn't include a first or last name. At LEAST a first name must be provided.
\nCan I send the birthday in one string, like \"11/16/1995\"?
\nNo. It must be parsed into birth_day, birth_month, and birth_year.
\nDoes the phone field input need to be in a particular format?
\nWe use Google’s phone parser on the backend. It should handle any kind of phone input.
\n","urlObject":{"protocol":"https","path":["v2","web","merchant","subscribe"],"host":["loyaltyapi","wisely","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"753540bf-6816-4836-bad5-18827e4d49c9"}],"id":"13466f3c-e45d-4e94-b724-11d0b2cb7cb7","description":"The Guest Profile API can be used to query custom attributes, segment memberships, recently tracked events, and other data available on a Wisely Guest Profile.
\nThe Guest Profiles API can be used to drive one-to-one personalized experiences for your guests across any channel:
\nAuthorization
\nThis API will require a OAuth Bearer Token. Omitting the token will result in a 401 Unauthorized Response. See Get Bearer Token for details.
\n","_postman_id":"13466f3c-e45d-4e94-b724-11d0b2cb7cb7","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":"Identify lets you track changes to a guests profile and add custom properties from any data source. This might include loyalty points or a special VIP indication used by your brand.
Track lets you record any actions your guests perform. Think of this as a list of all touch points a guest has with your brand. This might include online orders, loyalty redemptions, or marketing email engagement events.
To optimize performance, you may also pass events in bulk. This may include both Identity and Track events.
\nEach event must include the type (identify or track). Otherwise the payloads are identical to what is described in Update Guest Identity and Track Guest Events
Each data source will have a unique Source Token that identifies you as a customer as well as the specific source of data. For example, a loyalty provider, POS data, and raw HTTP requests will each have their own token.
\nThis allows us to forward data to specific destinations and intelligently control how identities are merged. Keeping the tokens separate also allows forwarding historical data from a specific source if you choose to switch destination vendors in the future (eg. switching to a different marketing provider)
\nAuthorization
\nThe Data Streams API uses basic authentication. Omitting the token will result in a 401 Unauthorized Response.
\nHTTP Basic Authentication involves username:password, base64 encoded, and prepended with Basic.
In practice for this API, you will take a Source Token, append a colon, and leave the password empty. For example, if your token is abcde12345, you will base64 encode it using format: {sourceToken}: (note the colon and no password value after the colon) to become YWJjZGUxMjM0NTo=. You will then pass this as the authorization header like so:
Authorization: Basic YWJjZGUxMjM0NTo=\n\nWebhooks and Third Party Destinations
\nAll event and identity data captured by the Data Streams API can be forwarded to a destination of your choosing via a POST request to a configurable URL. This data will be sent formatted exactly how the original request was made. See Webhooks for more details.
\nWisely also supports direct integrations to various data destinations like loyalty and marketing providers. This will empower your brand to utilize combined guest data in any platform of your choosing without vendor lock in. Please discuss the integration options with your Wisely CSM.
\nTriggering SMS Double Opt-in Verification
\nThis document outlines how to use the CDP Identify endpoint to have our system (Engage) manage the SMS double opt-in process for your users.
\nBy default, our system assumes that any service sending user data has already handled consent verification. This new metadata flag allows you to delegate the double opt-in verification step to Engage.
\nHow It Works
\nTo control the opt-in behavior, you'll include the sms_opt_in_behavior property within the metadata object of your identify call. This property determines whether Engage sends a verification SMS.
There are two possible values for this property:
\n- \n
\ndouble_verify: Use this value to instruct Engage to send a verification SMS to the user's phone number. The user will have asms_marketing_opt_in: truein their profile but theis_double_verifiedproperty will be set tofalse\n
\nimplicit(Default): If this value is passed, or if thesms_opt_in_behaviorproperty is omitted entirely, Engage assumes you have already collected consent. The user's profile will be immediately updated tosms_marketing_opt_in: trueandis_double_verified: truewithout sending a verification SMS. \n
Best Practices
\n- \n
- Always Include the Phone Number: While the process can succeed without a phone number in the payload (if one already exists on the resolved user profile), we strongly recommend always including the
phonein theidentifiersobject when managing SMS opt-in status. \n
The Party Seated Webhook allows customers to set up a custom endpoint to receive data related to a party and guest when a party is seated. Below is a table that lists all of the properties that are passed through in the payload, their data type, and a brief description. There is also a sample payload below the table.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":"Segment Entered webhook fires when the segment membership process runs every 6 hours.
For a segment to fire a membership event the segment must be a GDP enabled segment via having a label assigned to it or being used in automations. It can also be turned on as GDP enabled via a support ticket to engineering.
Segment Exited webhook fires when the segment membership process runs every 6 hours.
For a segment to fire a membership event the segment must be a GDP enabled segment via having a label assigned to it or being used in automations. It can also be turned on as GDP enabled via a support ticket to engineering.
The Survey Completed Webhook allows customers to set up a custom endpoint to receive data related to a survey and guest when the survey is completed. Below is a table that lists all of the properties that are passed through in the payload, their data type, and a brief description. There is also a sample payload below the table.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":"Webhooks allow Wisely to notify a custom application when events happen. This might include when order data is collected, a guest arrives to pickup their order, or a guest leaves feedback. Wisely simply forwards the data to your endpoint so you can perform any custom logic you'd wish!
\nThe configured Webhook Endpoint must return a 200 response as quickly as possible. Please return a success before performing any complex, time consuming logic on your system.
\nAuthentication
\nThere is no custom authorization or headers sent along with webhooks to your endpoints.
\nRetries
\nWisely will attempt to send each event up to 3 times if we receive a 5xx response. We employ a basic exponential backoff algoritm for retries (eg. 1 second, 4 seconds, 9 seconds)
\nCommon Fields
\n{\n \"event_id\": \"140fa2df-7a3a-4190-9c5f-cfa2c6c6feef\",\n \"event_name\": \"Order Guest Arrived\",\n \"created_at\": \"2021-03-05T13:04:08-07:00\",\n \"data\": {\n ...this will include fields specific to the event type\n }\n}\n\nOnline Ordering Events
\nOrdering events must follow a specific syntax to support special behavior in third party destinations. For example we will hit Iterable's Track Purchase endpoint instead of the standard Track Event endpoint.
Description
\nUse this request to create one or more guest reviews.
\nRate Limit: \nSoft limit of 30 requests per second per store.
\nRequest body
\n\n
reviews (required | array)
\nNote: A review must have at least content or rating.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":"Description
\nUse this request to create a response to a review.
\nRate Limit: \nSoft limit of 30 requests per second per store.
\nRequest body
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":"ID of the review to create a response for.
\n","type":"text/plain"},"type":"any","value":"","key":"review_id"}]}},"response":[],"_postman_id":"c7adcb02-c043-4fa2-8769-551d419963bc"},{"name":"Update Review Response","id":"b4f0196a-93a7-4331-be04-4c37cc71e693","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"response_content\": \"Thank you for dining with us!\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_gateway_url}}/reviews/:review_id/responses/:response_id","description":"Description
\nUse this request to update a response to a review.
\nRate Limit: \nSoft limit of 30 requests per second per store.
\nRequest body
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":"ID of the review this is a reponse to.
\n","type":"text/plain"},"type":"any","value":null,"key":"review_id"},{"id":"4f5d2799-7a96-4ab4-8018-6443b71d16b1","description":{"content":"ID of the response to update.
\n","type":"text/plain"},"type":"any","value":null,"key":"response_id"}]}},"response":[],"_postman_id":"b4f0196a-93a7-4331-be04-4c37cc71e693"}],"id":"0a819c28-f8a9-4538-b4a9-5aafc358e02d","description":"Authorization
\nThis API will require a OAuth Bearer Token. Omitting the token will result in a 401 Unauthorized Response. See Get Bearer Token for details.
\n","_postman_id":"0a819c28-f8a9-4538-b4a9-5aafc358e02d","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":"This is the client id that you've use to generate the bearer token
\n","type":"text/plain"},"type":"any","value":null,"key":"client_id"}]}},"response":[{"id":"61393033-c760-4ee6-8f23-515ae48d955c","name":"Example with client id and data.","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"email\": \"john2@sample.com\",\n \"custom_fields\": {\n \"has_upgrades\": true\n },\n \"phone\": \"+14077445555\",\n \"first_name\": \"Joe\",\n \"last_name\": \"Doe \",\n \"password\": \"password1\",\n \"password_confirm\": \"password1\",\n \"sms_marketing_opt_in\": true,\n \"email_marketing_opt_in\": true\n}","options":{"raw":{"language":"json"}}},"url":"{{base_gateway_url}}/registrations/0oaaym48m43ZqCxAr4558"},"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"16bf8f04-405f-4ce2-8080-7991889e185e"},{"name":"User Self Remove","id":"fadab256-899b-4c43-b09a-53e095f555ef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Behavior
\nThis endpoint enables you to exchange a 3rd party provider token with one for SSO service. We currently support Google, Apple, and Facebook.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":"These API endpoints are deprecated. Contact Olo support if you need additional information.
\nThis collection has all the endpoints to be used for an ROPC grant.
All except the /oauth/token endpoint require a client credentials token from our Get Bearer Token endpoint with the following scope wisely:api:users.manage
This endpoint will retrieve the event names that you can pass into the event_filters request described below. These should be copied exactly because the filter is case sensitive. The results are sorted by count. So the most common event will show up first.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":"This endpoint will retrieve events for a guest based on the event_filters that are provided within the date range requested (see above for details on event_filters). The number of events per query is capped at 100 and defaults to 20. The date range for the query is restricted to the trailing 12 months, and the provided start and end dates in the query will be adjusted based on that requirement. You can provide a sort_direction (\"asc\" or \"desc\") to change the order that you look at events from.
\nYou can query using the user_uuid, phone, or email. Using more than one of these fields will result in them being ANDed together. i.e. \"Retrieve all events for guest with {phone} AND {email}\"
\nThe result has the user_uuid that was requested, an array of the events that match the filters and specified date range, and a search_after value. The search_after value is used in subsequent request bodies to retrieve the next page of events. It'll look something like this:
\n{\n user_uuid: string, // same as the requested user_uuid\n events: [\n {\n \"event\": \"{{event_name}}\",\n \"identifiers\": {\n // identifiers for the guest\n },\n \"properties\": {\n // data associated with event\n },\n \"message_id\": \"0a4080de-9fca-4d29-982a-4ab6340a00d3\",\n \"timestamp\": \"2022-09-21T00:05:33.731Z\",\n \"event_type\": \"TRACK\",\n \"group_id\": \"7389ec8b-cf15-45a8-b009-7d6465eee166\",\n \"event_id\": \"86f8889d-5117-485d-9681-0a219602d4aa\",\n \"source\": {\n \"id\": \"7e58bbe4-37fa-4bf4-a8a8-5b2ef54f4e88\",\n \"name\": \"Wisely CRM\" // the data source for the event\n },\n \"received_at\": \"2022-09-21T00:05:33Z\",\n \"user_uuid\": \"9b2b96c8-724b-45a6-850f-d2c46f6c3926\",\n \"program_id\": \"72\" // the id of the program this event was associated with\n },\n /**\n ...\n \\\\*/\n ],\n \"search_after\": [\n \"2022-09-21T00:05:33.731Z\",\n \"86f8889d-5117-485d-9681-0a219602d4aa\"\n ] // the parameters used for paging above.\n}\n\nThese requests require you to retrieve an access token from the oauth endpoint specified below using your provided client_id and secret.
\n","_postman_id":"8e0d7dfc-f807-4ea9-b7b3-60cdd23851ee","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":"Authorization
\nThis API will require a OAuth Bearer Token. Omitting the token will result in a 401 Unauthorized Response. See Get Bearer Token for details.
\nThis endpoint will retrieve Push Notification messages sent to the guest based on the guest's user_uuid associated with the bearer token.
\nBehavior
\nOnly records that contain an expiration_date that is greater than the time of the HTTP request will be sent back.
Example: the time of the HTTP request is at 9AM UTC on February 1st, 2022.
Record A with an expiration_date value of 8AM UTC on February 1st, 2022 will not be returned. Because it's already expired.
record B with expiration_date value of 10AM UTC on February 1st, 2022 would be returned. Because it's still active
Records are ordered by expiration_date in ascending order.
\nResponse
\n{\n \"history\": [\n {\n \"user_uuid\": \"Type: uuid, the uuid that is associated with the guest\",\n \"delivered_at\": \"Type: datetime in UTC. 2022-08-01T21:09:49.452Z\",\n \"action_id\": \"Type: (nullable) integer, this is the id for the action\",\n \"campaign_id\": \"Type: (nullable) integer, this is the id for the campaign\",\n \"image_url\": \"Type: (nullable) string, url to retrieve the image\",\n \"body\": \"Type: string, body content associated with the automation template or campaign\",\n \"expiration_date\": \"Type: (nullable) datetime in UTC. example: 2022-08-01T21:09:49.452Z\",\n \"name\": \"Type: string, name content associated with the automation template or campaign\",\n \"title\": \"Type: string, title content associated with the automation template or campaign\",\n },\n ],\n }\n\nYou can append an integer value to a query string variable \"limit\". The limit indicates the number of records coming back. By default, it's set to 20 if no value is provided, with a maximum of 50.
\n","type":"text/plain"},"key":"limit","value":"20"}],"variable":[]}},"response":[{"id":"4e116692-2627-4263-8e86-edf3a98a65ba","name":"200","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_gateway_url}}/automations/history/message_type/push_notification?limit=20","host":["{{base_gateway_url}}"],"path":["automations","history","message_type","push_notification"],"query":[{"key":"limit","value":"20","description":"You can append an integer value to a query string variable \"limit\". The limit indicates the number of records coming back. By default, it's set to 20 if no value is provided, with a maximum of 50."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"history\": [\n {\n \"user_uuid\": \"e6bd4faf-ae2f-4719-896a-ee7b40ef5671\",\n \"delivered_at\": null,\n \"action_id\": 437,\n \"image_url\": null,\n \"body\": \"Push notification template body\",\n \"expiration_date\": \"2023-09-24T15:30:00.000Z\",\n \"name\": \"template name\",\n \"title\": \"Push notification template title\"\n },\n {\n \"user_uuid\": \"e6bd4faf-ae2f-4719-896a-ee7b40ef5671\",\n \"delivered_at\": \"2022-08-01T21:09:49.452Z\",\n \"campaign_id\": 12,\n \"image_url\": null,\n \"body\": \"Push notification campaign body\",\n \"expiration_date\": \"2023-09-24T15:30:00.000Z\",\n \"name\": \"campaign name\",\n \"title\": \"Push notification campaign title\"\n }\n ]\n}"},{"id":"c1c4f2ae-7569-4ac5-aea7-adb315b653e3","name":"401","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_gateway_url}}/automations/history/message_type/push_notification","host":["{{base_gateway_url}}"],"path":["automations","history","message_type","push_notification"],"query":[{"key":"limit","value":"10","description":"You can append an integer value to a query string variable \"limit\". The limit indicates the number of records coming back. By default, it's set to 20 if no value is provided, with a maximum of 50.","disabled":true}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"60374e21-9a67-451c-b8ce-6b11c80a64dc"}],"id":"c2a3fc95-8b8d-47c8-9059-5e14ad828e43","_postman_id":"c2a3fc95-8b8d-47c8-9059-5e14ad828e43","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":"Description
\nGet the name and id of all subscriber contact lists from the program that is associated with the token.
\nAuthorization
\nThis API will require a OAuth Bearer Token. Omitting the token will result in a 401 Unauthorized Response. See Get Bearer Token for details.
\nResponse body
\n{\n \"metadata\": {\n \"page\": 1,\n \"page_count\": 1,\n \"per_page\": 25,\n \"total_count\": 1\n },\n \"records\": [\n {\n \"id\": 1,\n \"name\": \"store 1\",\n \"description\": \"For all guests that subscribed to store 1 newsletters\"\n },\n {\n \"id\": 2,\n \"name\": \"MVP guests\",\n \"description\": null\n }\n ]\n}\n\nResponse Descriptions
\nThe metadata object contact values are associated with pagination.
The records object is a collection of contact lists.
(optional) The current page number for this request.
\n","type":"text/plain"},"key":"page","value":"2"},{"description":{"content":"(optional) The total record count for a given page.
\n","type":"text/plain"},"key":"per_page","value":"5"}],"variable":[]}},"response":[{"id":"81742834-3b30-4df8-960e-25cbec9b7c74","name":"200","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer .eyJ2ZXIiOjEsImp0aSI6IkFULjNoS0I0ZHhjWHo5TnE2WVpGWXVmS0kzRmVacUw5bDRSeVMwSk1sT0JRTnciLCJpc3MiOiJodHRwczovL3N0YWdpbmdhdXRoLndpc2VseS5pby9vYXV0aDIvZGVmYXVsdCIsImF1ZCI6ImFwaTovL2RlZmF1bHQiLCJpYXQiOjE2ODU1NjY0OTcsImV4cCI6MTY4NTU3MDA5NywiY2lkIjoiMG9hMTJicDE2eTg5bjJBdkwwaDgiLCJzY3AiOlsid2lzZWx5OnB1YmxpYy1hcGk6Z3Vlc3RzOnByb2ZpbGVzLnJlYWQiLCJ3aXNlbHk6cHVibGljLWFwaTpndWVzdHM6d2FpdGxpc3QucmVhZCIsIndpc2VseTpwdWJsaWMtYXBpOnJlc2VydmF0aW9uczphdmFpbGFiaWxpdHkucmVhZCIsIndpc2VseTpwdWJsaWMtYXBpOmd1ZXN0czpyZXNlcnZhdGlvbnMubWFuYWdlIiwid2lzZWx5OnB1YmxpYy1hcGk6d2FpdGxpc3Q6c3RhdHVzLnJlYWQiLCJ3aXNlbHk6cHVibGljLWFwaTp3YWl0bGlzdDp3YWl0dGltZS5yZWFkIiwid2lzZWx5OnB1YmxpYy1hcGk6Z3Vlc3RzOndhaXRsaXN0Lm1hbmFnZSIsIndpc2VseTpwdWJsaWMtYXBpOmd1ZXN0czpyZXNlcnZhdGlvbnMucmVhZCJdLCJzdWIiOiIwb2ExMmJwMTZ5ODluMkF2TDBoOCIsInByb2dyYW1faWQiOjcyLCJzY29wZSI6Indpc2VseTpwdWJsaWMtYXBpOmd1ZXN0czpwcm9maWxlcy5yZWFkIHdpc2VseTpwdWJsaWMtYXBpOmd1ZXN0czp3YWl0bGlzdC5yZWFkIHdpc2VseTpwdWJsaWMtYXBpOnJlc2VydmF0aW9uczphdmFpbGFiaWxpdHkucmVhZCB3aXNlbHk6cHVibGljLWFwaTpndWVzdHM6cmVzZXJ2YXRpb25zLm1hbmFnZSB3aXNlbHk6cHVibGljLWFwaTp3YWl0bGlzdDpzdGF0dXMucmVhZCB3aXNlbHk6cHVibGljLWFwaTp3YWl0bGlzdDp3YWl0dGltZS5yZWFkIHdpc2VseTpwdWJsaWMtYXBpOmd1ZXN0czp3YWl0bGlzdC5tYW5hZ2Ugd2lzZWx5OnB1YmxpYy1hcGk6Z3Vlc3RzOnJlc2VydmF0aW9ucy5yZWFkIn0.dTCGttGCsCd6I-WY09rkxpHRf2pmpl-skOaGqj3MSgPmauH0sz6RiYmoPeqRktX73i-HKBA_CaCWnaUXYN1xWH5RUr_fP4IoERRiWFyj3W2Hyq16i3j8zNBe3UPN4k3ZiqZlpk_4n3Hb9jRU-KSxHURtWnLq61ppmkyoaB4_CCZo5d1SL7rWsAsLA7kUyuKuzB4hGBp9NHtRa_wZChS5KV41gXEtcQUU6YqBW78kpEEFkYdYow-3XEka369ZpXc_pwSXyVVPjgsSJB8VC6g9KTiwpNacUemp5lC7w0_0Firt4LVmy6djR5a73JsVj0gqvwVlEXPwuCfacNuhcWFQrA","description":"Valid token associated with the program","type":"text"}],"url":{"raw":"{{base_gateway_url}}/guest/contact-lists?page=2&per_page=5","host":["{{base_gateway_url}}"],"path":["guest","contact-lists"],"query":[{"key":"page","value":"2","description":"Optional"},{"key":"per_page","value":"5","description":"Optional"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"metadata\": {\n \"page\": 2,\n \"page_count\": 10,\n \"per_page\": 5,\n \"total_count\": 50\n },\n \"records\": [\n {\n \"id\": 6,\n \"name\": \"contact list 6\",\n \"description\": \"test\"\n },\n {\n \"id\": 7,\n \"name\": \"contact list 7\",\n \"description\": \"test\"\n },\n {\n \"id\": 8,\n \"name\": \"contact list 8\",\n \"description\": \"test\"\n },\n {\n \"id\": 9,\n \"name\": \"contact list 9\",\n \"description\": \"test\"\n },\n {\n \"id\": 10,\n \"name\": \"contact list 10\",\n \"description\": \"test\"\n }\n ]\n}"},{"id":"20ef7631-6ddd-41ea-80a9-b980ffaa2c0e","name":"401","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"invalid","description":"Invalid or missing","type":"text"}],"url":"{{base_gateway_url}}/guest/contact-lists"},"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"Unauthorized"}],"_postman_id":"48895d90-631d-46b1-86c3-08ae4723730d"},{"name":"Upsert Guest","id":"fb2e5d6d-e349-461d-9e10-1cb1643b151d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{heimdall_access_token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"identifiers\": {\r\n \"email\": \"test.user@olo.com\",\r\n \"phone\": \"+12012345678\"\r\n },\r\n \"contact_list_ids\": [\r\n 7\r\n ],\r\n \"guest\": {\r\n \"fname\": \"test\",\r\n \"lname\": \"user\",\r\n \"email_marketing_opt_in\": true,\r\n \"sms_marketing_opt_in\": true\r\n },\r\n \"creation_source\": \"Vendor Services\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{base_gateway_url}}/guest/create","description":"Description
\nUpserts guests into the CRM via email address and adds the guest to the desired contact list(s) via contact_list_ids array. Supports adding a guest to multiple list ids.
\nAuthorization
\nThis API will require a OAuth Bearer Token. Omitting the token will result in a 401 Unauthorized Response. See Get Bearer Token for details.
\nRequest body
\n{\n \"identifiers\": {\n \"email\": \"test.user@olo.com\"\n },\n \"contact_list_ids\": [\n 7\n ],\n \"guest\": {\n \"fname\": \"test\",\n \"lname\": \"user\"\n },\n \"creation_source\": \"Vendor Services\"\n}\n\nRequest Descriptions
\nThe identifiers object contact information to identify the guest. If a guest associated with the identifiers already exists in our system then we will update that guest instead of creating a new one.
The guest object contain data associated with the guest you're creating/updating.
The CustomFields object represent custom field.
The creation_source property
The contact_list_ids property
{\n \"subscriptions\":[\n {\n \"id\":1,\n \"program_id\":72,\n \"segment_id\":1,\n \"name\":\"store 1\",\n \"description\":\"For all guests that subscribed to store 1 newsletters\"\n },\n {\n \"id\":2,\n \"program_id\":72,\n \"segment_id\":2,\n \"name\":\"MVP guests\",\n \"description\":null\n }\n ],\n \"guest\":{\n \"email\":\"hello.world@exmaple.com\",\n \"fname\":\"hello\",\n \"lname\":\"world\",\n \"guest_uuid\":\"e666e1e7-64b1-4430-8c1f-900c6e12d51e\",\n \"phone\": null\n }\n\nResponse Descriptions
\nNote: Not all guest data will be returned in the response even though they were successfully upserted.
\nThe subscriptions object is an array of contact lists that the guest were successfully subscribed to.
Each contact list will have these properties.
\nThe guest object contain data associated with the guest you're creating/updating.
Before You Begin
\nThe URL in this request is what new customers should use as of April, 2025. If you are an existing customer and we have not reached out to you about migrating, please continue using the Deprecated example in this collection
\nOverview
\nUsing your Wisely provided client ID and client secret, you may fetch a refreshed access token. Your credentials carry access to your customer data, so be sure to keep them secret!
Do not share your client_id or client_secret in publicly accessible areas such as GitHub or client-side code.
The access token is a JWT containing the keys token_type, expires_in, access_token, and scope.
You will use the access_token key prefixed with \"Bearer \" in the Authorization header for all requests. Authorization: Bearer eyJraWQiOiIx...
**Please note expires_in indicates that the token is valid for 3600 seconds (1 hour). Please cache your tokens for this duration, and refresh them before they expire.