Skip to main content
POST
Create Member
Register a member of your client’s team on a workspace. Cases then resolve that person as an owner or an assignee, instead of mistaking the team for contacts.
Members created through the API are always silent: Penbox never emails them, and the flag cannot be overridden from the payload. A partner can never create a member Penbox would contact.

Idempotency

The call is idempotent on the pair (workspace.id, email): re-posting a member who already exists returns that member with a 200 instead of failing on the uniqueness constraint. A 201 means the member was created. Emails are lowercased and trimmed before the lookup, so Jane@Acme.com and jane@acme.com are the same member.

Roles

workspace.id is always explicit — it is never inferred from the token. A token that does not cover the workspace returns a 404.

Authorizations

Authorization
string
header
required

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

Body

application/json
workspace
object
required

Workspace to add the member to. Always explicit, never inferred from the token.

email
string<email>
required

Member email address. Linked to the existing Penbox account when there is one.

given_name
string

First name

Maximum string length: 100
family_name
string

Last name

Maximum string length: 100
locale
string

Language the member is addressed in

Maximum string length: 10
Example:

"fr"

is_admin
boolean
default:false

Whether the member can administer the workspace and its settings

is_handler
boolean
default:true

Whether the member can be set as the owner or an assignee of a case

Response

A member with this email already exists on the workspace, and is returned unchanged

id
string<uuid>

Member UUID

created_at
string<date-time>

Creation timestamp

email
string<email>

Member email address, trimmed and lowercased

given_name
string | null

First name

family_name
string | null

Last name

locale
string | null

Language the member is addressed in

is_admin
boolean

Whether the member can administer the workspace and its settings

is_handler
boolean

Whether the member can be set as the owner or an assignee of a case

silent
boolean

Whether Penbox refrains from emailing this member. Always true for a member created through the API.

active
boolean

Whether the email is already linked to a Penbox user account. False while the member has not signed up.

workspace
object

Workspace the member belongs to