Skip to main content
PUT
/
api
/
organizations
/
api-keys
Update organization API keys and details
curl --request PUT \
  --url https://your-instance.example.com/api/organizations/api-keys \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "5f7b1c2e8a1d4e0012c3b400",
  "name": "Acme Corp",
  "phoneNumber": "+14165550100",
  "address": "123 Yonge St, Toronto, ON",
  "creds": {
    "anthropicApiKey": "sk-ant-api03-EXAMPLE-key-redacted",
    "sinchServicePlanId": "srv-plan-example-123"
  }
}
'
{
  "message": "Organization details updated successfully"
}

Authorizations

Authorization
string
header
required

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

Body

application/json
id
string
required

Organization ID whose details and credentials should be updated.

creds
object
required

Replacement third-party API credentials (Anthropic, Sinch SMS/MMS) attached to the organization.

Example:
{
"anthropicApiKey": "sk-ant-api03-EXAMPLE-key-redacted",
"sinchServicePlanId": "srv-plan-example-123",
"sinchApiToken": "sinch-token-example-redacted",
"sinchMmsApiKey": "sinch-mms-key-example",
"sinchMmsServiceId": "sinch-mms-service-example"
}
name
string

Updated organization display name.

phoneNumber
string

Updated primary organization phone number in E.164 format.

address
string

Updated mailing/business address.

logoUrl
string

Optional logo image; accepts a data URI which the server uploads and stores.

Response

API keys updated

message
string