API 레퍼런스

전체 고객용 인터페이스를 하나의 계약으로.

고객용 엔드포인트는 /api/v1 아래에서 사용할 수 있습니다. 기존 /api 접두사는 대시보드에서 계속 사용할 수 있지만, 새 서버 연동에는 버전이 지정된 기본 URL을 사용해야 합니다.

63개의 문서화된 작업8개의 리소스 그룹OpenAPI 3.1 기계가 읽을 수 있는 계약

인증 경계

제품 연동에는 워크스페이스 API 키를 사용하며, 이 키로 계정 사용량, 분석, API 키 메타데이터도 읽을 수 있습니다. 결제 변경과 API 키 생성 또는 폐기에는 HTTP 전용 브라우저 세션이 필요하며 그에 맞게 표시되어 있습니다.

발송, 조회, 검색, 답장, 전송 이벤트 확인.

발송한 메일과 수신한 메일을 자동으로 또는 수동으로 폴더에 정리합니다.

비공개 첨부 파일 저장소로 작성 화면 흐름을 구축합니다.

재사용 가능한 콘텐츠의 초안 작성, 렌더링, 테스트, 버전 관리, 게시, 발송.

발신 ID를 프로비저닝하고 DNS 검증 상태를 파악합니다.

주소를 만들고 수신한 대화를 다룹니다.

이벤트, 평판 결과, 차단된 수신자를 확인합니다.

API 키로 계정 사용량, 분석, 키 메타데이터를 읽을 수 있습니다. 결제 변경과 키 생성 또는 폐기에는 대시보드 세션이 필요합니다.

JSON 오류는 예측 가능한 하나의 엔벨로프를 사용합니다. 상태 코드로 잘못된 입력, 인증, 존재하지 않는 리소스, 충돌, 결제 필요, 안전 차단, 사용량 한도를 구분합니다.

오류 응답

{
  "error": {
    "message": "The sender domain is not verified",
    "status": 403
  }
}

날짜 기반 API 버전이 이 계약을 식별합니다. 하위 호환되는 필드는 같은 버전 안에서 추가될 수 있습니다. 호환되지 않는 변경에는 새 버전의 기본 경로와 문서화된 전환 절차가 필요합니다.

탐색

{
  "version": "2026-09-07",
  "baseUrl": "https://sendhq.cc/api/v1",
  "openapi": "https://sendhq.cc/openapi.json"
}