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
New business created
This event is triggered when a Business is created in Partoo Database.
The event payload contains the event type and the business 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
business_created Show child attributes
Show child attributes
Partoo App Business
Show child attributes
Show child attributes
Business id
"5409c35a97bbc544d8e26737"
Timestamp (in seconds) of the business creation
1409925979.5
Timestamp (in seconds) of the business last modification. It doesn’t take into account changes to the Custom Fields or related objects.
1561335111.681374
The unique store code of the business. If not provided, it will be automatically generated
"CS-75019"
Defines the current status of the business. open indicates the business is up and running. closed means that the business has definitely closed. temporarily_closed means that the business is temporarily closed, it is advised when your business is closed for more than one week, otherwise use the specific_hours
open, closed, temporarily_closed "open"
The organization unique identifier at Partoo. During onboarding, Partoo creates an organization where all your businesses will be aggregated
42
List of Group ID of the business.
Groups the business belongs to.
[1, 2, 3]
The name of the business (POI) as it will appear on the publishing platforms
1"Corner shop"
Business address. This fields returns the same value as the field address_full for historical reasons. You should prefer the use address_full.
Full address of the business.
For example : 130 Rue du Mont-Cenis.
"12 bis rue du coquelicot"
Complement of address. Any additional information that could help better find the business location
The city where the business is located
"Paris"
Zipcode (or postal code) for the business address. Can be empty if the business' country does not require one.
"75019"
The region where the business is located. Can be empty, it is only useful for some countries like Italy or Spain among others.
"Ile-de-France"
Business country - In the ISO 3166 alpha2 code format (i.e. use “FR” for France instead of "fr")
"FR"
Business default language - it either corresponds to the country's default language or set as English by default
"fr"
The opening hours of the business (in its timezone).
Opening hours are specified per weekday. This is done by supplying an object mapping weekdays ("monday", "tuesday", etc.) to a list of strings. These strings in turn represent time slots during which the business is open.
For example, the following value would set the opening hours to between 08:00-15:00 in the afternoon and 18:00-23:00 in the evening on Mondays:
{"monday": ["08:00-15:00", "18:00-23:00"]}
To indicate that a business is open 24 hours for a specific weekday, use the value ["00:00-23:59"].
❗ This field is not mandatory, but if not provided then the business will not be pushed on some platforms (example: Google).
If provided, then a schedule needs to be sent for each day in particular.
Show child attributes
Show child attributes
Open in the morning and in the evening [10:00-14:00, 18:00-00:00]. Closed the whole day []
Time window
["10:00-14:00"]
Open in the morning and in the evening [10:00-14:00, 18:00-00:00]. Closed the whole day []
Time window
["10:00-14:00"]
Open in the morning and in the evening [10:00-14:00, 18:00-00:00]. Closed the whole day []
Time window
["10:00-14:00"]
Open in the morning and in the evening [10:00-14:00, 18:00-00:00]. Closed the whole day []
Time window
["10:00-14:00"]
Open in the morning and in the evening [10:00-14:00, 18:00-00:00]. Closed the whole day []
Time window
["10:00-14:00"]
Open in the morning and in the evening [10:00-14:00, 18:00-00:00]. Closed the whole day []
Time window
["10:00-14:00"]
Open in the morning and in the evening [10:00-14:00, 18:00-00:00]. Closed the whole day []
Time window
["10:00-14:00"]
Exceptional opening or closing times for the business (in its timezone).
All exceptional days of the year, including temporarily closed, can be specified beforehand or on the go. For example:
- Beforehand: bank holidays (like Christmas or Labor Day)
- Unpredicted: COVID-19 exceptional situation
Specific hours are defined by two values:
open, containing a list of days with exceptional opening hoursclose, containing a list of days where the business is exceptionally closed all day
These values in turn contain:
starts_atindicating the first date for which the exceptional hours are validends_atindicating the last date (inclusive) for which the exceptional hours are validopen_hours(only used for days with exceptional opening hours) indicating the actual time slots for the given period, following the same pattern as the time slots inopen_hours
Show child attributes
Show child attributes
A short description of the business.
⚠️ It is limited to 80 characters
"lorem ipsum"
A more detailed description of the business.
⚠️ It is limited to 750 characters
"lorem ipsum dolor sit amet"
The business own website url or the main url of the company.
"https://www.corner-shop.co/"
Business Facebook page url
"https://www.facebook.com/the-corner-shop"
Business twitter page url
"https://www.twitter.com/the-corner-shop"
Id of Google Location to which the business is linked
Id of Facebook Location to which the business is linked
The National Identification Number of the business.
It describes a unique number for which the business is registered in a specific country.
For example, in France, it's the SIRET code, or for Ireland, it's the CRO.
Business LOGO URL
Specify how the clients can reach the persons in charge of the business in case they have questions.
Show child attributes
Show child attributes
Contact full name
"Hubert Bonisseur de la Bath"
Contact email
Contact phone numbers - Preferably in the format E.164 ('+33302060628' instead of '0302060628')
["+33302060628"]
Contact fax
"+33302060629"
Business photos
Each business can have one or more photos associated
Show child attributes
Show child attributes
The logo image of the brand. On Google, for example, for businesses that have their basic information (phone number, hours, etc.), the Business Profile will highlight the logo.
The business's main photo URL. On Google, for example, it represents the cover photo on the top of the profile.
Additional photos that can highlight the features of the business.
Latitude pushed on publishers. Decimals are separated by a dot and not by a comma.
-3.585993
Longitude pushed on publishers. Decimals are separated by a dot and not by a comma.
47.870341
Business product subscriptions. Deprecated, use features instead.
Show child attributes
Show child attributes
{
"presence_management": { "active": true },
"review_management": { "active": true },
"review_booster": { "active": false },
"messages": { "active": false }
}
List of business' features.
Business feature name
diffusion, feedback_management, messages, posts, review_invite, review_management [
"business_edition",
"diffusion",
"review_management",
"review_invite",
"messages"
]
Business videos URLs
Business SIRET (for french businesses)
The completion rate percentage of the business.
The completion rate is calculated based on how many fields are filled for the business.
If some necessary fields are not filled, it will lower the completion rate.
⚠️ After the update of the business, it may take up to 24 hours for this field to be updated.
77
Show child attributes
Show child attributes
Promo title
Promo description
Promo start timestamp
Promo end timestamp
Promo term of use
Promo additional informations
Promo images to be displayed
Promo URL
URL of the website
Response
Return a 200 status to indicate that the event was properly received
Was this page helpful?