API Changelogs - Partoo API

📅 Deprecation PolicyEach major change (deprecated section) includes a 6-month grace period before it takes effect.

The date on the left shows when it was announced.
The date in the yellow box shows when it will take effect.

👉 You can find the full list of API breaking changes on this page.

25th March 2026

Custom headers support for webhooks

Added

Custom headers for webhook configurations

You can now define custom HTTP headers to be forwarded with every webhook request, when creating or updating a webhook.Affected endpoints:

POST /v2/webhooks
PATCH /v2/webhooks/{webhook_id}

21th January 2026

Branded dimension and filter for presence analytics keywords

Added

Branded dimension and filter for presence analytics keywords

You can now distinguish between branded and discovery keywords in your Google Business Profile analytics.New dimension:

branded - Shows whether keywords are associated with your brand or are discovery keywords

New filter:

branded=true - Returns only branded keywords (e.g., “Castorama”, “Casto”)
branded=false - Returns only discovery keywords (e.g., “bricolage”, “magasin outillage”)

Affected endpoints:

GET /v2/presence_analytics/keywords

Example usage:

# Get all keywords with branded dimension
GET /v2/presence_analytics/keywords?dimensions=month,keyword,branded&metrics=count,threshold

# Filter only branded keywords
GET /v2/presence_analytics/keywords?dimensions=month,keyword,branded&branded=true&metrics=count,threshold

# Filter only discovery keywords
GET /v2/presence_analytics/keywords?dimensions=month,keyword,branded&branded=false&metrics=count,threshold

Response format:

{
  "keywords": [
    {
      "branded": "branded",
      "keyword": "foo",
      "count": 9001,
      "date": "2022-03-01",
      "bucket": "month"
    },
    {
      "branded": "discovery",
      "keyword": "bar",
      "threshold": 42,
      "date": "2022-03-01",
      "bucket": "month"
    }
  ]
}

This enhancement helps businesses analyze their brand visibility versus generic search performance in Google Business Profile.

1st December 2025

Release of Custom Roles

Deprecated

Update your integrations to remove dependencies on these endpoints before 15th July 2026.

If you are currently using any of the below endpoints or parameters to limit sidebar visibility for users, please migrate to the new Custom Roles system before the specified deprecation date.

Deprecated endpoints

GET /org/{org_id}/business_fields — organization-level business fields (deprecated)
GET /business/{business_id}/business_fields — business-level business fields (deprecated)

Deprecated user parameters

sidebar_pages - deprecated in favor of the new Custom Roles and the permissions model. Seen in:
- POST /v2/user (create user)
- POST /v2/user/{user_id} (update user)

Added

New Custom Roles endpoints

You can now manage Custom Roles for your organization using the following endpoints:

GET /v2/custom_role — List Custom Roles
POST /v2/custom_role — Create Custom Role
GET /v2/custom_role/{custom_role_api_id} — Get Custom Role detail
POST /v2/custom_role/{custom_role_api_id} — Update Custom Role
DELETE /v2/custom_role/{custom_role_api_id} — Delete Custom Role
POST /v2/custom_role/duplicate — Duplicate an existing Custom Role
GET /v2/permissions — List available permissions (used when building custom role permissions)

Updated Endpoints

In addition, user endpoints now accept a custom_role parameter allowing assignment of a Custom Role by its api_id:

custom_role (string) - API identifier of the custom role to assign to a user. Seen in:
- POST /v2/user (create user)
- POST /v2/user/{user_id} (update user)

15th April 2026

Business subscription management endpoints changes

⏰ This is a future deprecation notice These changes will take effect on 15th April 2026. You have time to plan and update your integrations.

Deprecated

Business subscription management endpoints

You are affected if:

You are a provider

The following endpoints are deprecated:

GET /v2/business/{business_id}/subscription
POST /v2/business/{business_id}/subscribe
POST /v2/business/{business_id}/unsubscribe

Use these endpoints instead:

GET /v2/business/{business_id}/plans
POST /v2/business/{business_id}/plans

Update your integrations to remove dependencies on these endpoints before 15th April 2026.

15th January 2026

User fields and image upload changes

⏰ This is a future deprecation notice These changes will take effect on 15th January 2026. You have time to plan and update your integrations.

15th July 2025

User fields and image upload changes

Deprecated

`phone` and `keywords` fields for users

Please note that as of January 15, 2026, these fields will be removed.

The phone and keywords fields in all user-related endpoints are now deprecated and will be permanently removed.

Image message sending via direct upload

Please note that as of January 15, 2026, this change will be applied.

Image messages can no longer be sent using direct file uploads (form-data) through:POST /v2/messagesYou are affected if:

You send messages via the message API on behalf of a business
You upload image messages via direct file upload

Use public URLs to upload images instead. This change harmonizes how media is handled across the API.

30th June 2025

Support for custom messaging channels

Added

Support for custom channels in messaging

You can now send Text messages through custom-defined channels via:POST /v2/custom-channels/{channel_id}/messagesImpacted endpoints:

GET /v2/conversations
GET /v2/conversations/{conversation_id}
EVENT message_created
EVENT message_updated

22nd April 2025

Media support added to messaging

Added

Media messaging support

You can now send and receive:

Audio
Video
Document

Not all channels support all media types.

Channel	Image	Video	Audio	Document
Facebook	✅	✅	✅	✅
Instagram	✅	✅	✅	❌
SMS	❌	❌	❌	❌
WhatsApp	✅	✅	✅	✅

Affected endpoints:

GET /v2/conversations
GET /v2/conversations/{conversation_id}
GET /v2/messages
POST /v2/messages
EVENT message_created
EVENT message_updated

14th February 2025

Webhook configuration and analytics changes

Added

Webhook configuration API

You can now configure webhooks directly from the API or in Settings > Integrations.

Changed

Content-Type enforcement

All POST, PATCH, and PUT requests now require a valid Content-Type header. Default: application/json.

This is a breaking change following webserver upgrades. Review your client integrations.

Removed

`category_gmb_id` and presence analytics

category_gmb_id is removed. Use category_gmb_name instead.
Presence analytics endpoints are removed. Use Profile metrics and Profile keywords endpoints instead.

15th January 2025

Review analytics V1 deprecation and feature migration

Deprecated

Review analytics V1 API

The following endpoints are deprecated:

GET /v2/reviews/stats
GET /v2/reviews/qualitative-evolution
GET /v2/reviews/quantitative-evolution

Use GET /v2/review_analytics/metrics instead.

The properties treated, not_treated, and answer_time are no longer available.

`products` in favor of `features`

We are introducing a more granular feature-based permission system across organizations, businesses, and users.

Changed

Mappings for review analytics

/v2/reviews/stats → ?metrics=average_rating,rating_distribution,reply_time,reviews_count
/v2/reviews/quantitative-evolution → ?dimensions={day|week|month|year}&metrics=reviews_count
/v2/reviews/qualitative-evolution → ?dimensions={day|week|month|year}&metrics=reviews_count,average_rating

New `features` field usage

Organization

Use org_features to get the active features
Use features to list all available features

Business

New field: features
Searchable using features__in and features__notin

User

sidebar_products → sidebar_pages

During the transition, updating sidebar_products may auto-assign features like posts, bulk_modification, diffusion, or presence_analytics depending on organizational access.

Deprecated fields

has_google_post
display_google_post
sidebar_products

15th January 2025

Validation and deprecations for GmbServices and analytics

Changed

Content-Type validation enforced

All POST, PATCH, and PUT requests must now specify a valid Content-Type.

Requests without an appropriate Content-Type header may be rejected.

Removed

GmbServices and presence analytics

category_gmb_id fully removed from GmbServices
Deprecated presence analytics endpoints fully removed

15th October 2024

Business code usage and REPEATABLE_URL deprecation

Added

Store Code identification enabled

Use business codes instead of IDs in endpoints. Example:

curl -H "x-APIKey: ${API_KEY}" --json '{"address_full": "221b Baker Street"}' \
https://api.partoo.co/v2/business/c-LON-HQ

Use the /c- prefix to denote a business code path.

Removed

`REPEATABLE_URL` no longer supported

Replace with Place Action Links:

GET /business/{business_id}/place_action_links
POST /business/{business_id}/place_action_links

15th July 2024

Nullable addresses and DELETE method improvements

Changed

Nullable business address fields

Fields like address, address_full, zipcode, city, lat, and long can return null.

DELETE endpoint body parameters deprecated

force → query param for DELETE /organization
forced_update → force in DELETE /custom-field

All deprecated DELETE body params will be removed by 15th January 2025.

`forced_update` renamed to `force` in PUT

In PUT /custom-field, parameter forced_update is now force.

Security

Webhooks now signed

Webhook requests are signed.

See Webhook Security for verifying signatures.

24th June 2024

Swagger file compliance update

Fixed

Swagger corrections 🎉

Updated Swagger documentation to OpenAPI 3.0 standards.

No API changes were made—your current integrations continue to work.

You can now use auto-generation tools more effectively.

29th February 2024

Publisher error reporting support

Added

Publisher Errors Reporting Endpoint

You can now report and view publisher-specific errors during business edits.

This allows better diagnostics and corrections.

15th July 2023

Rate limiting and presence analytics deprecation

Security

Rate limiting enabled

Limit: 300 requests per minute per organization.

Integrations exceeding limits may be throttled.

Deprecated

Presence analytics endpoints

GET /v2/presence_analytics
GET /v2/presence_analytics/export

Removed

Google Posts insights

Google views and clicks data are no longer available.

Facebook insights still available via GET /v2/posts.

17th April 2023

Messaging APIs released

Added

Messaging APIs released

Support for:

Conversations
Messaging settings
Messages
Webhooks

15th April 2023

Google Post and GmbServices changes

Removed

Google Post endpoints removed

Deprecated in favor of unified /posts.

Changed

`category_gmb_id` fields replaced

With category_gmb_name in:

GET /v2/services/suggestions
GET /v2/business/{business_id}/services
POST /v2/business/{business_id}/free_form_services
POST /v2/business/{business_id}/structured_services

15th October 2022

Category structure updates and endpoint cleanup

Deprecated

Categories endpoint

GET /v2/category/{category_id} → replaced by GET /v2/categories/{category_id}

Changed

Category enhancements

with_names for translated names
with_countries for available countries

Removed

Obsolete integration endpoints

GET /v2/business/{business_id}/integration_status
GET /v2/business/{business_id}/partner_urls
GET /v2/publisher_states/business_info
GET /v2/publisher_states/businesses_info

Use: GET /v2/publisher_states

`template_id` removed from review booster

Affects: POST /v2/review_booster/send_invitation

Templates in use are not affected.

15th July 2022

Address fields and ordering standardization

Changed

Unified search result ordering

All search endpoints now support order_by.

Address field cleanup

address_details deprecated in favor of address_full.

Do not use address_full and address_details together.

15th January 2022

Pagination upgrades and sandbox API change

Added

Pagination support

Use per_page in:

GET /v2/reviews
GET /v2/business/search
GET /v2/user/search

Changed

Sandbox API base URL

New: api.sandbox.partoo.coOld: sandbox.api.partoo.co (deprecated)

Deprecated

Obsolete endpoints

GET /v2/GET street types
GET /v2/GET number supplements

Changed

Category endpoint updates

id is now an integer
gmb_id added to response

14th December 2021

Legacy category ID deprecation

Deprecated

Old category ID format

Use gcid:climbing_gym instead of legacy string IDs.

Use /v2/categories to fetch valid categories.

15th July 2021

Authorization and product deprecations

Removed

Categories search endpoint

Use: GET /v2/categories

Deprecated

API key authorization routes

POST /v2/authorize
GET /v2/authorize/list
POST /v2/authorize/revoke

Use: POST /v2/connection/generate_token

Business fields

clean_name
video
siret
news

Field country now uses a standardized code format.

API

SDK

​Added

​Custom headers for webhook configurations

​Added

​Branded dimension and filter for presence analytics keywords

​Deprecated

​Deprecated endpoints

​Deprecated user parameters

​Added

​New Custom Roles endpoints

​Updated Endpoints

​Deprecated

​Business subscription management endpoints

​Deprecated

​phone and keywords fields for users

​Image message sending via direct upload

​Added

​Support for custom channels in messaging

​Added

​Media messaging support

​Added

​Webhook configuration API

​Changed

​Content-Type enforcement

​Removed

​category_gmb_id and presence analytics

​Deprecated

​Review analytics V1 API

​products in favor of features

​Changed

​Mappings for review analytics

​New features field usage

Organization

Business

User

​Deprecated fields

​Changed

​Content-Type validation enforced

​Removed

​GmbServices and presence analytics

​Added

​Store Code identification enabled

​Removed

​REPEATABLE_URL no longer supported

​Changed

​Nullable business address fields

​DELETE endpoint body parameters deprecated

​forced_update renamed to force in PUT

​Security

​Webhooks now signed

​Fixed

​Swagger corrections 🎉

​Added

​Publisher Errors Reporting Endpoint

​Security

​Rate limiting enabled

​Deprecated

​Presence analytics endpoints

​Removed

​Google Posts insights

​Added

​Messaging APIs released

​Removed

​Google Post endpoints removed

​Changed

​category_gmb_id fields replaced

​Deprecated

​Categories endpoint

​Changed

​Category enhancements

​Removed

​Obsolete integration endpoints

​template_id removed from review booster

​Changed

​Unified search result ordering

​Address field cleanup

​Added

​Pagination support

​Changed

Added

Custom headers for webhook configurations

Added

Branded dimension and filter for presence analytics keywords

Deprecated

Deprecated endpoints

Deprecated user parameters

Added

New Custom Roles endpoints

Updated Endpoints

Deprecated

Business subscription management endpoints

Deprecated

`phone` and `keywords` fields for users

Image message sending via direct upload

Added

Support for custom channels in messaging

Added

Media messaging support

Added

Webhook configuration API

Changed

Content-Type enforcement

Removed

`category_gmb_id` and presence analytics

Deprecated

Review analytics V1 API

`products` in favor of `features`

Changed

Mappings for review analytics

New `features` field usage

Deprecated fields

Changed

Content-Type validation enforced

Removed

GmbServices and presence analytics

Added

Store Code identification enabled

Removed

`REPEATABLE_URL` no longer supported

Changed

Nullable business address fields

DELETE endpoint body parameters deprecated

`forced_update` renamed to `force` in PUT

Security

Webhooks now signed

Fixed

Swagger corrections 🎉

Added

Publisher Errors Reporting Endpoint

Security

Rate limiting enabled

Deprecated

Presence analytics endpoints

Removed

Google Posts insights

Added

Messaging APIs released

Removed

Google Post endpoints removed

Changed

`category_gmb_id` fields replaced

Deprecated

Categories endpoint

Changed

Category enhancements

Removed

Obsolete integration endpoints

`template_id` removed from review booster

Changed

Unified search result ordering

Address field cleanup

Added

Pagination support

Changed

Sandbox API base URL

Deprecated

Obsolete endpoints

Changed

Category endpoint updates