Search results for rest api v2 -deprecated

70 articles found

• Rest API Contacts

  Groundhogg provides the /contacts/ endpoint. The contacts endpoint allows users to query the contact table inside the database and let you perform operations on contacts. This endpoint supports GET,

• REST API Errors

  When working with REST APIs, common errors include: Client-Side Errors 1. 400 Bad Request: Malformed JSON, missing/invalid parameters. 2. 401 Unauthorized: Incorrect/missing authentication

• REST API Playground

  The REST API Playground is a state-of-the-art, interactive platform that allows developers to experiment with various REST API endpoints in a controlled and educational setting. It is designed to

• REST API / Authentication

  The REST API Supports three different methods of authentication at this point in time. Groundhogg API Keys WordPress Application Passwords WordPress REST Nonce Groundhogg API Keys To use an API key

• Plugin API REST Endpoint

  You can use the Plugin API REST endpoint as an alternative to the Webhook Listener if the contact has already been registered on your site. You can send a webhook request to this endpoint call_name,

• REST API V4 / Deals

  The deals API lets you fetch, add, edit, and delete deals. Deal Properties Attribute Type Description ID integer The system ID of the deal data object The core properties of the deal contain

• REST API V4 / Notes

  The notes API allows you to fetch, add, edit, and delete notes. Note Properties Attribute Type Description ID integer The system ID of the note data object The core properties of the note containing

• REST API V4 / Contacts

  The contacts API allows you to fetch, add, edit, and delete contacts. Contact Properties Attribute Type Description ID integer The system ID of the contact data object The core properties of the

• REST API V3 / Tags / Delete

  URL DELETE /wp-json/gh/v3/tags Method This endpoint supports the DELETE method. Request To delete a tag you must pass these arguments. PARAM TYPE REQUIRED DESCRIPTION tag_id int yes The ID of the tag

• REST API V3 / Tags / Edit

  URL PUT /wp-json/gh/v3/tags Method This endpoint supports the PUT method. Request This endpoint provides functionality to edit tags. PARAM TYPE REQUIRED DESCRIPTION tag_id int yes ID of a tag that

• REST API V3 / Tags / Create

  URL POST /wp-json/gh/v3/tags Method This endpoint supports the POST method. Request You can create single or multiple tags using this endpoint. PARAM TYPE REQUIRED DESCRIPTION tags array yes Tag

• REST API V3 / SMS / Get

  URL GET /wp-json/gh/v3/sms Method This endpoint supports the GET method. Request You can pass the search string to get SMS with that string. PARAM TYPE REQUIRED DESCRIPTION search string no String to

• REST API V3 / Emails / Send

  URL POST /wp-json/gh/v3/emails/send Method This endpoint supports the POST method. Request This endpoint provides functionality to send email to the contact. PARAM TYPE REQUIRED DESCRIPTION

• REST API V3 / Contact / Get

  URL GET /wp-json/gh/v3/contacts Method This endpoint supports the GET method Request This endpoint provides multiple ways of searching and retrieving contact information. Here are the parameters you

• REST API V3 / Emails / Get

  URL GET /wp-json/gh/v3/emails Method This endpoint supports the GET method. Request You can pass the search string to get SMS with that string. PARAM TYPE REQUIRED DESCRIPTION search string no String

• REST API V3 / Contact / Delete

  URL DELETE /wp-json/gh/v3/contacts Method This endpoint supports the DELETE method. Request To delete a contact record you must pass these arguments. PARAM TYPE REQUIRED EXAMPLE id_or_email string |

• REST API V3 / Tags / Get

  URL GET /wp-json/gh/v3/tags Method This endpoint supports the GET method. Request You can pass the search string to get SMS with that string. PARAM TYPE REQUIRED DESCRIPTION search string no String

• REST API V3 / SMS / Send

  URL POST /wp-json/gh/v3/sms/send Method This endpoint supports the POST method. Request This endpoint provides functionality to send SMS to the contact. PARAM TYPE REQUIRED DESCRIPTION id_or_email

• REST API V3 / Contact / Update

  URL PUT|PATCH /wp-json/gh/v3/contacts Method This endpoint supports PUT or PATCH Request To update a contact record you must pass these arguments. PARAM TYPE REQUIRED EXAMPLE id_or_email string|int

• REST API V3 / Contact / Create

  URI POST /wp-json/gh/v3/contacts Method This endpoint supports the POST method Request You can pass any relevant contact arguments to the contacts endpoint plus additional metadata. PARAM TYPE

• REST API V3 / Tags / Manage

  URL Apply Tags PUT /wp-json/gh/v3/contacts/apply_tags or PUT /wp-json/gh/v3/tags/apply Remove Tags PUT /wp-json/gh/v3/contacts/apply_tags or PUT /wp-json/gh/v3/tags/remove Method This endpoint

• REST API V3 / Contacts / Tags / Get

  URL GET /wp-json/gh/v3/contacts/tags Method This endpoint supports the GET method. Request This endpoint provides functionality to get all the tags applied to the contact. PARAM TYPE REQUIRED

• Elastic Email Integration: Connect email API

  Elastic Email says they can send emails faster and more reliably, you can make use of their REST API within Groundhogg to know yourself. One of the cool things about our integration is that with it,

• SendGrid Integration: Connect to SendGrid with the email API

  Basic SMTP can be slow, so SendGrid has a REST API that can deliver emails much faster! Here is how you use our SendGrid integration (also included in plus plan or above) to deliver emails via the

• Postmark Integration: Connect to Postmark with the email API

  Basic SMTP can be slow, so Postmark has a REST API that can deliver emails much faster! How to setup Postmark Integration (included in plus plan or above) to deliver emails via the Postmark API.

• Benchmark: Plugin API Benchmark

  The Benchmark "Plugin API Benchmark" provides a way to create your own custom benchmark. Drag and drop the "Plugin API Benchmark" Benchmark over into the flow on the left. You will be presented with

• Action: Plugin API Action

  If you would like to create your own custom Action use the Plugin API Action. To add the Plugin API Action to the funnel flow, either click the "+" at the branch and click the Plugin API Action step

• Meta Conversions API Integration: Introduction

  With Groundhogg’s Meta Conversions API Integration, you can send conversion events directly from your funnels to Meta (Facebook) for better tracking, optimization, and retargeting. Follow these steps

• Create your own custom benchmark using the Plugin API

  You could create your own custom benchmark, but as we routinely update the registration flow, and backwards compatibility is not always guaranteed. However, we do provide a future-proof method to

• Getting Started

  Groundhogg provides a REST API that allows users to retrieve data remotely using a JSON format. Using the RESTful API users can manage contacts, emails, SMS and tags remotely. By default, Groundhogg

• Getting Started

  Groundhogg provides a REST API that allows users to retrieve data remotely using a JSON format. Using the RESTful API users can manage contacts, emails, SMS and tags remotely. By default, Groundhogg

• Cloudflare Compatibility

  If you are using Cloudflare, you must make several tweaks so that Groundhogg and other highly dynamic WordPress plugins work as expected. Set Max Browser Cache TTL The max TTL is, "the amount of time

• Caching Compatibility

  If you have a caching plugin (please only use one at a time) or any sort of system caching on your website or may notice Groundhogg not quite working as well and as quickly as you had hoped. There

• Why are tag and email dropdowns not loading?

  If you have just installed Groundhogg and you are unable to select tags or emails from dropdowns it may be because there is an issue with the REST API on your site. This generally happens because of

• Preventing Spam in Web Forms with Google reCaptcha

  If you are experiencing a lot of spam coming through your web forms you can use Google reCaptcha to prevent bots from spamming your forms. How to Setup Google reCaptcha 1. Get your reCaptcha keys

• Backup & Restore: How to restore Groundhogg from a backup

  Need to restore a Groundhogg Backup? Make sure you have the Backup & Restore extension installed. Restore Groundhogg. Go to Groundhogg > Tools > Backup & Restore. At the bottom of the form, select

• AWS Integration: Troubleshooting SMS

  "Invalid parameter" error when sending PROMOTIONAL SMS The reason for the error is that the Sender ID is only configured to send Transactional SMS type. So when you send a Promotional SMS type you

• Content Restriction: Introduction

  Some pages may be designed for a specific audience (such as having a membership site). Due to this, Groundhogg provides the functionality to stop users from viewing certain pages. In order to do

• Restore Missing Funnel Events

  Under Tools > Misc is a utility to Restore missing funnel events. If something happens to the events in a funnel and they get canceled or deleted, this tool will bring back the contacts to where they

• Backup & Restore: How to backup Groundhogg

  The Backup & Restore extension provides a simple way for you to backup Groundhogg safely and restore it without having to make any other changes to your site. Backing up Groundhogg To backup

• Glossary of Terms

  This page provides explanations of terms used throughout our documentation and plugin, listed in alphabetical order. Index A | B | C | D | E | F | G | H | I | J | K | L | M | N | O | P | Q | R | S |

• SendGrid Integration: Create webhook event listener

  SendGrid can send events to your WordPress site which will inform Groundhogg if an email bounced or was marked as spam so that Groundhogg will no longer send emails to problematic contacts. The

• Zapier Integration: Zap listener

  The Zap Listener is a benchmark that can listen for POSTS from Zapier to your site which contains contact information. You can place a Zap Listener anywhere in your funnel, but if the contact does

• SMTP: Connect to Sendgrid

  If you are using SendGrid with the SMTP extension please follow these steps. Navigate to the Email API Screen and select SMTP Relay. Enter an API key name (does not have to be anything specific) and

• Register an additional email service

  Register an additional SendGrid email service that uses a custom API key when the contact is unconfirmed and the email type is marketing. Add this code to your theme's functions.php file or use a

• Really Simple Payments: Collecting PayPal payments

  Note: Really Simple Payments has been discontinued to concentrate on developing smooth and improved integrations with top-tier payment solutions. We have decided to prioritize compatibility with

• ThriveCart Integration: Introduction

  The ThriveCart integration allows you to listen for requests from ThriveCart to start automation in Groundhogg! You will need the ThriveCart Groundhogg extension or need to have the pro plan (or

• Example: Send Broadcast

  Sample code for sending a broadcast via Groundhogg's API. Ensure you have an email set up and its corresponding ID before using this code. <?php // Define your Groundhogg API credentials $api_url =

• AWS Integration: Setup

  AWS is a powerful service that allows you to send both email and SMS directly from your site. Our integration provides several useful features such as... Send emails through SES Send SMS through SNS

• Twilio Integration: Getting started with WhatsApp

  We are pleased to now offer an integration with the WhatsApp Business API via Twilio! This new integration allows limited 2-way communication with your customers via the popular chat app. Getting