Case

A support case.

Operations

Every route this entity exposes. Each route links to its own reference on this page.

Examples

One example per SDK, generated from the API model. The argument names are the parameters and fields of this entity, and the values are placeholders. The examples are not compiled or executed.

Golang

Construct client as shown in the Golang setup, then call the operations:

case_, err := client.Case(nil).Load(map[string]any{"id": 1}, nil)
if err != nil {
    panic(err)
}
fmt.Println(case_)
created, err := client.Case(nil).Create(map[string]any{"description": "example", "details": map[string]any{}, "externalId": "example"}, nil)
if err != nil {
    panic(err)
}
fmt.Println(created)

Lua

Construct client as shown in the Lua setup, then call the operations:

local case, err = client:Case():load({ id = 1 })
local created, err = client:Case():create({ description = "example", details = {}, externalId = "example" })

PHP

Construct client as shown in the PHP setup, then call the operations:

$case = $client->Case()->load(["id" => 1]);
$created = $client->Case()->create(["description" => "example", "details" => [], "externalId" => "example"]);

Python

Construct client as shown in the Python setup, then call the operations:

case = client.Case().load({"id": 1})
created = client.Case().create({ "description": "example", "details": {}, "externalId": "example" })

Ruby

Construct client as shown in the Ruby setup, then call the operations:

case_ = client.Case.load({ "id" => 1 })
created = client.Case.create({ "description" => "example", "details" => {}, "externalId" => "example" })

TypeScript

Construct client as shown in the TypeScript setup, then call the operations:

const case_ = await client.Case().load({ id: 1 })
const created = await client.Case().create({ description: "example", details: {}, externalId: "example" })

Fields

create

POST /cases

Operation ID: caseCreate.

Authentication: bearer token (ClientCredentialsToken).

Parameters

Request body

application/json

Responses

200: Created case

application/json

429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header

application/json

The response is object.

load

GET /cases/{caseId}

Operation ID: caseGet.

Authentication: bearer token (ClientCredentialsToken).

Parameters

Responses

200: Case details retrieved successfully

application/json

401: Unauthorized - missing or invalid authentication

application/json

The response is object and object.

Example response:

{
  "detail": "Authentication required",
  "status": 401,
  "title": "Unauthorized",
  "type": "/errors/types/access"
}

403: Forbidden - insufficient permissions

application/json

The response is object and object.

Example response:

{
  "code": "forbidden",
  "detail": "Unauthorized",
  "status": 403,
  "title": "Forbidden",
  "type": "/errors/types/access"
}

404: Not found - case does not exist

application/json

The response is object and object.

Example response:

{
  "code": "resource_not_found",
  "detail": "case not found: 12345678",
  "instance": "/public/v2/cases/12345678",
  "status": 404,
  "title": "Not Found",
  "type": "/errors/types/domain"
}

429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header

application/json

The response is object.