Answer a Survey/Form From Your External Website via our API

By leveraging our API, you can customize the front-end of your experience and capture data on your external website.

With our API, you can submit data to our various engines to process the business logic according to your settings.  A great way of putting data in the system is by using our Survey API to submit data to forms.

Start out by setting up a new form in PeopleVine and then create your replicate HTML version of that form (if you search for it, there's an article on how to leverage HAPI to generate a form's HTML).

Once your form is setup, you can now get your API application and credentials ready.  Go to the company menu and click on API Credentials and API Applications to set them up.  Then ensure you have an API user too.  In the end, you should be able to create your AUTH object as such:

API Username – XXXX

API Password – XXXX


Username - XXXX

Password - XXXX

Company_no - XXXX

When looking to submit data to our forms engine, you can reference the API details below: 

API Docs: 


 Sample Object to Include in Answers

{"survey_no": 3402, "survey_field_no": 11798, "survey_answer": "Jane Doe", "response_id": "<GUID>" }

 Sample Call

{"answers": [{"survey_no": 123, "survey_field_no": 567890, "survey_answer": "Jane Doe", "response_id": "<GUID>" },{"survey_no": 1234, "survey_field_no": 678901, "survey_answer": "Sample Company", "response_id": "<GUID>" }], "auth": {"api_username": "", "api_password": "", "api_key": "", "company_no": 0, "username": "", "password": "" } }

 Make sure the response_ID value is the same for all your answers.  This will allow us to group the data into a single response.

When looking to submit data to our CRM, you can reference the API details below:

API Docs: 

API Endpoint:

 "auth": {"api_username": "", "api_password": "", "api_key": "", "company_no": 0, "username": "", "password": "" }, "customer": {"email": "", "mobile_number": "", "first_name": "", "customer_type": "customer", "customer_status": "active", “attributes”: [{“attribute_value”: “Value Here”, “attribute_type”: “Group Name Here”}] } }

 Sample Object

"customer" {
     "email" '',
     "opt_in_email" true,
     "attributes" [{
          "attribute_value" "VALUE HERE",
          "attribute_type" "GROUP NAME HERE"

Additional Help Tutorials

Find more ways to grow on PeopleVine.

Adding Your Member to a Ticket in Toast, Allowing them to Pay from their Phone

Leverage this guide to train your employees how to add a member to a check when using Toast.

Posted October 28, 2020

Troubleshooting Toast - Getting an Error Validating the Loyalty Account

If you're getting an error "Error validating the loyalty account," it is most likely related to a change in the member's profile. Although an unlikely scenario, we wanted to ensure you knew how to handle.

Posted October 28, 2020

Overview of the Integration with Toast POS System and PeopleVine

As we have launched our integration with Toast, we wanted to highlight the overall features and experience.

Posted October 28, 2020

Improvements to the Virtual POS - Tips, Discounts and More

We recently made major updates to the Virtual POS and Commerce engine in an effort to ensure continuity between experiences along with providing better control and reporting on payment details.

Posted October 28, 2020

Setup Access Rules with Public Descriptions in Sevenrooms to Allow Members to Book Specific Areas

You can surface the type of reservation someone is booking by setting up access rules associated with public descriptions.

Posted October 22, 2020

Create a Single Sign On Amongst All Your Sub-Domains on PeopleVine

In the platform settings, you can enable a multi-domain cookie which will carry over member settings into your various sub domain names in PeopleVine.

Posted October 18, 2020

Applying a Discount in the Virtual POS is Easier

You can now apply a % discount or $ discount when taking a payment in the Virtual POS.

Posted October 15, 2020

Setup a Dining Reservation with Specific Tables for Dining or Cocktails

Allow your members to select what type of table they're looking for (e.g. cocktail, hightop, outside, etc.) by providing the table numbers within your dining page.

Posted October 8, 2020

Setup Your Billing to Start on the 1st of the Month (or Year) When Enabling Prorated Billing on the Service

We know you've been able to prorate members for quite some time, but only if you manually set them up. Now members can be automatically prorated depending on when they sign up or are approved.

Posted September 29, 2020

Platform Updates 1st Half September 2020

We thought we'd share some of our notes on what was released so far in September.

Posted September 12, 2020

You Can Set What Gift Certificates are Valid For

When issuing a gift certificate to a person, you have the ability to select what the gift card is valid for. This allows you to issue a gift certificate to utilize for a series of events or a specific appointment type. When purchasing something else, this gift certificate will not be available for use.

Posted September 12, 2020

Answer a Survey/Form From Your External Website via our API

By leveraging our API, you can customize the front-end of your experience and capture data on your external website.

Posted September 10, 2020

Setup a Certificate of Completion, Diploma or Other Important Documents for Your Members After Achieving a Goal

With our image generator + text you have the ability to overlay messages over your existing graphics.

Posted September 9, 2020

Set the Time Tickets Go On Sale and Off Sale, Not Just the Date

You now have the ability to set the time that tickets should go on sale and off sale.

Posted September 4, 2020

Setup an Event and Enable an External Party to Manage the Event

You can enable your partners access to event details without giving them access to the whole platform.

Posted September 4, 2020

© PeopleVine 2020. Powered by PeopleVine. Terms of use | Privacy & cookies