Businesses
- GETSearch for businesses
- GETGet completion rate stats from your businesses
- GETStatistics for your connected businesses
- POSTCreate business
- GETBusiness information
- POSTUpdate business
- DELDelete business
- GETAdditional data for your business
- POSTSet additional data for your business
- GETGoogle attributes for your business
- POSTSet Google attributes for your business
- GETMore hours for your business
- POSTSet more hours for your business
- GETGoogle Services for your business
- DELDelete Google Services for your business
- POSTSet Google Services for your business
- POSTSet custom Google Services for your business
- GETGoogle Food Menus for your business
- POSTSet Google Food Menus for your business
- DELDelete Google Food Menus for your business
- GETGet Place Action Links
- POSTSet Place Action Links
- GETSubscriptions for your businessdeprecated
- POSTSubscribe a businessdeprecated
- POSTUnsubscribe a businessdeprecated
Business Fields
Messages
Custom Channels
Message Reply Templates
Messaging Settings
Custom Fields
Custom Fields Section
Custom Roles
Groups and Sections
Holidays
Organizations
Place Action Links
Reviews
- GETSearch for reviews
- PUTUpdate a review
- POSTPost a reply to a review
- PUTModify a reply to a review
- DELDelete the given reply to a review
- GETSearch for review reply templates
- GETAll available placeholders
- POSTCreate a review reply template
- DELDelete a review reply template
- GETFetch AI reply suggestion for reviews
Review analytics
Review Booster
Subscriptions
Users
Feedback Management
Webhooks
Lead received
This event is triggered when a Lead is added in Partoo Database.
The event payload contains the event type and the lead contents.
Authorizations
The authentication system on Partoo API is using API Key that should be put in the header of the request (the name of the header is x-APIKey). An api_key is linked to a user. This user's role will give you different access level to the API features.
Body
lead_received Show child attributes
Show child attributes
The identifier for the webhook configuration.
1
The source of the lead, how we retrieved it.
"chatbot"
An ISO 8601 date-time string representing the webhook creation date.
"2024-11-27T16:10:44.929678Z"
The identifier of the chatbot that collected the lead
1
Name of the chatbot that collected the lead
"Jim"
Name of the business related to the lead
"Partoo"
Store code of the business related to the lead
"Partoo123"
Show child attributes
Show child attributes
1
The lead field type. OPT-IN type is a BOOLEAN type
TEXT, NUMBER, EMAIL, PHONE_NUMBER, BOOLEAN, OPT_IN "TEXT"
name of the field collected
"Your firstname"
value of the field corresponding to the lead
"John"
Response
Return a 200 status to indicate that the event was properly received
Was this page helpful?