People API: Update

Endpoint#

Property	Value
Type	mutation
Method	POST
Path	/api/external/v1/people/update
Handler	OperatelyWeb.Api.People.Update

Authentication#

• Requires a valid API token.
• Requires a write-enabled token.
• Read-only tokens return 403.

Inputs#

Field	Type	Required	Nullable	Default
id	id primitive (encoded as string)	Yes	No	-
full_name	string	No	No	-
title	string	No	No	-
timezone	string	No	No	-
language	language enum (en, pt-BR)	No	Yes	-
time_format	time_format enum (automatic, hour_12, hour_24)	No	No	-
manager_id	id primitive (encoded as string)	No	Yes	-
theme	string	No	No	-
notify_about_assignments	boolean	No	No	-
notify_on_mention	boolean	No	No	-
send_daily_summary	boolean	No	No	-
email_window_minutes	integer	No	No	-
daily_summary_delivery_time	string	No	No	-
description	json primitive (encoded as string)	No	Yes	-

Outputs#

Field	Type	Required	Nullable
person	person object	Yes	No

cURL Example#

Copied

curl --request POST \
  --url "https://app.operately.com/api/external/v1/people/update" \
  --header "Authorization: Bearer ${OPERATELY_API_TOKEN}" \
  --header "Content-Type: application/json" \
  --data '{"daily_summary_delivery_time":"value", "description":"value", "email_window_minutes":123, "full_name":"value", "id":"value", "language":"en", "manager_id":"value", "notify_about_assignments":true, "notify_on_mention":true, "send_daily_summary":true, "theme":"value", "time_format":"automatic", "timezone":"value", "title":"value"}'

Response Example#

{
  "person": {
    "__typename": "value",
    "access_level": "<access_options_int>",
    "avatar_blob_id": "value",
    "avatar_url": "value",
    "company": "<company>",
    "daily_summary_delivery_time": "value",
    "description": "value",
    "dismissed_product_release_id": "value",
    "email": "value",
    "email_preference": "buffered",
    "email_window_minutes": "<email_window_minutes>",
    "full_name": "value",
    "has_open_invitation": true,
    "id": "value",
    "invite_link": "<invite_link>",
    "language": "en",
    "manager": "<person>",
    "notify_about_assignments": true,
    "notify_on_mention": true,
    "peers": [
      "<person>"
    ],
    "permissions": "<person_permissions>",
    "reports": [
      "<person>"
    ],
    "send_daily_summary": true,
    "show_dev_bar": true,
    "suspended": true,
    "time_format": "automatic",
    "timezone": "value",
    "title": "value",
    "type": "value",
    "url": "value"
  }
}