| title |
Companies API: Delete trusted email domain |
| description |
Reference for the delete trusted email domain mutation in the Companies API. |
import CurlExampleBlock from "@components/CurlExampleBlock.jsx"
| Property |
Value |
| Type |
mutation |
| Method |
POST |
| Path |
/api/external/v1/companies/delete_trusted_email_domain |
| Handler |
OperatelyWeb.Api.Companies.DeleteTrustedEmailDomain |
- Requires a valid API token.
- Requires a write-enabled token.
- Read-only tokens return
403.
| Field |
Type |
Required |
Nullable |
Default |
company_id |
string |
Yes |
No |
- |
domain |
string |
Yes |
No |
- |
| Field |
Type |
Required |
Nullable |
company |
company object |
Yes |
No |
<CurlExampleBlock client:load command={"curl --request POST \\n --url "https://app.operately.com/api/external/v1/companies/delete_trusted_email_domain\" \\n --header "Authorization: Bearer ${OPERATELY_API_TOKEN}" \\n --header "Content-Type: application/json" \\n --data '{"company_id":"value", "domain":"value"}'"} />
{
"company": {
"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"
]
}
}