Skip to main content
PATCH
Update Organization

Authorizations

X-API-KEY
string
header
required

Path Parameters

organization_id
integer
required

The ID of the organization

Body

application/json
name
string

Name of the organization

Example:

"Updated Acme Corporation"

description
string | null

Description of the organization

Example:

"An updated description"

Response

Organization updated successfully.

id
integer

Unique identifier for the organization

Example:

1

name
string

Name of the organization

Example:

"Acme Corporation"

partner_type
enum<string>

How this organization is attached to your partner account. 'provisioned' organizations were created through this API and can be updated or deleted. 'linked' organizations belong to existing Answering Agent accounts attached via an accepted partner link and are read-only.

Available options:
provisioned,
linked
Example:

"provisioned"

permissions
object

Partner capabilities for this organization

created_at
string<date-time>

When the organization was created

Example:

"2024-01-15T10:30:00Z"

updated_at
string<date-time>

When the organization was last updated

Example:

"2024-01-20T14:45:00Z"

users
object[]

Users that are members of this organization

phone_numbers
object[]

Locations/phone numbers belonging to this organization