Change the Organization's name or Call duration ceiling

PATCH /v1/organization

Applies the named fields at the revision If-Match names and writes the Audit event organization.update (1.21.0, FR-calls-15). Only the owner holds organization:write. Phase 0 accepts it from a Member ID token only, as for members:write, and refuses the route to every API key. Lowering the ceiling never changes a Call in progress; a Call admitted later takes the lower of its Agent version maximum and the new ceiling. From 1.22.0 the update also changes the dial policy (FR-telephony-5), which only the owner may widen as it alone holds this permission; the Audit event then records the number of allowed countries before and after, and the premium-rate switch and the outbound cap before and after, never a phone number. From 1.34.0 the description lists 422 validation_failed (register row H-25): a new name is rendered into the stored disclosure scripts and recording announcements, and one that would push a rendered line past 300 characters is refused with the issue template_invalid at path /name, so the name stays as it was. From 1.59.0 the update also turns the opt-in to production decision cases (production_decision_cases) on or off.

Request

Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the organization:write scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.

curl -X PATCH "$VOCAL_API/v1/organization" \
  -H "Authorization: Bearer $VOCAL_API_KEY" \
  -H 'If-Match: "1"' \
  -H "Content-Type: application/json" \
  -d '{}'

const response = await fetch(`${process.env.VOCAL_API}/v1/organization`, {
  method: 'PATCH',
  headers: {
    Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
    'If-Match': '"1"',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
});
console.log(response.status, await response.text());

import os

import requests

response = requests.patch(
    f"{os.environ['VOCAL_API']}/v1/organization",
    headers={
        "Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
        "If-Match": '"1"',
    },
    json={},
)
print(response.status_code, response.text)

Parameters

Request body

Content type application/json, required: OrganizationUpdateRequest.

Responses

Fields of the 200 answer

The shape is Organization.