DocsDocsReference

Create a new organization

Creates a new organization with basic details, contact information, and optional addresses. The organization will be assigned a unique ID and timestamps automatically.

POST/api/v1/{team_slug}/{app_slug}/organisations
API
Management
Updated
Apr 26, 2026

management-api:POST:/api/v1/{team_slug}/{app_slug}/organisations

Creates a new organization with basic details, contact information, and optional addresses. The organization will be assigned a unique ID and timestamps automatically.

API ownership

  • API family: Management API
  • Best for: Trusted back-office workflows that create, update, organize, or delete merchant-owned data.
  • Do not use from: Browser-only storefront code or public clients.
  • Guide route: /apis/management/latest

The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation.

Operation

  • Method: POST
  • Path: /api/v1/\{team_slug\}/\{app_slug\}/organisations
  • Summary: Create a new organization
  • Description: Creates a new organization with basic details, contact information, and optional addresses. The organization will be assigned a unique ID and timestamps automatically.
  • OpenAPI contract: management-api
  • Operation ID: Not documented in the OpenAPI contract.

Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID.

Parameters2 parameters
NameInRequiredTypeDescription
app_slugpathYesstringApp slug
team_slugpathYesstringTeam slug
Request bodyDocumented body
  • Required: Yes
  • Description: Organization details
  • Content: application/json (object)

Input Organisation

PropertyTypeRequiredDetails
addressesobject[]No-
commentstringNo-
contact_namestringNo-
credit_checkbooleanNo-
custom_fieldsobjectNo-
customer_group_idsstring[]NouniqueItems
emailstringYes-
external_refstringNo-
invoice_emailstringNo-
namestringYes-
organisation_numberstringNo-
parent_idstringNo-
phonestringNo-
statusenum("active", "pending", "inactive")Yes-
tax_id_vat_numberstringNo-

Input Organisation Address

PropertyTypeRequiredDetails
citystringYes-
co_addressstringNo-
company_namestringYes-
countrystringYes-
house_numberstringNo-
idstringNo-
is_defaultbooleanNo-
namestringNo-
phonestringNo-
postal_codestringYes-
shipping_typeenum("billing", "shipping")Yes-
state_provincestringNo-
street_addressstringYes-

Generated example (synthetic):

{
  "addresses": [
    {
      "city": "string",
      "co_address": "string",
      "company_name": "string",
      "country": "string",
      "house_number": "string",
      "id": "string",
      "is_default": false,
      "name": "string",
      "phone": "string",
      "postal_code": "string",
      "shipping_type": "billing",
      "state_province": "string",
      "street_address": "string"
    }
  ],
  "comment": "string",
  "contact_name": "string",
  "credit_check": false,
  "custom_fields": {},
  "customer_group_ids": [
    "string"
  ],
  "email": "string",
  "external_ref": "string",
  "invoice_email": "string",
  "name": "string",
  "organisation_number": "string",
  "parent_id": "string",
  "phone": "string",
  "status": "active",
  "tax_id_vat_number": "string"
}
Responses5 statuses
StatusDescriptionContent
201Created organizationapplication/json (object)
400Invalid request (e.g. bad payload, validation error, organization number already exists)application/json (object)
401Unauthorized accessapplication/json (object)
404Not foundapplication/json (object)
500Internal server errorapplication/json (object)

201 - object

Organisation With Users And Addresses Response

PropertyTypeRequiredDetails
dataobjectNo-
detailsstring[]NoAdditional contextual information about the response. Used to provide supplementary details beyond the main data payload, such as validation warnings or processing notes
successbooleanNo-
Organisation With Users And Addresses
PropertyTypeRequiredDetails
app_idstringNo-
attributesobject[]No-
billing_addressobject[]No-
commentstringNo-
contact_namestringNo-
created_atstringNo-
credit_checkbooleanNo-
custom_fieldsobjectNo-
customer_groupsobject[]No-
emailstringNo-
external_refstringNo-
idstringNo-
invoice_emailstringNo-
namestringNo-
organisation_numberstringNo-
parent_idstringNo-
phonestringNo-
shipping_addressobject[]No-
statusstringNo-
tagsobject[]No-
tax_id_vat_numberstringNo-
updated_atstringNo-
usersobject[]No-
Attribute
PropertyTypeRequiredDetails
created_atstringNo-
descriptionstringNo-
filterablebooleanNo-
idstringNo-
keystringNo-
namestringNo-
template_keystringNo-
template_namestringNo-
translatablebooleanNo-
translationsobjectNo-
updated_atstringNo-
valuesobjectNo-
Organisation Address
PropertyTypeRequiredDetails
citystringNo-
co_addressstringNo-
company_idstringNo-
company_namestringNo-
countrystringNo-
created_atstringNo-
house_numberstringNo-
idstringNo-
is_defaultbooleanNo-
namestringNo-
phonestringNo-
postal_codestringNo-
state_provincestringNo-
street_addressstringNo-
updated_atstringNo-
Customer Group Ref
PropertyTypeRequiredDetails
idstringNo-
namestringNo-
slugstringNo-
Tag
PropertyTypeRequiredDetails
attributesobject[]No-
created_atstringNo-
filterablebooleanNo-
idstringNo-
keystringNo-
marketsobject[]No-
namestringNo-
schedulesobject[]No-
source_app_idstringNo-
source_idstringNo-
statusstringNo-
translationsobjectNo-
updated_atstringNo-
Organisation User
PropertyTypeRequiredDetails
attributesobject[]No-
created_atstringNo-
custom_role_idstringNo-
custom_role_namestringNo-
custom_role_slugstringNo-
emailstringNo-
email_verifiedbooleanNo-
idstringNo-
languagestringNo-
levelstringNo-
marketstringNo-
namestringNo-
phone_numberstringNo-
store_groupstringNo-
surnamestringNo-
updated_atstringNo-
{
  "data": {
    "app_id": "string",
    "attributes": [
      {
        "created_at": "string",
        "description": "string",
        "filterable": false,
        "id": "string",
        "key": "string",
        "name": "string",
        "template_key": "string",
        "template_name": "string",
        "translatable": false,
        "translations": {
          "description": null,
          "name": null
        },
        "updated_at": "string",
        "values": {}
      }
    ],
    "billing_address": [
      {
        "city": "string",
        "co_address": "string",
        "company_id": "string",
        "company_name": "string",
        "country": "string",
        "created_at": "string",
        "house_number": "string",
        "id": "string",
        "is_default": false,
        "name": "string",
        "phone": "string",
        "postal_code": "string",
        "state_province": "string",
        "street_address": "string",
        "updated_at": "string"
      }
    ],
    "comment": "string",
    "contact_name": "string",
    "created_at": "string",
    "credit_check": false,
    "custom_fields": {},
    "customer_groups": [
      {
        "id": "string",
        "name": "string",
        "slug": "string"
      }
    ],
    "email": "string",
    "external_ref": "string",
    "id": "string",
    "invoice_email": "string",
    "name": "string",
    "organisation_number": "string",
    "parent_id": "string",
    "phone": "string",
    "shipping_address": [
      {
        "city": "string",
        "co_address": "string",
        "company_id": "string",
        "company_name": "string",
        "country": "string",
        "created_at": "string",
        "house_number": "string",
        "id": "string",
        "is_default": false,
        "name": "string",
        "phone": "string",
        "postal_code": "string",
        "state_province": "string",
        "street_address": "string",
        "updated_at": "string"
      }
    ],
    "status": "string",
    "tags": [
      {
        "attributes": [],
        "created_at": "string",
        "filterable": false,
        "id": "string",
        "key": "string",
        "markets": [],
        "name": "string",
        "schedules": [],
        "source_app_id": "string",
        "source_id": "string",
        "status": "string",
        "translations": {
          "name": null
        },
        "updated_at": "string"
      }
    ],
    "tax_id_vat_number": "string",
    "updated_at": "string",
    "users": [
      {
        "attributes": [],
        "created_at": "string",
        "custom_role_id": "string",
        "custom_role_name": "string",
        "custom_role_slug": "string",
        "email": "string",
        "email_verified": false,
        "id": "string",
        "language": "string",
        "level": "string",
        "market": "string",
        "name": "string",
        "phone_number": "string",
        "store_group": "string",
        "surname": "string",
        "updated_at": "string"
      }
    ]
  },
  "details": [
    "string"
  ],
  "success": false
}

400 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

401 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

404 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

500 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

Contract identity

Use these fields to confirm you are implementing the intended endpoint contract.

  • API family: Management API
  • Method: POST
  • Path: /api/v1/\{team_slug\}/\{app_slug\}/organisations
  • Operation ID: Not documented in the OpenAPI contract.
  • OpenAPI tag: Organizations
  • OpenAPI summary: Create a new organization

Create a new organization

# Create a new organization Creates a new organization with basic details, contact information, and optional addresses. The organization will be assigned a unique ID and timestamps automatically.
POST /api/v1/{team_slug}/{app_slug}/organisations
Purpose

Creates a new organization with basic details, contact information, and optional addresses.

Required inputs

app_slug path team_slug path

Primary response

201 ยท Created organization

Operation key

management-api:POST:/api/v1/{team_slug}/{app_slug}/organisations

## API ownership - API family: Management API - Best for: Trusted back-office workflows that create, update, organize, or delete merchant-owned data. - Do not use from: Browser-only storefront code or public clients. - Guide route: [/apis/management/latest](/apis/management/latest) The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation. ## Operation - Method: `POST` - Path: `/api/v1/{team_slug}/{app_slug}/organisations` - Summary: Create a new organization - Description: Creates a new organization with basic details, contact information, and optional addresses. The organization will be assigned a unique ID and timestamps automatically. - OpenAPI contract: management-api - Operation ID: Not documented in the OpenAPI contract. - Stable operation key: `management-api:POST:/api/v1/{team_slug}/{app_slug}/organisations` Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID. ## Parameters | Name | In | Required | Type | Description | | --- | --- | --- | --- | --- | | app_slug | path | Yes | string | App slug | | team_slug | path | Yes | string | Team slug | ## Request body - Required: Yes - Description: Organization details - Content: application/json (object) ### Input Organisation | Property | Type | Required | Details | | --- | --- | --- | --- | | `addresses` | object[] | No | - | | `comment` | string | No | - | | `contact_name` | string | No | - | | `credit_check` | boolean | No | - | | `custom_fields` | object | No | - | | `customer_group_ids` | string[] | No | uniqueItems | | `email` | string | Yes | - | | `external_ref` | string | No | - | | `invoice_email` | string | No | - | | `name` | string | Yes | - | | `organisation_number` | string | No | - | | `parent_id` | string | No | - | | `phone` | string | No | - | | `status` | enum("active", "pending", "inactive") | Yes | - | | `tax_id_vat_number` | string | No | - | #### Input Organisation Address | Property | Type | Required | Details | | --- | --- | --- | --- | | `city` | string | Yes | - | | `co_address` | string | No | - | | `company_name` | string | Yes | - | | `country` | string | Yes | - | | `house_number` | string | No | - | | `id` | string | No | - | | `is_default` | boolean | No | - | | `name` | string | No | - | | `phone` | string | No | - | | `postal_code` | string | Yes | - | | `shipping_type` | enum("billing", "shipping") | Yes | - | | `state_province` | string | No | - | | `street_address` | string | Yes | - | **Generated example (synthetic):** ```json { "addresses": [ { "city": "string", "co_address": "string", "company_name": "string", "country": "string", "house_number": "string", "id": "string", "is_default": false, "name": "string", "phone": "string", "postal_code": "string", "shipping_type": "billing", "state_province": "string", "street_address": "string" } ], "comment": "string", "contact_name": "string", "credit_check": false, "custom_fields": {}, "customer_group_ids": [ "string" ], "email": "string", "external_ref": "string", "invoice_email": "string", "name": "string", "organisation_number": "string", "parent_id": "string", "phone": "string", "status": "active", "tax_id_vat_number": "string" } ``` ## Responses | Status | Description | Content | | --- | --- | --- | | 201 | Created organization | application/json (object) | | 400 | Invalid request (e.g. bad payload, validation error, organization number already exists) | application/json (object) | | 401 | Unauthorized access | application/json (object) | | 404 | Not found | application/json (object) | | 500 | Internal server error | application/json (object) | ### 201 - object #### Organisation With Users And Addresses Response | Property | Type | Required | Details | | --- | --- | --- | --- | | `data` | object | No | - | | `details` | string[] | No | Additional contextual information about the response. Used to provide supplementary details beyond the main data payload, such as validation warnings or processing notes | | `success` | boolean | No | - | ##### Organisation With Users And Addresses | Property | Type | Required | Details | | --- | --- | --- | --- | | `app_id` | string | No | - | | `attributes` | object[] | No | - | | `billing_address` | object[] | No | - | | `comment` | string | No | - | | `contact_name` | string | No | - | | `created_at` | string | No | - | | `credit_check` | boolean | No | - | | `custom_fields` | object | No | - | | `customer_groups` | object[] | No | - | | `email` | string | No | - | | `external_ref` | string | No | - | | `id` | string | No | - | | `invoice_email` | string | No | - | | `name` | string | No | - | | `organisation_number` | string | No | - | | `parent_id` | string | No | - | | `phone` | string | No | - | | `shipping_address` | object[] | No | - | | `status` | string | No | - | | `tags` | object[] | No | - | | `tax_id_vat_number` | string | No | - | | `updated_at` | string | No | - | | `users` | object[] | No | - | ##### Attribute | Property | Type | Required | Details | | --- | --- | --- | --- | | `created_at` | string | No | - | | `description` | string | No | - | | `filterable` | boolean | No | - | | `id` | string | No | - | | `key` | string | No | - | | `name` | string | No | - | | `template_key` | string | No | - | | `template_name` | string | No | - | | `translatable` | boolean | No | - | | `translations` | object | No | - | | `updated_at` | string | No | - | | `values` | object | No | - | ##### Organisation Address | Property | Type | Required | Details | | --- | --- | --- | --- | | `city` | string | No | - | | `co_address` | string | No | - | | `company_id` | string | No | - | | `company_name` | string | No | - | | `country` | string | No | - | | `created_at` | string | No | - | | `house_number` | string | No | - | | `id` | string | No | - | | `is_default` | boolean | No | - | | `name` | string | No | - | | `phone` | string | No | - | | `postal_code` | string | No | - | | `state_province` | string | No | - | | `street_address` | string | No | - | | `updated_at` | string | No | - | ##### Customer Group Ref | Property | Type | Required | Details | | --- | --- | --- | --- | | `id` | string | No | - | | `name` | string | No | - | | `slug` | string | No | - | ##### Tag | Property | Type | Required | Details | | --- | --- | --- | --- | | `attributes` | object[] | No | - | | `created_at` | string | No | - | | `filterable` | boolean | No | - | | `id` | string | No | - | | `key` | string | No | - | | `markets` | object[] | No | - | | `name` | string | No | - | | `schedules` | object[] | No | - | | `source_app_id` | string | No | - | | `source_id` | string | No | - | | `status` | string | No | - | | `translations` | object | No | - | | `updated_at` | string | No | - | ##### Organisation User | Property | Type | Required | Details | | --- | --- | --- | --- | | `attributes` | object[] | No | - | | `created_at` | string | No | - | | `custom_role_id` | string | No | - | | `custom_role_name` | string | No | - | | `custom_role_slug` | string | No | - | | `email` | string | No | - | | `email_verified` | boolean | No | - | | `id` | string | No | - | | `language` | string | No | - | | `level` | string | No | - | | `market` | string | No | - | | `name` | string | No | - | | `phone_number` | string | No | - | | `store_group` | string | No | - | | `surname` | string | No | - | | `updated_at` | string | No | - |
Generated example (synthetic) ```json { "data": { "app_id": "string", "attributes": [ { "created_at": "string", "description": "string", "filterable": false, "id": "string", "key": "string", "name": "string", "template_key": "string", "template_name": "string", "translatable": false, "translations": { "description": null, "name": null }, "updated_at": "string", "values": {} } ], "billing_address": [ { "city": "string", "co_address": "string", "company_id": "string", "company_name": "string", "country": "string", "created_at": "string", "house_number": "string", "id": "string", "is_default": false, "name": "string", "phone": "string", "postal_code": "string", "state_province": "string", "street_address": "string", "updated_at": "string" } ], "comment": "string", "contact_name": "string", "created_at": "string", "credit_check": false, "custom_fields": {}, "customer_groups": [ { "id": "string", "name": "string", "slug": "string" } ], "email": "string", "external_ref": "string", "id": "string", "invoice_email": "string", "name": "string", "organisation_number": "string", "parent_id": "string", "phone": "string", "shipping_address": [ { "city": "string", "co_address": "string", "company_id": "string", "company_name": "string", "country": "string", "created_at": "string", "house_number": "string", "id": "string", "is_default": false, "name": "string", "phone": "string", "postal_code": "string", "state_province": "string", "street_address": "string", "updated_at": "string" } ], "status": "string", "tags": [ { "attributes": [], "created_at": "string", "filterable": false, "id": "string", "key": "string", "markets": [], "name": "string", "schedules": [], "source_app_id": "string", "source_id": "string", "status": "string", "translations": { "name": null }, "updated_at": "string" } ], "tax_id_vat_number": "string", "updated_at": "string", "users": [ { "attributes": [], "created_at": "string", "custom_role_id": "string", "custom_role_name": "string", "custom_role_slug": "string", "email": "string", "email_verified": false, "id": "string", "language": "string", "level": "string", "market": "string", "name": "string", "phone_number": "string", "store_group": "string", "surname": "string", "updated_at": "string" } ] }, "details": [ "string" ], "success": false } ```
### 400 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ### 401 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ### 404 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ### 500 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ## Contract identity Use these fields to confirm you are implementing the intended endpoint contract. - API family: Management API - Method: `POST` - Path: `/api/v1/{team_slug}/{app_slug}/organisations` - Operation ID: Not documented in the OpenAPI contract. - Stable operation key: `management-api:POST:/api/v1/{team_slug}/{app_slug}/organisations` - OpenAPI tag: Organizations - OpenAPI summary: Create a new organization