Bắt đầu

Lỗi

Mọi lỗi, dù mã trạng thái nào, đều có một hình dạng. code ổn định và an toàn để rẽ nhánh; message cho biết điều gì sai và, khi hữu ích, nên gửi gì thay thế; detail nêu tên tham số, header hoặc giá trị mà lỗi liên quan, nếu có.

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\"."
  }
}

Mã	Trạng thái	Ý nghĩa
`unauthorized`	401	Không có token bearer, hoặc token không hợp lệ.
`validation`	400	Một tham số truy vấn, tham số đường dẫn hoặc phần thân bị sai định dạng. detail cho biết là cái nào.
`not_found`	404	Không có mẫu hoặc tài liệu như vậy, hoặc tài khoản không thấy được nó. Hai trường hợp này cố ý không phân biệt.
`template_not_saved`	409	Mẫu chưa có phiên bản đã lưu; chỉ các mẫu đã lưu mới tạo được tài liệu.
`subscription_required`	402	Không gian làm việc không có gói đang hoạt động. Chủ sở hữu hoặc quản trị viên có thể chọn một gói ở trang thanh toán; không mất gì cả.
`unknown_placeholder`	422	Một khóa trong values không phải là khóa trường của mẫu này. Thông báo liệt kê các khóa hợp lệ.
`unknown_group_field`	422	Một khóa trong đối tượng bản ghi không phải là khóa trường của nhóm đó. Thông báo liệt kê các trường.
`invalid_option`	422	Một trường kiểu select nhận được giá trị không nằm trong các tùy chọn của nó.
`invalid_number`	422	Một trường số nhận được thứ không phải là số.
`invalid_values`	422	Một trường nhận được mảng, hoặc một nhóm nhận được chuỗi.
`idempotency_in_flight`	409	Cùng một yêu cầu vẫn đang được xử lý. Thử lại sau giây lát.
`payload_too_large`	413	Phần thân yêu cầu vượt quá 1 MB.
`method_not_allowed`	405	Phương thức không được hỗ trợ trên đường dẫn này. Header Allow liệt kê các phương thức được hỗ trợ.
`pdf_render_failed`	500	Không thể kết xuất PDF của tài liệu. Yêu cầu lại sẽ thử lại.
`internal`	500	Có sự cố ở phía chúng tôi. Hãy thử lại; nếu vẫn tiếp diễn, hãy viết thư cho chúng tôi.