PgBeam Docs
Support

createSupportCase

Create a support case

Creates a new support case with an initial message.

Usage

const result = await api.support.createSupportCase({
  pathParams: { org_id: "org_abc123" },
  body: {
    org_id: "...",
    title: "...",
    body: "...",
  },
});

Parameters

ParameterTypeRequiredDescription
pathParams.org_idstringYesUnique organization identifier.
body.org_idstringYesOrganization ID.
body.titlestringYesBrief summary of the issue.
body.severitynumberNoSeverity level: 1=Critical, 2=High, 3=Normal, 4=Low.
body.bodystringYesInitial message body.

Response

Promise<SupportCase> — support case created.

Example

import { PgBeamClient } from "pgbeam";

const client = new PgBeamClient({
  token: "pbk_...",
  baseUrl: "https://api.pgbeam.com",
});

const result = await client.api.support.createSupportCase({
  pathParams: { org_id: "org_abc123" },
  body: {
    org_id: "...",
    title: "...",
    body: "...",
  },
});

Errors

StatusDescription
400Invalid request parameters.
401Missing or invalid authentication.
403Operation not allowed by current plan limits.

On this page