ویرایش معامله
حرفه‌ایکلید خواندن و نوشتندر پلن حرفه‌ای و سازمانی در دسترس است (بتا).
PATCHhttps://app.reshta.ir/api/v1/public…/public/deals/{id}
فقط فیلدهایی را که می‌فرستید تغییر می‌دهد و رویداد deal.updated را برای وب‌هوک‌های شما می‌فرستد. پاسخ رکورد به‌روزشده است.
درخواست
curl https://app.reshta.ir/api/v1/public/deals/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 '{"stage_id":"0192b002-2d3e-7f40-9b5c-6d7e8f9a0b1c"}'سرآیندها
AuthorizationstringالزامیBearer و کلید API کسب‌وکار (rk_live_…).
Idempotency-Keystringالزامیشناسهٔ یکتای همین عملیات، مثلاً یک UUID تازه؛ تکرار با همان کلید چیزی را دوبار انجام نمی‌دهد.
Content-Typeapplication/jsonالزامیبدنه JSON با UTF-8 است.
پارامترهای مسیر
idstringالزامیشناسهٔ رکورد (UUID).
پارامترهای بدنه
titlestringاختیاریعنوان معامله.
from_titlestringاختیاریمقدار فعلی که انتظار دارید؛ اگر عوض شده باشد ویرایش رد می‌شود.
from_owner_iduuid | nullاختیاریمقدار فعلی که انتظار دارید؛ اگر عوض شده باشد ویرایش رد می‌شود.
from_expected_close_datestring | nullاختیاریمقدار فعلی که انتظار دارید؛ اگر عوض شده باشد ویرایش رد می‌شود.
from_value_amountintegerاختیاریمقدار فعلی که انتظار دارید؛ اگر عوض شده باشد ویرایش رد می‌شود.
pipeline_iduuidاختیاریفقط معاملات این قیف.
stage_iduuidاختیاریفقط معاملات این مرحله.
statusstringاختیاریopen، won یا lost.مقدارها:openwonlost
won_atstringاختیاریزمان برنده شدن، ISO 8601.
lost_atstringاختیاریزمان از دست رفتن، ISO 8601.
value_amountintegerاختیاریمبلغ، عدد صحیح به ریال.
currencystringاختیاریواحد پول، مثلاً IRR.
expected_close_datestring | nullاختیاریتاریخ پیش‌بینی بستن، YYYY-MM-DD.
owner_iduuid | nullاختیاریفقط رکوردهای این همکار.
company_iduuid | nullاختیاریشرکتی که این رکورد به آن وصل است.
contact_iduuid | nullاختیاریمخاطب مرتبط.
lost_reason_iduuid | nullاختیاریدلیل باخت.
customobjectاختیاریفیلدهای سفارشی، با کلید هر فیلد.
پاسخ‌ها و خطاها
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" } ] }}وب‌هوک مرتبط: deal.updated