Sign in

v1

latestOpenAPI 3.1.0© Copyright Partoo2026-07-26163503484.0 KB
Organizations

Update organization

This endpoint lets you update the information of an organization. You need to have WRITE access on the organization.

post/org/{org_id}

Path parameters

org_idinteger required

Unique ID of the organization to which the resource belongs. Only PROVIDER users can access resources from a different organization than their own. If you are not a PROVIDER, this will default to the ID of your organization.

Request body

namestring

Organization name

aliasstring

Organization alias (should match regex [a-z0-9_])

max_businessesinteger nullable

Maximum number of local businesses the organization can have. It does not include the global (brand) businesses. If null, there is no limit for the organization. This field can only be set by a PROVIDER user.

Example request

{
  "name": "Fast Retailer",
  "alias": "fast_retailer",
  "max_businesses": 100
}

Response

OK

org_idinteger

Unique identifier of an organization in Partoo.

status'success'

Request status

Example response

{
  "org_id": 42
}