{"info":{"_postman_id":"62ff122a-8cf6-459a-981c-8e4fcb0cc345","name":"HiFiveStar API Documentation (Public)","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"description":"","owner":"39259892","collectionId":"62ff122a-8cf6-459a-981c-8e4fcb0cc345","publishedId":"2sAY4rGRL4","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-10-24T22:19:53.000Z"},"item":[{"name":"Client","item":[{"name":"Create new client","id":"438454f1-b7a6-4ea2-9587-82bb495ae7d8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-api-key","value":"YOUR-API-KEY","type":"text"}],"body":{"mode":"raw","raw":"{\n \"seat_name\": \"Client Company Name\",\n \"email\": \"Client user email\",\n \"full_name\": \"Client full name\",\n \"plan_name\": \"The Plan name you want this client to use\"\n}"},"url":"{{api_url}}/public-api/v1.0.0/seat/add","description":"

This call allows you to automatically add a seat and associate it with a new user email.

BODY DESCRIPTION:

seat_name:required, string

The name of the new business you want to add.

email:required, string

Email of the new user: the new user will have access to only this seat. If you want to grant this user access to multiple seats, you have to repeat this call with the same email account.

full_name: optional, string

Full name of the new user you want to give this seat access.

plan_name: optional, string

The plan name you want to assing to the new client.

If no plan is specified, the \"Default Plan\" will be used. It is recommended to use a custom plan.

country: optional, string

The client's country of origin, which is used to assign default templates within the platform and set the user's communication language.

If no country is specified, the country of your account will be used instead.

RESPONSE DESCRIPTION:

{\n    \"seat_id\": \"\",\n    \"message\": \"\"\n}\n\n

seat_id: string,

It contains the seat ID.

message: optional, string

It contains information about the API call response.

\n","urlObject":{"path":["public-api","v1.0.0","seat","add"],"host":["{{api_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"438454f1-b7a6-4ea2-9587-82bb495ae7d8"},{"name":"Delete existing client","id":"dbc659b3-d0a1-4ad3-ab03-2090dd85716e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-key","value":"YOUR-API-KEY","type":"text"}],"body":{"mode":"raw","raw":"{\n \"email\": \"client_to_delete@email.com\"\n}"},"url":"{{api_url}}/public-api/v1.0.0/seat/remove","urlObject":{"path":["public-api","v1.0.0","seat","remove"],"host":["{{api_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"dbc659b3-d0a1-4ad3-ab03-2090dd85716e"},{"name":"Pause existing client","id":"ac180f12-70af-4c6f-aec4-e54f9f4ddf35","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-key","value":"YOUR-API-KEY","type":"text"}],"body":{"mode":"raw","raw":"{\n \"email\": \"client_to_pause@email.com\"\n}"},"url":"{{api_url}}/public-api/v1.0.0/seat/pause","description":"

Pause a business that was previously active.

\n","urlObject":{"path":["public-api","v1.0.0","seat","pause"],"host":["{{api_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ac180f12-70af-4c6f-aec4-e54f9f4ddf35"},{"name":"Activate existing client","id":"a40d8dcd-c5ea-4734-8290-c17e1a99fcfd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-key","value":"YOUR-API-KEY","type":"text"}],"body":{"mode":"raw","raw":"{\n \"email\": \"client_to_active@email.com\"\n}"},"url":"{{api_url}}/public-api/v1.0.0/seat/activate","description":"

Re-activate a business that was previously paused.

\n","urlObject":{"path":["public-api","v1.0.0","seat","activate"],"host":["{{api_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a40d8dcd-c5ea-4734-8290-c17e1a99fcfd"},{"name":"Switch client client","id":"8366922f-1001-4a59-84f1-542d97276b7b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-key","value":"YOUR-API-KEY","type":"text"}],"body":{"mode":"raw","raw":"{\n \"email\": \"client_to_switch_custom_plan@email.com\",\n \"plan_name\": \"The name of the Plan you want your client to switch to\"\n}"},"url":"{{api_url}}/public-api/v1.0.0/seat/custom-plan","description":"

Switch the custom plan linked to a specific user.

\n","urlObject":{"path":["public-api","v1.0.0","seat","custom-plan"],"host":["{{api_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"8366922f-1001-4a59-84f1-542d97276b7b"}],"id":"753fdeb9-2866-4518-a124-79c495fe7f6e","description":"

This endpoint is for our HiFiveStar Enterprise accounts and will allow you to create a new client, with a new user email associated.

Best practices:

Do not add yourself or an admin user, as you will get an error.
\n
If you try to add a user whose email is already in our app but associated with a different account, you will get an error.
\n
Make sure you use all the required parameters before making this call.
\n

Note that if you want to add more clients to one of your users you can do it by calling this endpoint with a different seat name and the same email address.

\n","_postman_id":"753fdeb9-2866-4518-a124-79c495fe7f6e"},{"name":"Invitation","item":[{"name":"Send SMS","id":"ce074b8c-552a-4ee5-85a4-1d1c03d543ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-api-key","value":"YOUR-API-KEY","type":"text"}],"body":{"mode":"raw","raw":"{\n \"seat_id\":\"Seat ID\",\n \"phone\": \"Phone number\",\n \"name\": \"Name\"\n}"},"url":"{{api_url}}/public-api/v1.0.0/invitation/send/sms","description":"

This endpoint allows you to automatically send out invitations via SMS using the default template present on the seat's account. If reminders are activated, they will automatically be sent.

BODY DESCRIPTION:

seat_id:required, string

The seat ID of the client.

phone:required, string

Phone number to which the SMS will be sent.

e.g. +39xxxxxxxxxx

name: required, string
Full name of the person to which the SMS will be sent.

RESPONSE DESCRIPTION:

{\n    \"status\": \"\",\n    \"name\": \"\",\n    \"destination\": \"\",\n}\n\n

status: string,

Can be \"Ok\" or \"Send Error\".

name: string

Full name.

destination: string

Phone number.

\n","urlObject":{"path":["public-api","v1.0.0","invitation","send","sms"],"host":["{{api_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ce074b8c-552a-4ee5-85a4-1d1c03d543ec"},{"name":"Send Email","id":"33f7f6dc-b4c8-41a7-ae48-cf7ab7a8be02","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-api-key","value":"YOUR-API-KEY","type":"text"}],"body":{"mode":"raw","raw":"{\n \"seat_id\":\"Seat ID\",\n \"email\": \"Email\",\n \"name\": \"Name\"\n}"},"url":"{{api_url}}/public-api/v1.0.0/invitation/send/email","description":"

This endpoint allows you to automatically send out invitations via Email using the default template present on the seat's account. If reminders are activated, they will automatically be sent.

BODY DESCRIPTION:

seat_id:required, string

The seat ID of the client.

email:required, string

Email to which the Email will be sent.

name: required, string
Full name of the person to which the Email will be sent.

RESPONSE DESCRIPTION:

{\n    \"status\": \"\",\n    \"name\": \"\",\n    \"destination\": \"\",\n}\n\n

status: string,

Can be \"Ok\" or \"Send Error\".

name: string

Full name.

destination: string

Email.

\n","urlObject":{"path":["public-api","v1.0.0","invitation","send","email"],"host":["{{api_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"33f7f6dc-b4c8-41a7-ae48-cf7ab7a8be02"}],"id":"c171682c-2fc0-4541-8f8b-848691acc6fa","_postman_id":"c171682c-2fc0-4541-8f8b-848691acc6fa","description":""}]}