Chats

Add Chat Member

Adds one user to the restricted chat’s audience by email. The email must resolve to a current member of the chat’s project — a newly invited user becomes addable only after accepting the invitation. Unknown emails are rejected with code publicapi.chats.members.add.email.unknown and nothing changes.

Idempotent: re-adding an existing audience member succeeds without change. Requires the chat’s visibility to be restricted; other levels respond 409.

POST

chats

{id}

members

Error

A valid request URL is required to generate request examples

{
  "user_id": "user_d8aad64dib2c7m3ae7j0",
  "email": "alice@example.com",
  "name": "Alice"
}

{
  "code": "publicapi.tenancy.project.missing",
  "humane": "X-Project-Id header is required.",
  "statusCode": 400
}

{
  "code": "publicapi.auth.invalid",
  "humane": "The provided API key is invalid or has been revoked.",
  "statusCode": 401
}

{
  "code": "publicapi.auth.invalid",
  "statusCode": 401,
  "humane": "The provided API key is invalid or has been revoked."
}

{
  "code": "publicapi.chats.members.add.not_restricted",
  "humane": "Set chat visibility to restricted before managing members.",
  "statusCode": 409
}

{
  "code": "publicapi.auth.invalid",
  "statusCode": 401,
  "humane": "The provided API key is invalid or has been revoked."
}

Authorizations

X-API-Key

string

header

required

Personal Access Token, sent verbatim as pat_<32 chars>. PATs are minted from the Chief settings UI.

Headers

X-Project-Id

string

required

Project identifier scoping the request. Required on every project-scoped public endpoint. Missing or malformed values respond with HTTP 400 and code publicapi.tenancy.project.missing.

Pattern: ^project_[a-z0-9]{20}$

Path Parameters

string

required

Chat identifier.

Pattern: ^chat_[a-z0-9]{20}$

Body

application/json

string<email>

required

Email of a current project member to add to the audience. Emails that don't resolve to a project member are rejected.

Response

Member added (or already present).

One user in a restricted chat's audience. Distinct from project members: audience membership only narrows who can read the chat and never grants project access.

user_id

string

required

Pattern: ^user_[a-z0-9]{20}$

string<email>

required

name

string

Display name. Omitted when the user hasn't set one.

Remove Chat MemberRemoves one user from the restricted chat's audience. Use the `user_id` returned by `GET /v1/chats/{id}/members`. Requires the chat's visibility to be `restricted`; other levels respond `409`.

⌘I

Error

A valid request URL is required to generate request examples

{
  "user_id": "user_d8aad64dib2c7m3ae7j0",
  "email": "alice@example.com",
  "name": "Alice"
}

{
  "code": "publicapi.tenancy.project.missing",
  "humane": "X-Project-Id header is required.",
  "statusCode": 400
}

{
  "code": "publicapi.auth.invalid",
  "humane": "The provided API key is invalid or has been revoked.",
  "statusCode": 401
}

{
  "code": "publicapi.auth.invalid",
  "statusCode": 401,
  "humane": "The provided API key is invalid or has been revoked."
}

{
  "code": "publicapi.chats.members.add.not_restricted",
  "humane": "Set chat visibility to restricted before managing members.",
  "statusCode": 409
}

{
  "code": "publicapi.auth.invalid",
  "statusCode": 401,
  "humane": "The provided API key is invalid or has been revoked."
}

Introduction

Chats

Assets

Labels

Actions

Sessions

Skills

Memories

Projects

Add Chat Member

Authorizations

Headers

Path Parameters

Body

Response