Companies API: Delete member

Endpoint#

Property	Value
Type	mutation
Method	POST
Path	/api/external/v1/companies/delete_member
Handler	OperatelyWeb.Api.Companies.DeleteMember

Authentication#

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

Inputs#

Field	Type	Required	Nullable	Default
person_id	id primitive (encoded as string)	Yes	No	-

Outputs#

Field	Type	Required	Nullable
person	person object	Yes	No

cURL Example#

Copied

curl --request POST \
  --url "https://app.operately.com/api/external/v1/companies/delete_member" \
  --header "Authorization: Bearer ${OPERATELY_API_TOKEN}" \
  --header "Content-Type: application/json" \
  --data '{"person_id":"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"
  }
}