Companies API: Update

Endpoint#

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

Authentication#

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

Inputs#

Field	Type	Required	Nullable	Default
name	string	Yes	No	-

Outputs#

Field	Type	Required	Nullable
company	company object	Yes	No

cURL Example#

Copied

curl --request POST \
  --url "https://app.operately.com/api/external/v1/companies/update" \
  --header "Authorization: Bearer ${OPERATELY_API_TOKEN}" \
  --header "Content-Type: application/json" \
  --data '{"name":"value"}'

Response Example#

{
  "company": {
    "__typename": "value",
    "admins": [
      "<person>"
    ],
    "company_space_id": "value",
    "enabled_experimental_features": [
      "value"
    ],
    "general_space": "<space>",
    "id": "value",
    "member_count": 123,
    "mission": "value",
    "name": "value",
    "owners": [
      "<person>"
    ],
    "people": [
      "<person>"
    ],
    "permissions": "<company_permissions>",
    "setup_completed": true,
    "trusted_email_domains": [
      "value"
    ]
  }
}