# Partoo API ## Docs - [API key information](https://developers.partoo.co/api-reference/apikeys/api-key-information.md): Given an API key ID, this endpoint gives you information about one key. - [Create API key](https://developers.partoo.co/api-reference/apikeys/create-api-key.md): This endpoint lets you create a new API key. - [List user API keys](https://developers.partoo.co/api-reference/apikeys/list-user-api-keys.md): This endpoint lets you list all the API keys you have access to. - [Revoke API key](https://developers.partoo.co/api-reference/apikeys/revoke-api-key.md): This endpoint lets you revoke an API key you have access to. - [Update API key](https://developers.partoo.co/api-reference/apikeys/update-api-key.md): This endpoint lets you update an API key you have access to. - [Business fields configuration for a business](https://developers.partoo.co/api-reference/business-fields/business-fields-configuration-for-a-business.md): **⚠️ DEPRECATED** This endpoint is deprecated in favor of the new Custom Roles system; for migration information, see the [Custom Roles & Permissions guide](/guides/api/guides/custom-roles-and-permissions). This endpoint gives you the list of all the fields that are available for a given Business.… - [Business fields configuration for an organization](https://developers.partoo.co/api-reference/business-fields/business-fields-configuration-for-an-organization.md): **⚠️ DEPRECATED** This endpoint is deprecated in favor of the new Custom Roles system; for migration information, see the [Custom Roles & Permissions guide](/guides/api/guides/custom-roles-and-permissions). This endpoint provides the list of all fields available for a given organization. For each fi… - [Additional data for your business](https://developers.partoo.co/api-reference/businesses/additional-data-for-your-business.md): This endpoint lets you access to the additional data of business. You need to have `READ`access on this business. - [Business information](https://developers.partoo.co/api-reference/businesses/business-information.md): This endpoint lets you access to the information of a business. You need to have `READ`access on this business. - [Create business](https://developers.partoo.co/api-reference/businesses/create-business.md): This API allows the creation of a new business in the context of your organization. - [Delete business](https://developers.partoo.co/api-reference/businesses/delete-business.md): This endpoint lets you delete a business. You need to have `WRITE`access on this business. - [Delete Google Food Menus for your business](https://developers.partoo.co/api-reference/businesses/delete-google-food-menus-for-your-business.md): This endpoint allows you to delete the Google Food Menus for your business. - [Delete Google Services for your business](https://developers.partoo.co/api-reference/businesses/delete-google-services-for-your-business.md): This endpoint allows you to delete the Google Services set for your business. - [Get completion rate stats from your businesses](https://developers.partoo.co/api-reference/businesses/get-completion-rate-stats-from-your-businesses.md): This endpoint works in the same way as the [operation/searchBusinesses](/api-reference/businesses/search-for-businesses) endpoint, but instead of returning data on all returned businesses, this endpoint returns completion rate statistics aggregated across all businesses. - [Get Place Action Links](https://developers.partoo.co/api-reference/businesses/get-place-action-links.md): Retrieve a list of place action links for a given business_id. Only the available gmb_id links for the business are returned in the GET request. Additionally, the business must be connected to a Google location. For more details, refer to the [Partner Connection](https://app.partoo.co/settings/pl… - [Google attributes for your business](https://developers.partoo.co/api-reference/businesses/google-attributes-for-your-business.md): This endpoint allows you to view the **Google attributes** set for your business. - [Google Food Menus for your business](https://developers.partoo.co/api-reference/businesses/google-food-menus-for-your-business.md): This endpoint allows you to view the Google Food Menus set for your business. - [Google Services for your business](https://developers.partoo.co/api-reference/businesses/google-services-for-your-business.md): This endpoint allows you to view the Google Services set for your business. - [More hours for your business](https://developers.partoo.co/api-reference/businesses/more-hours-for-your-business.md): This endpoint allows you to view the **More Hours** set for your business. - [Search for businesses](https://developers.partoo.co/api-reference/businesses/search-for-businesses.md): This lets you search among the businesses you have `READ` access to. You can use several filters. The response is paginated (30 results per page). - [Set additional data for your business](https://developers.partoo.co/api-reference/businesses/set-additional-data-for-your-business.md): This endpoint lets you set additional data on a business. You need to have `WRITE` access on this business. Additional is a flat object with at most 10 keys. - [Set custom Google Services for your business](https://developers.partoo.co/api-reference/businesses/set-custom-google-services-for-your-business.md): This endpoint allows you to set or update custom Google Services for your business. - [Set Google attributes for your business](https://developers.partoo.co/api-reference/businesses/set-google-attributes-for-your-business.md): This endpoint allows you to set **Google attributes** for your business. - [Set Google Food Menus for your business](https://developers.partoo.co/api-reference/businesses/set-google-food-menus-for-your-business.md): This endpoint allows you to set or update Google Food Menus for your business. - [Set Google Services for your business](https://developers.partoo.co/api-reference/businesses/set-google-services-for-your-business.md): This endpoint allows you to set or update Google Services for your business. When you set a service of type STRUCTURED_SERVICE_ITEM for a category, every category that have this service available will also have it set for them. - [Set more hours for your business](https://developers.partoo.co/api-reference/businesses/set-more-hours-for-your-business.md): This endpoint allows you to set the **More Hours** for your business. - [Set Place Action Links](https://developers.partoo.co/api-reference/businesses/set-place-action-links.md): This endpoint enables you to manage place action links for a given business. Create, update, or delete place action links by modifying the urls array for each gmb_id. - Create: Include a place action link in urls without an id. - Update: Include the given place action link in urls with an existing… - [Statistics for your connected businesses](https://developers.partoo.co/api-reference/businesses/statistics-for-your-connected-businesses.md): This endpoint lets you access the number of businesses connected to different platforms. - [Subscribe a business](https://developers.partoo.co/api-reference/businesses/subscribe-a-business.md): ⚠️ This endpoint is deprecated. Please use the new endpoint [`/business/{business_id}/plans`](/api-reference/subscriptions/update-businesss-plans) instead. ⚠️ - [Subscriptions for your business](https://developers.partoo.co/api-reference/businesses/subscriptions-for-your-business.md): ⚠️ This endpoint is deprecated. Please use the new endpoint [`/business/{business_id}/plans`](/api-reference/subscriptions/update-businesss-plans) instead. ⚠️ - [Unsubscribe a business](https://developers.partoo.co/api-reference/businesses/unsubscribe-a-business.md): ⚠️ This endpoint is deprecated. Please use the new endpoint [`/business/{business_id}/plans`](/api-reference/subscriptions/update-businesss-plans) instead. ⚠️ - [Update business](https://developers.partoo.co/api-reference/businesses/update-business.md): This endpoint lets you access to the information of a business. You need to have `WRITE` access on this business. Only indicated values are taken into account (it works like a `PATCH`). You cannot push fields disabled for your org. - [Category information](https://developers.partoo.co/api-reference/categories/category-information.md): This endpoint lets you retrieve the data of a specific category. - [List Partoo categories](https://developers.partoo.co/api-reference/categories/list-partoo-categories.md): This endpoint lets you read and filter through Partoo categories. - [Suggested additional categories](https://developers.partoo.co/api-reference/categories/suggested-additional-categories.md): This endpoint lets you retrieve Partoo's suggestions for additional categories, based on a given category. - [Check connection token](https://developers.partoo.co/api-reference/connection-tokens/check-connection-token.md): This endpoint lets you check the status of a connection token. To be able to check a connection token of a user, you need to have `WRITE` access on that user. - [Generate connection token](https://developers.partoo.co/api-reference/connection-tokens/generate-connection-token.md): This endpoint lets you generate a connection token to authenticate a user without having to indicate its credentials. To be able to generate a connection token for a user, you need to have `WRITE` access on that user and that user cannot have `PROVIDER` role. A connection token is valid only once an… - [Revoke connection token](https://developers.partoo.co/api-reference/connection-tokens/revoke-connection-token.md): This endpoint lets you revoke a connection token. To be able to revoke a connection token for a user, you need to have `WRITE` access on that user and the connection token must be valid (not expired, not revoked and not consumed). - [Ingest message](https://developers.partoo.co/api-reference/custom-channels/ingest-message.md): This endpoint lets you ingest messages in conversations that use custom channels. When called, it creates a new message in the specified conversation. If the conversation does not exist, the endpoint will automatically create the conversation before adding the message. - [Create custom field sections](https://developers.partoo.co/api-reference/custom-fields-section/create-custom-field-sections.md): This endpoint enables you to create custom field sections for your organization. You can specify a name, optional description, slug, and order. If no order is provided, it will be set to max(all current sections orders) + 1. `PROVIDER` users can pass `org_id` to create custom field sections for a ma… - [Delete custom field section](https://developers.partoo.co/api-reference/custom-fields-section/delete-custom-field-section.md): This endpoint enables you to delete a specific custom field section of your organization. All custom fields in the section will be moved to no section (section_id = null). `PROVIDER` users can pass `org_id` to delete custom field sections for a managed organization. - [Get custom field sections](https://developers.partoo.co/api-reference/custom-fields-section/get-custom-field-sections.md): Retrieve list of custom fields sections for a given organization, including their names, descriptions, slugs, and ordering information. - [Update custom field sections](https://developers.partoo.co/api-reference/custom-fields-section/update-custom-field-sections.md): This endpoint enables you to update a specific custom field section of their organization. You can update the name, description, and slug of the section. `PROVIDER` users can pass `org_id` to update custom field sections for a managed organization. - [Create custom fields](https://developers.partoo.co/api-reference/custom-fields/create-custom-fields.md): This endpoint enables you to create custom fields for your organization. You can specify the field name, description, slug, type-specific constraints, order, and optionally assign it to a section. `PROVIDER` users can pass `org_id` to create custom fields for a managed organization. - [Delete custom field](https://developers.partoo.co/api-reference/custom-fields/delete-custom-field.md): This endpoint enables you to delete a specific custom field of your organization by specifying its ID. Use the `force` parameter to delete fields that have values assigned to businesses. `PROVIDER` users can pass `org_id` to delete a custom field for a managed organization. - [Get custom fields](https://developers.partoo.co/api-reference/custom-fields/get-custom-fields.md): This endpoint enables you to get custom fields for your organization, including their names, descriptions, types, constraints, section associations, and slugs. - [Order custom fields](https://developers.partoo.co/api-reference/custom-fields/order-custom-fields.md): This endpoint enables you to reorganize the order of custom fields and custom field sections within your organization. You can also move custom fields between sections by specifying a different section_id. `PROVIDER` users can pass `org_id` to reorder custom fields for a managed organization. - [Update custom field](https://developers.partoo.co/api-reference/custom-fields/update-custom-field.md): This endpoint enables you to update a specific custom field of your organization by specifying its ID. You can update the **name**, **description**, **slug**, **constraints**, and **section assignment** of the custom field. However, the **type** of a custom field cannot be modified. Use the `force`… - [Create Custom Role](https://developers.partoo.co/api-reference/custom-roles/create-custom-role.md): This endpoint enables you to create custom roles for organizations within your scope. - [Delete Custom Role](https://developers.partoo.co/api-reference/custom-roles/delete-custom-role.md): This endpoint enables you to delete custom roles for organizations within your scope. - [Duplicate Custom Role](https://developers.partoo.co/api-reference/custom-roles/duplicate-custom-role.md): Duplicate a Custom Role. A new Custom Role with (almost) the same `name` and `api_id`, and identical `description` and `permissions` will be created in your organization. - [Get Custom Role](https://developers.partoo.co/api-reference/custom-roles/get-custom-role.md): Get the details of a specific Custom Role. - [Get Custom Roles switch status](https://developers.partoo.co/api-reference/custom-roles/get-custom-roles-switch-status.md): Get the current status of the organization's switch to Custom Roles. This endpoint returns information about whether the organization has switched to Custom Roles and whether they are allowed to switch. - [Get Permissions](https://developers.partoo.co/api-reference/custom-roles/get-permissions.md): This endpoint will give you all of the permissions available to your organization. The permissions are categorized by section, and by subsection. The permissions available to your organization are based on the plans your organization subscribes to; and thus the features included in those plans. - [List Custom Roles](https://developers.partoo.co/api-reference/custom-roles/list-custom-roles.md): Get all Custom Roles for your organization. - [Switch to Custom Roles](https://developers.partoo.co/api-reference/custom-roles/switch-to-custom-roles.md): Update the organization's Custom Roles switch status. This endpoint allows you to enable or disable the Custom Roles feature for the organization, provided the organization is allowed to make this change. - [Update Custom Role](https://developers.partoo.co/api-reference/custom-roles/update-custom-role.md): Update a Custom Role, allowing you to set the `name`, `api_id`, `description`, and `permissions` of an already existing Custom Role. - [Feedback analytics metrics](https://developers.partoo.co/api-reference/feedback-analytics/feedback-analytics-metrics.md): **⚠️ This feature is available only for organisations subscribed to Feedback Management. ⚠️** - [Fetch AI reply suggestion for feedback results](https://developers.partoo.co/api-reference/feedback-management/fetch-ai-reply-suggestion-for-feedback-results.md): The Feedback Management API is currently in **BETA**, therefore the following endpoints are subject to modification, given a **2 week notice**. - [Reply to a feedback result](https://developers.partoo.co/api-reference/feedback-management/reply-to-a-feedback-result.md): The Feedback Management API is currently in **BETA**, therefore the following endpoints are subject to modification, given a **2 week notice**. - [Search for feedback forms](https://developers.partoo.co/api-reference/feedback-management/search-for-feedback-forms.md): The Feedback Management API is currently in **BETA**, therefore the following endpoints are subject to modification, given a **2 week notice**. - [Search for feedback results](https://developers.partoo.co/api-reference/feedback-management/search-for-feedback-results.md): The Feedback Management API is currently in **BETA**, therefore the following endpoints are subject to modification, given a **2 week notice**. - [Update a feedback form](https://developers.partoo.co/api-reference/feedback-management/update-a-feedback-form.md): The Feedback Management API is currently in **BETA**, therefore the following endpoints are subject to modification, given a **2 week notice**. - [Complete Google Location Verification Process](https://developers.partoo.co/api-reference/google/complete-google-location-verification-process.md): This endpoint completes the Google location verification process identified by `google_location_id`. It requires authentication and authorization with at least the role of `BUSINESS_MANAGER`. - [Details on a specific Google Location](https://developers.partoo.co/api-reference/google/details-on-a-specific-google-location.md): Returns a Google location object that corresponds to the given google_location_id. The google_location_id is a unique identifier on Partoo for each location. This endpoint requires authentication, and only authorized users with the appropriate permissions can access it. - [Fetch Google Location Verification Options](https://developers.partoo.co/api-reference/google/fetch-google-location-verification-options.md): This endpoint retrieves verification options for a specific Google location identified by `google_location_id`. It requires authentication and authorization to access. The user must have at least the role of a `BUSINESS_MANAGER` to use this endpoint. - [List Google Attributes](https://developers.partoo.co/api-reference/google/list-google-attributes.md): Get all Google Attributes available for a Category in a given language. ⚠️ **What are Google Attributes?** Google Attributes are highly visible statements about your business that appear on your Google listing. They indicate things like Payment Options, Amenities, Accessibility and Highlights.… - [List Google more hours](https://developers.partoo.co/api-reference/google/list-google-more-hours.md): ⚠️ **What are Google More Hours?** More Hours is a feature in *Google* that allows the business owner to display hours for specific services available. Examples of such services include opening hours for the kitchen, for breakfast, for happy hour, etc. Notice that the available More Hour IDs vary… - [List Google Services](https://developers.partoo.co/api-reference/google/list-google-services.md): Get all Google Services available for your business categories. ⚠️ **What are Google Services?** Google Services are highly visible statements about your business that appear on your Google listing. They indicate the different services available for your business, to which you can a… - [Search for Google locations](https://developers.partoo.co/api-reference/google/search-for-google-locations.md): Performs a search for Google locations based on the provided query parameters. This endpoint requires authentication, and only authorized users with the appropriate permissions can access it. - [Start Google Location Verification Process](https://developers.partoo.co/api-reference/google/start-google-location-verification-process.md): This endpoint initiates the verification process for a specific Google location identified by `google_location_id`. It requires authentication and authorization to access. The user must have at least the role of a `BUSINESS_MANAGER` to use this endpoint. - [Create Group and set businesses](https://developers.partoo.co/api-reference/groups-and-sections/create-group-and-set-businesses.md): Create a new group. This endpoint allows `Group Managers` to create new groups within the system. For more information about the group system, see [the Groups and Sections description](/guides/api/resources/organizations/groups). ⚠️ You must specify which businesses are part of the group using the… - [Create Section](https://developers.partoo.co/api-reference/groups-and-sections/create-section.md): Create a new section. This endpoint endpoint let's you create a new section. Only Group Managers and above can use this endpoint. Business Managers are restricted from accessing this endpoint. For more information about the group system, see [the Groups and Sections description](/guides/api/res… - [Delete Group](https://developers.partoo.co/api-reference/groups-and-sections/delete-group.md): Delete a group. This endpoint endpoint let's you delete an existing group. Only Group Managers and above can use this endpoint. Business Managers are restricted from accessing this endpoint. For more information about the group system, see [the Groups and Sections description](/guides/api/resourc… - [Delete Section](https://developers.partoo.co/api-reference/groups-and-sections/delete-section.md): Delete a section. This endpoint endpoint let's you delete an existing section. Only Group Managers and above can use this endpoint. Business Managers are restricted from accessing this endpoint. For more information about the group system, see [the Groups and Sections description](/guides/api/r… - [Get Group](https://developers.partoo.co/api-reference/groups-and-sections/get-group.md): Get a group and it's associated business IDs. For more information about the group system, see [the Groups and Sections description](/guides/api/resources/organizations/groups). - [Get Section by ID](https://developers.partoo.co/api-reference/groups-and-sections/get-section-by-id.md): Get a single section. For more information about the group system, see [the Groups and Sections description](/guides/api/resources/organizations/groups). - [Get Sections](https://developers.partoo.co/api-reference/groups-and-sections/get-sections.md): Get all the sections for an organization. For more information about the group system, see [the Groups and Sections description](/guides/api/resources/organizations/groups). - [Update Group and set businesses](https://developers.partoo.co/api-reference/groups-and-sections/update-group-and-set-businesses.md): Update a group. This endpoint allows you to modify the details of an existing group within the system. Only `Group Managers` and higher roles can use this endpoint. `Business Managers` are restricted from accessing it. For more information about the group system, see [the Groups and Sections des… - [Update Section](https://developers.partoo.co/api-reference/groups-and-sections/update-section.md): Update the name of a section. This endpoint endpoint let's you update an existing section. Only Group Managers and above can use this endpoint. Business Managers are restricted from accessing this endpoint. For more information about the group system, see [the Groups and Sections description](/… - [Get holidays](https://developers.partoo.co/api-reference/holidays/get-holidays.md): This endpoint allows you to retrieve a list of upcoming bank holidays for a specified country within the next 365 days. The holidays are ordered based on their occurrence dates. - [Create message template](https://developers.partoo.co/api-reference/message-reply-templates/create-message-template.md): This endpoint lets you create a new message template. - [Delete message template](https://developers.partoo.co/api-reference/message-reply-templates/delete-message-template.md): This endpoint lets you delete a message template given its ID. - [List message templates](https://developers.partoo.co/api-reference/message-reply-templates/list-message-templates.md): This endpoint retrieves the list of message templates for the current user's organization. - [Update message template](https://developers.partoo.co/api-reference/message-reply-templates/update-message-template.md): This endpoint allows updating an existing message template by its ID. - [Conversation information](https://developers.partoo.co/api-reference/messages/conversation-information.md): This endpoint returns all information on a specific Conversation. - [List conversations](https://developers.partoo.co/api-reference/messages/list-conversations.md): This endpoint lets you list all the Conversations you have access to. - [List messages](https://developers.partoo.co/api-reference/messages/list-messages.md): This endpoint lets you retrieve the messages for a specific conversation. - [Read conversation](https://developers.partoo.co/api-reference/messages/read-conversation.md): This endpoint lets you mark a conversation as read. It will be set for the user that performs the request ("is_read" may have different values for different users). - [Retry send message](https://developers.partoo.co/api-reference/messages/retry-send-message.md): This endpoint let you retry sending a message that has failed to be sent. - [Send message](https://developers.partoo.co/api-reference/messages/send-message.md): This endpoint allows you to send a message as a business, in an existing conversation. - [Update conversation](https://developers.partoo.co/api-reference/messages/update-conversation.md): Please use POST /conversations/{conversation_id}/read or PATCH /conversations/{conversation_id} instead. - [Update conversation](https://developers.partoo.co/api-reference/messages/update-conversation-1.md): This endpoint lets you change the status of the conversation to "open"/"closed" or to assign it to a user. ⚠️ You can only perform one action at a time: either change the status or assign a user. - [List messaging settings](https://developers.partoo.co/api-reference/messaging-settings/list-messaging-settings.md): This endpoint lets you list all the Messaging Settings you have access to. - [Update messaging settings](https://developers.partoo.co/api-reference/messaging-settings/update-messaging-settings.md): This endpoint lets you update a specific Messaging Settings. - [Create organization](https://developers.partoo.co/api-reference/organizations/create-organization.md): This endpoint lets you create an organization. You have `WRITE` access on your provider (ie. only possible if you have `PROVIDER` role). - [Delete organization](https://developers.partoo.co/api-reference/organizations/delete-organization.md): This endpoint lets you delete an organization. You need to have `WRITE` access on your provider. When an organization gets deleted all the resources linked to it are deleted (users and businesses). If the organization still has businesses or users, it would raise an error if you do not indicate `for… - [Organization information](https://developers.partoo.co/api-reference/organizations/organization-information.md): This endpoint lets you retrieve all the detail about a specific organization. You need to have `READ` access to this organization. - [Search for organizations](https://developers.partoo.co/api-reference/organizations/search-for-organizations.md): This endpoint lets you search for organizations using filters. The response is paginated (30 results per page). - [Update organization](https://developers.partoo.co/api-reference/organizations/update-organization.md): This endpoint lets you update the information of an organization. You need to have `WRITE` access on the organization. - [Get Place Action Links](https://developers.partoo.co/api-reference/place-action-links/get-place-action-links.md): Retrieve a list of available place action links. - [Create a post](https://developers.partoo.co/api-reference/posts/create-a-post.md): This endpoint lets you create a post or a draft post on Google / Facebook / Instagram. - [Delete a post](https://developers.partoo.co/api-reference/posts/delete-a-post.md): This endpoint lets you delete a post. - [Search for post](https://developers.partoo.co/api-reference/posts/search-for-post.md): This endpoint lets you browse through all your posts. - [Update a post](https://developers.partoo.co/api-reference/posts/update-a-post.md): This endpoint lets you update a post. - [Profile keywords for your business](https://developers.partoo.co/api-reference/presence-analytics/profile-keywords-for-your-business.md): This endpoint lets you view the monthly **Google Business Profile** search keywords for all your businesses subscribed to Presence Management. - [Profile metrics for your business](https://developers.partoo.co/api-reference/presence-analytics/profile-metrics-for-your-business.md): This endpoint lets you view the **Google Business Profile** analytics for all your businesses subscribed to **Presence Management**. The API allows you to select what data you're interested in, and how you want it aggregated (daily, monthly, by business, etc). You can also filter the results to limi… - [Get diffusion errors for a business](https://developers.partoo.co/api-reference/presence/get-diffusion-errors-for-a-business.md): Get diffusion errors for a given business. - [PublisherErrors (DEPRECATED)](https://developers.partoo.co/api-reference/presence/publishererrors-deprecated.md): ⚠️ **DEPRECATED** - Please use [`POST /diffusion_errors/{business_id}`](/api-reference/presence/get-diffusion-errors-for-a-business) instead. - [PublisherStates](https://developers.partoo.co/api-reference/presence/publisherstates.md): Method to retrieve businesses diffusions states on publishers. - [Get Review metrics](https://developers.partoo.co/api-reference/review-analytics/get-review-metrics.md): **⚠️ This feature is available only for businesses subscribed to Review Management. ⚠️** - [Global reviews statistics](https://developers.partoo.co/api-reference/review-analytics/global-reviews-statistics.md): This endpoint let you view the global reviews statistics for all your businesses subscribed to **Review Management**. - [Qualitative evolution](https://developers.partoo.co/api-reference/review-analytics/qualitative-evolution.md): This endpoint lets you view the qualitative evolution of the **reviews rating** for all of your businesses subscribed to **Review Management**. The API returns the reviews average rating by bucket (time range). - [Quantitative evolution](https://developers.partoo.co/api-reference/review-analytics/quantitative-evolution.md): This endpoint lets you view the quantitative evolution of the **number of reviews** for all of your businesses subscribed to **Review Management**. The API returns the cumulative sum of the number of reviews by bucket (time range) selected overtime. - [Search for an invitation matching a set of criteria](https://developers.partoo.co/api-reference/review-booster/search-for-an-invitation-matching-a-set-of-criteria.md): This endpoint allows to fetch previously sent invitations. Your access token must be for an user subscribed to the Review Booster product to access this route. The user must have access to the business. This can be useful to avoid sending multiple invitations to the same user in a defined period. - [Send a review invitation](https://developers.partoo.co/api-reference/review-booster/send-a-review-invitation.md): This endpoint lets you send an SMS to a customer to help them leave a message on Google. You need to have `WRITE` access on the business. You can add `invite_content` in your payload to customize the SMS content that will be received by the recipient. Otherwise, the template associa… - [Set the expeditor name of a business](https://developers.partoo.co/api-reference/review-booster/set-the-expeditor-name-of-a-business.md): This endpoint lets you set the expeditor name of a business. An expeditor name is the name of the sender used to send the message. It will be seen instead of the phone number on the destination phone. An expeditor name's length must be between 3 and 11 characters. No special characters are allowed… - [Template for a user](https://developers.partoo.co/api-reference/review-booster/template-for-a-user.md): This endpoint lets you get your corresponding template. If no template exists for the user, a template is created and sent back. You need to be subscribed to the Review Booster product. - [The expeditor name of a business](https://developers.partoo.co/api-reference/review-booster/the-expeditor-name-of-a-business.md): This endpoint lets you get the expeditor name of a business. An expeditor name is the name of the sender used to send the message. It will be seen instead of the phone number on the destination phone. Your business must be subscribed to the Review Booster product. - [The status of a review invitation](https://developers.partoo.co/api-reference/review-booster/the-status-of-a-review-invitation.md): This endpoint allows to get the status about an invitation sent through the Review Booster. Your access token must be for a user subscribed to the Review Booster. The invitation id must be for a business for which the user has access to. - [Update the template of a user](https://developers.partoo.co/api-reference/review-booster/update-the-template-of-a-user.md): This endpoint lets you update the template associated with the user. 3 placeholders are available for the template: `${client_name}`, `${business_name}`, and `${url}`. There are 2 main constraints: - `${url}` must be present in the template sent. - The text should not contain more than 250 chara… - [All available placeholders](https://developers.partoo.co/api-reference/reviews/all-available-placeholders.md): This endpoint lets you access available placeholders for reply review templates. A template placeholder is a dynamically updated word within the Partoo app depending on the context. - [Create a review reply template](https://developers.partoo.co/api-reference/reviews/create-a-review-reply-template.md): This endpoint lets you create a review reply template. - [Delete a review reply template](https://developers.partoo.co/api-reference/reviews/delete-a-review-reply-template.md): This endpoint lets you delete a review reply template given its id. - [Delete the given reply to a review](https://developers.partoo.co/api-reference/reviews/delete-the-given-reply-to-a-review.md): This endpoint lets you delete the reply to a review - [Fetch AI reply suggestion for reviews](https://developers.partoo.co/api-reference/reviews/fetch-ai-reply-suggestion-for-reviews.md): The AI reply suggestion is a service that generates a response to a review based on the review content. - [Modify a reply to a review](https://developers.partoo.co/api-reference/reviews/modify-a-reply-to-a-review.md): This endpoint lets you modify a given reply to a review. - [Post a reply to a review](https://developers.partoo.co/api-reference/reviews/post-a-reply-to-a-review.md): This endpoint lets you reply to a given review. - [Search for review reply templates](https://developers.partoo.co/api-reference/reviews/search-for-review-reply-templates.md): This endpoint lets you browse through all your reply review templates. - [Search for reviews](https://developers.partoo.co/api-reference/reviews/search-for-reviews.md): This endpoint lets you search for the reviews of your businesses. - [Update a review](https://developers.partoo.co/api-reference/reviews/update-a-review.md): Update the state of a review to treated/not_treated - [Get Business's plans](https://developers.partoo.co/api-reference/subscriptions/get-businesss-plans.md): This endpoint lets you retrieve the business's plans.
You need to be a Provider to access this endpoint. - [Get Organization's plans](https://developers.partoo.co/api-reference/subscriptions/get-organizations-plans.md): This endpoint lets you retrieve the organization's plans. You need to be a Provider to access this endpoint. - [Update business's plans](https://developers.partoo.co/api-reference/subscriptions/update-businesss-plans.md): This endpoint lets you update the plans of a business.
You need to be a Provider to access this endpoint.
⚠️You need to send all the plans, those not sent will be removed. We advise you to call the GET endpoint first. ⚠️ - [Update organization's plans](https://developers.partoo.co/api-reference/subscriptions/update-organizations-plans.md): This endpoint lets you update the plans of an organization. You need to be a Provider to access this endpoint. ⚠️ You need to send **all the plans**, those not sent will be removed. We advise you to call the GET endpoint first. ⚠️ - [Create user](https://developers.partoo.co/api-reference/users/create-user.md): This endpoint lets you create a user. If no password given, a password will automatically be generated. - [Delete user](https://developers.partoo.co/api-reference/users/delete-user.md): This endpoint lets you delete a user. You need to have `WRITE` access to this user. - [Invite user](https://developers.partoo.co/api-reference/users/invite-user.md): This endpoint lets you trigger a new invitation email to an `invited` user. You need to have `WRITE` access to this user. The email can only be sent once every 5 minutes. - [My user](https://developers.partoo.co/api-reference/users/my-user.md): This endpoint lets you retrieve all the information about your user - [Search for users](https://developers.partoo.co/api-reference/users/search-for-users.md): This endpoint lets you search for users using filters - [Set user preferences](https://developers.partoo.co/api-reference/users/set-user-preferences.md): This endpoint lets you update all the information about a user's preferences on notifications. You need to have `WRITE` access to this user. - [Update user](https://developers.partoo.co/api-reference/users/update-user.md): This endpoint lets you update a user. You need to have `WRITE` access to this user. It has a patch behaviour which means that only indicated value will be changed. - [User businesses](https://developers.partoo.co/api-reference/users/user-businesses.md): This endpoint lets you retrieve the list of businesses which the selected user has `READ` access to. - [User information](https://developers.partoo.co/api-reference/users/user-information.md): This endpoint lets you retrieve all the information on a user. You need to have `READ` access to this users. - [User preferences](https://developers.partoo.co/api-reference/users/user-preferences.md): This endpoint lets you retrieve all the information about a user's preferences on notifications. You need to have `READ` access to this user. - [Business deleted](https://developers.partoo.co/api-reference/webhooks-events/business-deleted.md): This event is triggered when a Business is removed from Partoo Database. - [Business updated](https://developers.partoo.co/api-reference/webhooks-events/business-updated.md): This event is triggered when a Business is updated in Partoo Database. - [Lead received](https://developers.partoo.co/api-reference/webhooks-events/lead-received.md): This event is triggered when a Lead is added in Partoo Database. - [Message created](https://developers.partoo.co/api-reference/webhooks-events/message-created.md): This event is triggered when a conversation has a new message. - [Message updated](https://developers.partoo.co/api-reference/webhooks-events/message-updated.md): This event is triggered if the field of a message is updated (example: `status`, `is_deleted`). - [New business created](https://developers.partoo.co/api-reference/webhooks-events/new-business-created.md): This event is triggered when a Business is created in Partoo Database. - [Review created](https://developers.partoo.co/api-reference/webhooks-events/review-created.md): This event is triggered when a business receives a new review. - [Review reply created](https://developers.partoo.co/api-reference/webhooks-events/review-reply-created.md): This event is triggered when a review has been replied to. - [Review reply deleted](https://developers.partoo.co/api-reference/webhooks-events/review-reply-deleted.md): This event is triggered when a review reply has been deleted - [Review reply updated](https://developers.partoo.co/api-reference/webhooks-events/review-reply-updated.md): This event is triggered when a review reply has been updated. - [Review updated](https://developers.partoo.co/api-reference/webhooks-events/review-updated.md): This event is triggered when a review is updated. This can happen in one of these cases: - One or more attributes of a review have been updated (including a content or rating update from its author) - A tag has been assigned or unassigned to this review on Partoo - A review has been deleted -… - [Create webhook configurations](https://developers.partoo.co/api-reference/webhooks/create-webhook-configurations.md): This endpoint create webhook configurations. - [Delete a webhook configuration](https://developers.partoo.co/api-reference/webhooks/delete-a-webhook-configuration.md): This endpoint deletes a webhook configuration. - [Get a list of webhook configurations](https://developers.partoo.co/api-reference/webhooks/get-a-list-of-webhook-configurations.md): This endpoint returns the list of webhook configurations. - [Get a webhook configuration](https://developers.partoo.co/api-reference/webhooks/get-a-webhook-configuration.md): This endpoint returns the details of a webhook configuration. - [List available webhook events](https://developers.partoo.co/api-reference/webhooks/list-available-webhook-events.md): This endpoint returns the list of the webhook events available to the organization, depending on the subscribed products. - [Send test webhook payloads](https://developers.partoo.co/api-reference/webhooks/send-test-webhook-payloads.md): This endpoint let you try webhook configurations by sending test payloads. This currently supports only one webhook configuration per request, entries after the first one will be ignored. Payloads are created by the latest data of the specified event type, or if not available a default pay… - [Update a webhook configuration](https://developers.partoo.co/api-reference/webhooks/update-a-webhook-configuration.md): This endpoint updates a webhook configuration. - [Breaking Changes](https://developers.partoo.co/changelogs/api/breaking-changes.md): This page provides information about breaking changes to the API. - [API Changelogs](https://developers.partoo.co/changelogs/api/changelogs.md): These release notes list changes to Partoo. - [Breaking Changes](https://developers.partoo.co/changelogs/sdk/breaking-changes.md): This page provides information about breaking changes to the SDK. - [SDK Changelogs](https://developers.partoo.co/changelogs/sdk/changelogs.md): New updates and improvements - [Errors](https://developers.partoo.co/guides/api/getting-started/api-fundamentals/errors.md) - [Overview](https://developers.partoo.co/guides/api/getting-started/api-fundamentals/index.md): Core concepts and best practices for using the Partoo API securely and efficiently. - [Rate Limiting](https://developers.partoo.co/guides/api/getting-started/api-fundamentals/rate-limits.md): Understand and manage API rate limits to ensure reliable access. - [Retry Tips](https://developers.partoo.co/guides/api/getting-started/api-fundamentals/retry-tips.md): Ensure robust integrations with retry logic for rate limits and transient errors. - [Getting Started](https://developers.partoo.co/guides/api/getting-started/getting-started.md): Learn how to obtain API keys, test safely in the Sandbox environment, and promote your integration to Production in Partoo. - [User Roles and Permissions](https://developers.partoo.co/guides/api/getting-started/roles.md): Understand how each Partoo role controls read and write access to API resources. - [Structure](https://developers.partoo.co/guides/api/getting-started/structures.md): Explore the four key personas : Organization, User, Business, and Group to understand how they connect inside the Partoo ecosystem. - [Managing User Permissions with Custom Roles](https://developers.partoo.co/guides/api/guides/custom-roles-and-permissions.md): Learn about Partoo's Custom Roles feature, how to use it in order to manage permissions, including migration notes from our previous system, and examples of REST API usage. - [Display Data From Partoo](https://developers.partoo.co/guides/api/guides/display-data.md): How to securely retrieve and render any Partoo data on a public website using a backend proxy with caching. - [Synchronize your Business to Partoo](https://developers.partoo.co/guides/api/guides/sync-business-to-partoo.md): Learn how to synchronize your Business information from your internal system to Partoo using the API. - [User Provisioning with Partoo API](https://developers.partoo.co/guides/api/guides/user-management.md): Learn how to integrate the Partoo User API to automatically manage user lifecycles create, update, and delete accounts based on your source-of-truth system. - [Categories](https://developers.partoo.co/guides/api/resources/businesses/categories.md): Learn how to effectively use and manage business categories to improve your local search visibility and connect with customers. - [Coordinates](https://developers.partoo.co/guides/api/resources/businesses/coordinates.md): Learn how GPS coordinates work for businesses in the Partoo API and how they're handled across different platforms. - [Custom Fields](https://developers.partoo.co/guides/api/resources/businesses/custom-fields.md): Add and configure your own custom data fields. - [Custom Channels](https://developers.partoo.co/guides/api/resources/messages/custom-channel.md): Connect your own messaging sources like chatbots, CRMs, or internal tools directly to Partoo - [Groups and Sections](https://developers.partoo.co/guides/api/resources/organizations/groups.md): Learn how to organize, filter, and protect your business data in Partoo using Groups, Sections, and role-based access. - [Post Management](https://developers.partoo.co/guides/api/resources/posts/post-management.md): Create and publish engaging content across Google, Facebook, Instagram, and Store Locator to boost your business visibility - [Retrieve Reviews](https://developers.partoo.co/guides/api/resources/reviews/retrieve-reviews.md): Learn how to effectively retrieve and manage reviews from Google, Facebook, and TripAdvisor platforms - [Review Booster](https://developers.partoo.co/guides/api/resources/reviews/review-booster.md): Boost your Google reviews through the Review Booster API - [Security and API Key Usage](https://developers.partoo.co/guides/api/resources/settings/security_and_api_key_usage.md): Keep your Partoo API integration secure by handling keys and environments correctly. - [Activation](https://developers.partoo.co/guides/api/resources/settings/sso/activation.md): Steps to enable SSO functionality for your team - [Configure your Identity Provider](https://developers.partoo.co/guides/api/resources/settings/sso/configuration-idp.md): Set up a Partoo application in your Identity Provider using SAML or OIDC - [Configure SSO within Partoo](https://developers.partoo.co/guides/api/resources/settings/sso/configuration-partoo.md): Connect your Identity Provider to Partoo using metadata or .well-known URL - [FAQ](https://developers.partoo.co/guides/api/resources/settings/sso/faq.md): Frequently asked questions about using Single Sign-On with Partoo - [Overview](https://developers.partoo.co/guides/api/resources/settings/sso/index.md): Understand the key concepts and supported SSO connection types with Partoo - [Test SSO](https://developers.partoo.co/guides/api/resources/settings/sso/test-production.md): Verify your SSO setup and complete the integration for end-users - [API](https://developers.partoo.co/guides/api/resources/settings/webhooks/api.md): Manage webhook subscriptions programmatically using the API." - [Events](https://developers.partoo.co/guides/api/resources/settings/webhooks/events.md): Explore all available webhook events and their payloads. - [Overview](https://developers.partoo.co/guides/api/resources/settings/webhooks/index.md): Learn how to set up and secure webhooks, and explore available event triggers. - [Security](https://developers.partoo.co/guides/api/resources/settings/webhooks/security.md): Secure your webhook integrations with signature verification and shared secrets. - [Setup](https://developers.partoo.co/guides/api/resources/settings/webhooks/setup.md): How to configure and subscribe to webhooks in Partoo. - [Partoo MCP Server](https://developers.partoo.co/guides/mcp/overview.md): Connect AI assistants to the Partoo platform using the Model Context Protocol (MCP) — manage business listings, reviews, messages, posts, and analytics through natural language. - [MCP Tools Reference](https://developers.partoo.co/guides/mcp/tools.md): Complete reference for all 14 tools exposed by the Partoo MCP Server, grouped by category with parameter details. - [Tutorial](https://developers.partoo.co/guides/sdk/getting-started/quickstart.md): Learn how to integrate Partoo into your website using the JavaScript SDK to display embedded views and manage user sessions. - [Authenticate](https://developers.partoo.co/guides/sdk/guides/authenticate.md) - [Events & Callbacks](https://developers.partoo.co/guides/sdk/guides/events-callbacks.md) - [Integration](https://developers.partoo.co/guides/sdk/guides/integration.md): Learn how to integrate and navigate between Partoo pages inside your application using the SDK. - [Partoo SDK Reference](https://developers.partoo.co/guides/sdk/references/reference.md) - [Supported Routes](https://developers.partoo.co/guides/sdk/references/supported-routes.md): Reference of all available Partoo routes, including parameters, view descriptions, and authentication requirements. - [Welcome](https://developers.partoo.co/index.md): Build with the Partoo API v2. Manage locations, reviews, messaging, and more — securely and at scale. - [How to get help?](https://developers.partoo.co/misc/help/how-to-get-help.md): Learn the proper way to ask for help via email, including escalation paths and the required information for faster resolution. - [OpenAPI file](https://developers.partoo.co/misc/help/openapi-download.md): View or download the Partoo REST API OpenAPI specification file in YAML format. ## OpenAPI Specs - [openapi-bundled](https://developers.partoo.co/assets/openapi/openapi-bundled.yaml) - [openapi](https://developers.partoo.co/api-reference/openapi.json) ## Optional - [Status Page](https://status.partoo.co)