Skip to main content
PATCH
/
organizations
/
{organization_id}
조직 수정
curl --request PATCH \
  --url https://client-api.tryvox.co/v3/organizations/{organization_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "webhook_url": "<string>",
  "webhook_version": "<string>",
  "webhook_event_subscriptions": [
    "<string>"
  ],
  "billing_invoice_recipient_emails": [
    "<string>"
  ]
}
'
{
  "id": "<string>",
  "name": "<string>",
  "is_main": true,
  "webhook_version": "<string>",
  "webhook_event_subscriptions": [
    "<string>"
  ],
  "created_at": 123,
  "parent_organization_id": "<string>",
  "webhook_url": "<string>",
  "billing_invoice_recipient_emails": [
    "<string>"
  ],
  "subscription": {
    "display_name": "<string>",
    "plan_sms_send_text_fee": 123,
    "plan_sms_send_mms_fee": 123,
    "plan_sms_recv_fee": 123,
    "plan_concurrent_call_limit": 123,
    "plan_hourly_call_limit": 123,
    "plan_daily_call_limit": 123
  }
}

Authorizations

Authorization
string
header
required

조직 API 키를 Authorization: Bearer <token> 형식으로 보냅니다.

Path Parameters

organization_id
string
required

수정할 조직 ID입니다(본인 또는 직속 하위 조직).

Body

application/json

수정할 조직 필드입니다.

조직 수정 요청입니다. 변경할 필드만 보내며(최소 1개), 생략한 필드는 유지됩니다. 상위·하위 관계와 결제 방식은 이 API로 바꿀 수 없습니다.

name
string

조직 이름입니다. 앞뒤 공백은 제거됩니다. null은 거부되고, 생략 시 유지됩니다.

Required string length: 1 - 255
webhook_url
string | null

webhook 수신 URL입니다. https URL만 허용하며, null 또는 빈 문자열이면 해제되고 생략 시 유지됩니다.

Maximum string length: 2048
webhook_version
string

webhook payload 버전입니다. v2만 설정할 수 있습니다(v1은 레거시 단방향이라 API로 설정할 수 없고, v1→v2 업그레이드만 가능합니다). null은 거부되고, 생략 시 유지됩니다.

Allowed value: "v2"
webhook_event_subscriptions
string[]

구독할 webhook 이벤트 타입 목록입니다. 현재 sms_received만 구독 대상이며, 통화 관련 이벤트는 구독과 무관하게 항상 발송됩니다. 중복은 제거되고, null은 거부되며 생략 시 유지됩니다.

billing_invoice_recipient_emails
string[]

청구서 안내 수신 이메일 목록입니다. 소문자로 정규화되며 중복은 거부됩니다. null은 거부되고, 생략 시 유지됩니다.

Response

성공 응답

id
string
required

조직 ID입니다.

name
string
required

조직 이름

is_main
boolean
required

상위 조직 여부입니다(false면 하위 조직).

webhook_version
string
required

webhook payload 버전 (v1/v2)

webhook_event_subscriptions
string[]
required

구독 중인 webhook 이벤트 타입 목록입니다.

created_at
integer
required

리소스 생성 시각입니다. unix milliseconds 형식입니다.

parent_organization_id
string | null

상위 조직 ID입니다. 하위 조직만 값이 있고 상위 조직은 null입니다.

webhook_url
string | null

webhook 수신 URL

billing_invoice_recipient_emails
string[] | null

청구서 안내 수신 이메일입니다.

subscription
SubscriptionView · object

구독 정보입니다. 상위 조직만 포함되고 하위 조직은 null입니다.