시작하기

오류

상태 코드가 무엇이든 모든 오류는 한 가지 형태입니다. code는 안정적이어서 분기해도 안전하고, message는 무엇이 잘못됐는지와 도움이 될 때는 대신 무엇을 보내야 하는지 알려 주며, detail은 있을 경우 오류와 관련된 매개변수, 헤더 또는 값을 가리킵니다.

JSON

{
  "error": {
    "code": "unknown_placeholder",
    "message": "No placeholder is keyed \"client\". Keys of `values` must be placeholder KEYS (the template’s placeholders[].key, e.g. \"client_name\"), not the values currently filled in and not names read out of the text. Retry with keys taken from exactly this list: \"client_name\", \"payment_terms\", \"due_date\", \"invoice_number\", \"issue_date\", \"line_items\"."
  }
}

코드	상태	의미
`unauthorized`	401	bearer 토큰이 없거나 유효하지 않습니다.
`validation`	400	쿼리 매개변수, 경로 매개변수 또는 본문의 형식이 잘못되었습니다. detail이 무엇인지 알려 줍니다.
`not_found`	404	해당 템플릿이나 문서가 없거나 계정이 볼 수 없습니다. 두 경우는 의도적으로 구분하지 않습니다.
`template_not_saved`	409	템플릿에 아직 저장된 버전이 없습니다. 저장된 템플릿만 생성할 수 있습니다.
`subscription_required`	402	워크스페이스에 활성 요금제가 없습니다. 소유자나 관리자가 결제 페이지에서 선택할 수 있으며, 아무것도 잃지 않습니다.
`unknown_placeholder`	422	values의 키가 이 템플릿의 플레이스홀더 키가 아닙니다. 메시지에 유효한 키가 나열됩니다.
`unknown_group_field`	422	인스턴스 객체 안의 키가 해당 그룹의 필드 키가 아닙니다. 메시지에 필드가 나열됩니다.
`invalid_option`	422	select 플레이스홀더에 옵션에 없는 값이 전달되었습니다.
`invalid_number`	422	숫자 플레이스홀더에 숫자가 아닌 값이 전달되었습니다.
`invalid_values`	422	플레이스홀더에 배열이 전달되었거나, 그룹에 문자열이 전달되었습니다.
`idempotency_in_flight`	409	같은 요청이 아직 처리 중입니다. 잠시 후 다시 시도하세요.
`payload_too_large`	413	요청 본문이 1 MB를 넘습니다.
`method_not_allowed`	405	이 경로에서 지원하지 않는 메서드입니다. Allow 헤더에 지원하는 메서드가 나열됩니다.
`pdf_render_failed`	500	문서의 PDF를 렌더링할 수 없었습니다. 다시 요청하면 재시도합니다.
`internal`	500	저희 쪽에서 문제가 발생했습니다. 다시 시도하시고, 계속되면 연락해 주세요.