Skip to main content
POST
Update Case Contacts
Add or modify contacts in a case.

Authorizations

Authorization
string
header
required

API token (starts with pnbx_). Create at https://app.penbox.io/workspace/settings/api. Include as: Authorization: Bearer {token}

Path Parameters

id
string
required

The unique identifier of the case

Body

application/json
contacts
object[]
required
Minimum array length: 1

Response

200 - application/json

Contacts added successfully

id
string<uuid>
required

Case UUID

title
string
required

Case title

parent_status
enum<string>
required

Parent status

Available options:
draft,
pending,
in_progress,
closed,
cancelled
created_at
string<date-time>

Creation timestamp

updated_at
string<date-time>

Last update timestamp

workspace
object

Workspace the case belongs to

description
string | null

Case description

locale
string | null

Language/locale code

reference
string | null

Custom reference number

status
string | null

Key of the current status

status_label
string | null

Human-readable label of the current status. Custom statuses return the label configured on the case template, in the language it was written in. Built-in statuses (draft, pending, in_progress, closed, cancelled) return an English label, as the API has no notion of the reader's language.

Example:

"Waiting for documents"

waiting_for
enum<string>

Who the case is waiting for

Available options:
none,
owner,
contact
statuses
object[] | null

Statuses available on this case, inherited from its case template. Use it to resolve the status key into a readable label. Null when no status is configured.

archived_at
string<date-time> | null

Timestamp when archived

contacts
object[]

Array of contact objects

template
string | null

Template reference

owner
object | null

Case owner information

actor_type
enum<string> | null
read-only

Who decided to create the case: human a person, ai a model, automation a rule configured on a case template, partner a partner integration, system Penbox itself or an API token. Read-only, and null on cases created before this was recorded.

Available options:
human,
ai,
automation,
partner,
system
channel
enum<string> | null
read-only

The surface the case came through: the Penbox app, the Outlook add-in, an AI assistant, this API, an email, a completed form, a connection or Penbox itself. Read-only, and null on cases created before this was recorded.

Available options:
app,
outlook,
mcp,
api,
email,
form,
connection,
system
creator
object | null
read-only

The workspace member who created the case. Null when no person created it, and null on cases created before this was recorded. Read-only.

steps
object[]

Array of step objects representing the case workflow

schema
object[]

Array of data fields with their current values