Avisi cloud logo
Organisations

Create an organisation.

POST
/api/v1/organisations

Request Body

application/jsonRequired

organisationName
Required
string

Minimum length: 3Maximum length: 30

organisationType
Required
string

Value in: "BUSINESS" | "ENTERPRISE" | "INDIVIDUAL" | "TRIAL"

vatNumberstring

Minimum length: 0Maximum length: 255

companyNamestring

Minimum length: 0Maximum length: 255

companyAddressstring

Minimum length: 0Maximum length: 255

acceptedAgreements
Required
array<object>

contactEmail
Required
object

curl -X POST "http://localhost:8090/api/v1/organisations" \
  -H "Content-Type: application/json" \
  -d '{
    "organisationName": "string",
    "organisationType": "BUSINESS",
    "vatNumber": "string",
    "companyName": "string",
    "companyAddress": "string",
    "acceptedAgreements": [
      {
        "agreementSlug": "string"
      }
    ],
    "contactEmail": {
      "email": "string"
    }
  }'

Request was successfully processed. The response body contains the requested data.

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "identity": "10a80a7a-1a32-4a74-b592-aa2a4ef691c5",
  "name": "string",
  "vatCode": "string",
  "companyName": "string",
  "companyAddress": "string",
  "contactEmail": "string",
  "billingEmail": "string",
  "vatCodeValidated": true,
  "vatCodeValidatedAt": "2019-08-24T14:15:22Z",
  "phoneNumber": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "acceptedTerms": true,
  "acceptedTermsAt": "2019-08-24T14:15:22Z",
  "hasStripeCustomer": true,
  "restrictedToAvailableCloudProviders": true,
  "type": "BUSINESS",
  "slug": {
    "slugValue": "string"
  }
}

Previous

Validate VAT for an organisation. POST

Next

Delete an organisation (only possible if the organisation has no configured cloud accounts, no active clusters and no active monitoring tenants). DELETE