Valstorm LogoDev

portal Endpoints

All endpoints for the portal API group. Great for feeding into an LLM context.

POST

/v1/portal

Create Portal

Creates a new portal experience under the parent production tenant. Only accessible by production organization administrators.

Request Body
{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/PortalCreateRequest"
      }
    }
  },
  "required": true
}
Responses
201
Successful Response
application/json
{
  "$ref": "#/components/schemas/PortalResponse"
}
404
Not found
422
Validation Error
application/json
{
  "$ref": "#/components/schemas/HTTPValidationError"
}
API Runner
PATCH

/v1/portal/{portal_id}

Update Portal

Updates an existing portal's name or custom domain. Only accessible by production organization administrators.

Parameters
portal_id*
in: path
type: string
Request Body
{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/PortalUpdateRequest"
      }
    }
  }
}
Responses
200
Successful Response
application/json
{
  "$ref": "#/components/schemas/PortalResponse"
}
404
Not found
422
Validation Error
application/json
{
  "$ref": "#/components/schemas/HTTPValidationError"
}
API Runner
DELETE

/v1/portal/{portal_id}

Delete Portal

Deletes a portal and drops its associated database entirely. Only accessible by production organization administrators.

Parameters
portal_id*
in: path
type: string
Responses
200
Successful Response
application/json
{}
404
Not found
422
Validation Error
application/json
{
  "$ref": "#/components/schemas/HTTPValidationError"
}
API Runner
POST

/v1/portal/{portal_id}/users

Invite Portal User Bulk

Invites a guest user to a portal, auto-linking existing global accounts if they exist. Only accessible by production organization administrators.

Parameters
portal_id*
in: path
type: string
Request Body
{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/PortalUserInviteRequest"
      }
    }
  }
}
Responses
201
Successful Response
application/json
{
  "$ref": "#/components/schemas/PortalUserInviteResponse"
}
404
Not found
422
Validation Error
application/json
{
  "$ref": "#/components/schemas/HTTPValidationError"
}
API Runner
GET

/v1/portal/{portal_id}/users

List Portal Users

Lists all authorized users registered inside a portal's local database. Only accessible by production organization administrators.

Parameters
portal_id*
in: path
type: string
Responses
200
Successful Response
application/json
{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/PortalUserResponse"
  },
  "title": "Response List Portal Users V1 Portal  Portal Id  Users Get"
}
404
Not found
422
Validation Error
application/json
{
  "$ref": "#/components/schemas/HTTPValidationError"
}
API Runner
DELETE

/v1/portal/{portal_id}/users/{user_id}

Remove Portal User

Removes a guest user's access from a portal and drops their membership documents. Only accessible by production organization administrators.

Parameters
portal_id*
in: path
type: string
user_id*
in: path
type: string
Responses
200
Successful Response
application/json
{}
404
Not found
422
Validation Error
application/json
{
  "$ref": "#/components/schemas/HTTPValidationError"
}
API Runner