Skip to main content
PUT
/
api
/
organization
/
{organization_id}
Update Organization
curl --request PUT \
  --url https://config.heyhumm.ai/api/organization/{organization_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "is_active": true,
  "customer_s3_bucket": "<string>",
  "customer_s3_region": "<string>",
  "customer_aws_access_key_id": "<string>",
  "customer_aws_secret_access_key": "<string>",
  "customer_iam_role_arn": "<string>"
}
'
{
  "name": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "is_active": true,
  "default_thread_sharing": "private",
  "business_ontology": {},
  "ontology_version": 123,
  "ontology_updated_at": "2023-11-07T05:31:56Z",
  "context_modules_config": {},
  "data_storage_mode": "humm_hosted",
  "customer_s3_bucket": "<string>",
  "customer_s3_region": "<string>",
  "customer_aws_access_key_id": "<string>",
  "has_customer_aws_secret_access_key": false,
  "customer_iam_role_arn": "<string>",
  "entity_definitions_config": {},
  "agent_lab_config": {}
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
organization_id
string<uuid>
required

Body

application/json
​
name
string | null
​
description
string | null
​
is_active
boolean | null
​
default_thread_sharing
enum<string> | null

Default thread sharing setting for organization.

Available options:
private,
organization
​
data_storage_mode
enum<string> | null

Where synced integration data is stored.

Available options:
humm_hosted,
customer_hosted
​
customer_s3_bucket
string | null
​
customer_s3_region
string | null
​
customer_aws_access_key_id
string | null
​
customer_aws_secret_access_key
string | null
​
customer_iam_role_arn
string | null

Response

Successful Response

​
name
string
required
​
id
string<uuid>
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
description
string | null
​
is_active
boolean
default:true
​
default_thread_sharing
enum<string>
default:private

Default thread sharing setting for organization.

Available options:
private,
organization
​
business_ontology
Business Ontology · object
​
ontology_version
integer | null
​
ontology_updated_at
string<date-time> | null
​
context_modules_config
Context Modules Config · object
​
data_storage_mode
enum<string>
default:humm_hosted

Where synced integration data is stored.

Available options:
humm_hosted,
customer_hosted
​
customer_s3_bucket
string | null
​
customer_s3_region
string | null
​
customer_aws_access_key_id
string | null
​
has_customer_aws_secret_access_key
boolean
default:false
​
customer_iam_role_arn
string | null
​
entity_definitions_config
Entity Definitions Config · object
​
agent_lab_config
Agent Lab Config · object