Organization
Namespace

Create namespace in organization

Changed on

Create a new namespace in the organization.

post/v1/organizations/{organizationRef}/namespaces

Request

  • Base URL: https://example.com/api
  • URL: https://example.com/api/v1/organizations/{organizationRef}/namespaces
  • Auth: OAuth 2 (authorization code, authorization URL /oauth/authorize, token URL /oauth/token; client credentials, token URL /oauth/token; password, token URL /oauth/token, scopes: organization, namespace)

Request body

namestring required

Name of the namespace.

logostring uri nullable

Logo of the namespace.

slugstring required

Organization-scoped canonical kebab-case slug. Reserved value is new. Must not parse as an xid.

descriptionstring nullable

Description of the namespace.

Example request

{
  "name": "Engineering",
  "logo": "https://example.com/static/logo.png",
  "slug": "platform",
  "description": "Engineering team namespace"
}

Response

Example response

idstring required

ID of the newly created resource.

Changes

  • 12e233bb333eRevision changes
    • info

      added the new optional request property

  • 8a34c0b5508eRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status