API Reference

Katapult Core API

Resources & Endpoints

Create managed organization

Create a new managed organization within an existing organization.

POST
https://api.katapult.io/core/v1/organizations/{organization}/managed

If successful, this endpoint will return a 201 Created status.

Scopes

One of the following scopes are required to use this endpoint.

Arguments

The following arguments are supported for this endpoint.

Name Type Default Value

organization Required

Organization Lookup None

name Required

String None

sub_domain Required

String None

annotations

Annotations to add to this organization.

 KeyValue Array None

Potential Errors

The following errors may occur during this request.

Details HTTP status

organization_limit_reached

The maxmium number of organizations that can be created has been reached

 422 Unprocessable Entity

organization_not_activated

An organization was found from the arguments provided but it wasn't activated yet

 403 Forbidden

organization_not_found

No organization was found matching any of the criteria provided in the arguments

 404 Not Found

organization_suspended

An organization was found from the arguments provided but it was suspended

 403 Forbidden

validation_error

A validation error occurred with the object that was being created/updated/deleted

 422 Unprocessable Entity

Returned Object

When the request is successful, you can expect an object matching the specification below to be returned.

{
    organization: Organization {
        id: String
        name: String
        sub_domain: String
        infrastructure_domain: String
        created_at: Unix Timestamp
        activated_at: Unix Timestamp?
        suspended: Boolean
        managed: Boolean
        billing_name: String?
        address1: String?
        address2: String?
        address3: String?
        address4: String?
        postcode: String?
        vat_number: String?
        phone_number: String?
        currency: Currency {
            id: String
            name: String
            iso_code: String
            symbol: String
        }
        country: Country? {
            id: String
            name: String
            iso_code2: String
            iso_code3: String
            time_zone: String?
            eu: Boolean
        }
        country_state: CountryState? {
            id: String
            name: String
            code: String
            country: Country {
                id: String
                name: String
                iso_code2: String
                iso_code3: String
                time_zone: String?
                eu: Boolean
            }
        }
    }
    annotations: [ KeyValue {
        key: String
        value: String?
    } ]
}