ویرایش یادداشت
حرفه‌ایکلید خواندن و نوشتندر پلن حرفه‌ای و سازمانی در دسترس است (بتا).
PATCHhttps://app.reshta.ir/api/v1/public…/public/notes/{id}
فقط فیلدهایی را که می‌فرستید تغییر می‌دهد. پاسخ رکورد به‌روزشده است.
درخواست
curl https://app.reshta.ir/api/v1/public/notes/0192c4e8-7b1a-7c3e-9f20-5d6a1b2c3d4e \ -X PATCH \ -H "Authorization: Bearer $RESHTA_API_KEY" \ -H "Idempotency-Key: 7f3c2b1e-4a5d-4c6f-9e1a-2b3c4d5e6f70" \ -H "Content-Type: application/json" \ -d '{"body":"سایز L ارسال شد."}'سرآیندها
AuthorizationstringالزامیBearer و کلید API کسب‌وکار (rk_live_…).
Idempotency-Keystringالزامیشناسهٔ یکتای همین عملیات، مثلاً یک UUID تازه؛ تکرار با همان کلید چیزی را دوبار انجام نمی‌دهد.
Content-Typeapplication/jsonالزامیبدنه JSON با UTF-8 است.
پارامترهای مسیر
idstringالزامیشناسهٔ رکورد (UUID).
پارامترهای بدنه
bodystringالزامیمتن یادداشت؛ تا ۵۰٬۰۰۰ نویسه.
پاسخ‌ها و خطاها
200—انجام شد؛ بدنه همان رکورد است.
400validation_errorبدنه نادرست است یا Idempotency-Key نیامده؛ details می‌گوید کدام فیلد.
401unauthorizedکلید نیست، نادرست یا باطل است، یا سازنده‌اش دیگر فعال نیست.
403forbiddenکلید دسترسی نوشتن ندارد.
404not_foundرکورد در این کسب‌وکار پیدا نشد.
409conflictهمین Idempotency-Key با بدنهٔ دیگری آمده یا هنوز در جریان است.
429rate_limitedبیش از ۱۲۰ درخواست در دقیقه؛ Retry-After می‌گوید چند ثانیه صبر کنید.
پاسخ
400
{ "error": { "code": "validation_error", "message": "Idempotency-Key header is required", "details": [ { "field": "idempotency_key", "message": "idempotency_key_required" } ] }}