PApartoo
Organizations

Create organization

This endpoint lets you create an organization. You have WRITE access on your provider (ie. only possible if you have PROVIDER role).

post/org

Request

Request body

namestring required

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

status'success'

Request status

org_idinteger

Unique identifier of an organization in Partoo.

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 response

{
  "org_id": 42,
  "alias": "fast_retailer",
  "max_businesses": 100
}

Changes

No recorded changes to this operation across all 2 revisions of this API.