Namespace

Update a namespace

Updates information for a namespace.

patch/namespace/{id}

Path parameters

idinteger required

The ID of the namespace.

Request body

namestring

The name of the namespace. Represents a department, team, or logical unit within your organization.

ℹ️ Note: Changing the namespace's name does not change the slug, as doing so could break connections with existing applications and services.

status'active' | 'inactive'

Example request

{
  "name": "Crypto Kong Billing",
  "status": "active"
}

Response

The operation was successful.

idinteger required

A system-wide unique ID for the namespace.

namestring required

The name of the namespace.

status'active' | 'inactive' required

The status of the namespace.

slugstring required

An account-wide unique slug for the namespace.

account_idinteger required

The ID of the account that owns this namespace.

Example response

{
  "id": 234,
  "name": "Crypto Kong Billing",
  "status": "active",
  "slug": "crypto-kong-billing",
  "account_id": 123,
  "metadata": {
    "key": "value"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.