Skip to main content
POST
/
v
/
alpha
/
people
/
create
Create a person
curl --request POST \
  --url https://api.operate.so/v/alpha/people/create \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "email": "john.doe@example.com",
  "full_name": "<string>",
  "cue": "<string>",
  "timezone": "<string>",
  "titles": [
    {
      "title": "<string>",
      "company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "order_index": 500
    }
  ],
  "location": "<string>"
}
'

Authorizations

​
x-api-key
string
header
required

API key for authentication. Obtain from your Operate dashboard.

Body

​
email
required

Email address(es) for the person

Example:

"john.doe@example.com"

​
full_name
string
required

Full name of the person

Minimum string length: 1
Examples:

"John Doe"

"Jane Smith"

​
cue
string

A brief note or reminder about the person (max 280 characters)

Maximum string length: 280
Examples:

"Follow up about project proposal"

"Met at conference last week"

​
timezone
string

IANA timezone name, alternative name, or abbreviation. Examples: 'America/New_York', 'Eastern Time', 'EST', 'UTC'. See https://en.wikipedia.org/wiki/List_of_tz_database_time_zones for full list.

Examples:

"America/New_York"

"Eastern Time"

"EST"

"UTC"

"Pacific Time"

"PST"

​
titles
object[]

Job titles and roles for this person

Example:
[
  {
    "title": "Software Engineer",
    "company_id": "123e4567-e89b-12d3-a456-426614174000",
    "order_index": 0
  }
]
​
location
string

Location display string (e.g., 'Seattle, WA', 'New York, NY')

Examples:

"Seattle, WA"

"New York, NY"

"San Francisco, CA"

Response

200

Successful response