Set which modules are enabled, and in what order

PUT

/orgs/{org}/config/modules/order

curl --request PUT \
  --url https://api.sloose.com/orgs/org_9f3c/config/modules/order \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "modules": [ "example" ] }'

• Production
• Staging

Order matters: it is the order records are created in, so a module that others reference must come first. Modules absent from the list are disabled.

Authorizations

• sessionAuth
• apiTokenAuth

Parameters

Path Parameters

org

required

The org id the session was issued for. A token for one org can never read another.

string

Example

org_9f3c

The org id the session was issued for. A token for one org can never read another.

Request Body^required

Media typeapplication/json

object

modules

required

Module keys or API names, in creation order. Anything not listed is disabled — this sets the whole enabled set, it does not append to it.

Array<string>

0

Example^generated

{
  "modules": [
    "example"
  ]
}

Responses

200

Applied, in the order given.

Media typeapplication/json

object

ok

required

boolean

registryVersion

required

number

modules

required

Array<string>

Example

{
  "ok": true
}

400

The request body did not match the schema. issues carries the Zod issue list.

Media typeapplication/json

The error envelope every non-2xx answer uses.

object

error

required

Human-readable explanation.

string

code

Machine-readable reason. Absent on a few legacy 400s.

string

key

additional properties

Example^generated

{
  "error": "example",
  "code": "example"
}

401

No bearer, or one that is expired, revoked or no longer resolves to a member.

Media typeapplication/json

The error envelope every non-2xx answer uses.

object

error

required

Human-readable explanation.

string

code

Machine-readable reason. Absent on a few legacy 400s.

string

key

additional properties

Example^generated

{
  "error": "example",
  "code": "example"
}

403

The plan’s module limit would be exceeded (code: LIMIT_MODULES), or the org is suspended.

Media typeapplication/json

The error envelope every non-2xx answer uses.

object

error

required

Human-readable explanation.

string

code

Machine-readable reason. Absent on a few legacy 400s.

string

key

additional properties

Example^generated

{
  "error": "example",
  "code": "example"
}

422

missing lists the references that are not in the latest discovery.

Media typeapplication/json

object

error

required

string

code

required

string

Allowed values: UNKNOWN_MODULES

missing

required

Array<string>

key

additional properties

Example

{
  "code": "UNKNOWN_MODULES"
}