API 레퍼런스
로그인
본문으로 건너뛰기

알림 설정 변경

호출자 본인의 알림 메일 설정을 바꿉니다

PUT /v1/organizations/{org_id}/notification-settings

인증

방식허용조건
API 키 (Authorization: Bearer xci_live_…)불가콘솔 세션 전용, 키로 부르면 403 console_only
콘솔 세션 쿠키가능조직 역할 owner, admin, developer, 같은 출처의 Origin 헤더 필요
  • key_leaked(키 공개 유출)는 끌 수 없습니다

매개변수

이름위치타입필수설명
org_id경로string필수조직 ID, 형식 ^org_[A-Za-z0-9]+$

요청 본문

필드타입필수설명
email_enabledboolean메일 전체 스위치
kindsobject종류별 설정

응답

200

필드타입항상설명
email_enabledboolean항상이 조직에서 본인에게 오는 알림 메일 전체 스위치
kindsobject항상종류별, false면 그 종류 메일을 받지 않습니다
lockedarray<string>항상끌 수 없는 종류(key_leaked)
receives_mailboolean항상알림은 소유자와 관리자에게 갑니다, 개발자의 설정은 저장되지만 지금은 메일이 가지 않습니다
{
  "email_enabled": true,
  "kinds": {
    "low_balance": true,
    "credit_exhausted": true,
    "workspace_limit": true,
    "tier_limit": true,
    "key_leaked": true,
    "key_spike": true
  },
  "locked": [
    "key_leaked"
  ],
  "receives_mail": true
}

오류

HTTP코드다시 시도뜻
400invalid_request아니오본문이나 쿼리가 검증에 실패했습니다, error.details.fields에 문제 필드가 있습니다
401session_required아니오콘솔 엔드포인트를 유효한 콘솔 세션 쿠키 없이 불렀습니다
403console_only아니오콘솔 세션 전용 엔드포인트입니다, API 키로는 결제, 키, 멤버 관리를 할 수 없습니다
403insufficient_permission아니오역할이나 키 권한(run/read)이 이 요청을 허용하지 않습니다
404not_found아니오자원이 없거나 이 호출자에게 보이지 않습니다
429rate_limited가능이 키 또는 조직의 요청이 너무 많습니다, retryafters만큼 기다리세요
500internal_error가능예상하지 못한 오류입니다, 다시 시도하고 반복되면 request_id와 함께 알려 주세요

오류 봉투 모양과 전체 코드 표는 오류 코드에 있습니다

예시

curl -X PUT "https://xenoci.com/api/runner/v1/organizations/org_7Kq2m9ZtP3/notification-settings" \
  --cookie "xci_console=$SESSION" \
  -H "Origin: https://xenoci.com" \
  -H "Content-Type: application/json" \
  -d '{"email_enabled":true,"kinds":{"low_balance":true,"workspace_limit":false}}'

다음 단계