Skip to main content
POST
/
org
Create organization
curl --request POST \
  --url https://api.partoo.co/v2/org \
  --header 'Content-Type: application/json' \
  --header 'x-APIKey: <api-key>' \
  --data '{
  "name": "Fast Retailer",
  "alias": "fast_retailer",
  "max_businesses": 100
}'
{
  "status": "success",
  "org_id": 42,
  "alias": "fast_retailer",
  "max_businesses": 100
}

Authorizations

​
x-APIKey
string
header
required

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

application/json

JSON to create an organization

​
name
string
required

Organization name

Example:

"Fast Retailer"

​
alias
string

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

Example:

"fast_retailer"

​
max_businesses
integer | null

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.

Example:

100

Response

OK

Result object

​
status
enum<string>

Request status

Available options:
success
​
org_id
integer

Organization id

Example:

42

​
alias
string

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

Example:

"fast_retailer"

​
max_businesses
integer | null

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.

Example:

100