v1

latestOpenAPI 3.0.02026-07-261733191.1 MB

Organizations

Create a customer organization

Create a customer organization to manage parent-child relationships for your customers.

post/customer-organizations

Headers

Authorizationstring required

Your API credentials. Eg. Basic {credentials}.

sequence-version'2024-07-30'

Use this header to select an API version

Request body

ownerIdstring required

ID of the customer that will own the organization.

memberIdsstring[] required

IDs of the customers who are members of this organization, excluding the owner. These are the children in a parent-child relationship. You can pass an empty array if they are not yet known.

Example request

{
  "ownerId": "50af5191-05a3-42a5-802a-6b59091157af",
  "memberIds": [
    "e309e948-088e-4d77-b654-cd85498f1555",
    "50af5191-05a3-42a5-802a-6b59091157af"
  ]
}

Response

Created

idstring required

Organization ID

Example response

{
  "id": "c0dc4e79-ec52-4811-8cf5-addb2527915c",
  "owner": {
    "id": "50af5191-05a3-42a5-802a-6b59091157af",
    "name": "FinTech Solutions Inc."
  },
  "members": [
    {
      "id": "e06f36e2-0a44-404d-bdbc-b66a292609b0",
      "name": "FinTech Wealth Management"
    }
  ]
}