Skip to main content
POST
Create or update an employee.

Authorizations

X-API-Key
string
header
required

Company API key - scoped to a specific company. Generate from the Integrations page in your dashboard.

Path Parameters

employeeId
string
required

Body

application/json

Fields to set on the employee

Request body for creating or updating an employee. The employee ID comes from the URL path; send only the fields to change. companyId is required when the employee does not exist yet (or comes from the API key).

companyId
string

Company ID. Required to create an employee; ignored on update (an employee cannot be moved to another company).

name
string

Employee name

title
string

Job title

description
string

Short description of what the employee does

prompt
string

System prompt/persona

responseInstructions
string

Response instructions

greetingMessage
string

Greeting shown when a new chat starts

tags
string[]

Tags

picture
string

Picture URL

departmentIds
string[]

Department IDs; replaces the employee's department assignments

Response

Employee saved

Employee save response

id
string

ID of the saved employee