ویرایش مخاطب
حرفه‌ایکلید خواندن و نوشتندر پلن حرفه‌ای و سازمانی در دسترس است (بتا).
PATCHhttps://app.reshta.ir/api/v1/public…/public/contacts/{id}
فقط فیلدهایی را که می‌فرستید تغییر می‌دهد و رویداد contact.updated را برای وب‌هوک‌های شما می‌فرستد. پاسخ رکورد به‌روزشده است.
درخواست
curl https://app.reshta.ir/api/v1/public/contacts/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 '{"job_title":"مدیر خرید"}'سرآیندها
AuthorizationstringالزامیBearer و کلید API کسب‌وکار (rk_live_…).
Idempotency-Keystringالزامیشناسهٔ یکتای همین عملیات، مثلاً یک UUID تازه؛ تکرار با همان کلید چیزی را دوبار انجام نمی‌دهد.
Content-Typeapplication/jsonالزامیبدنه JSON با UTF-8 است.
پارامترهای مسیر
idstringالزامیشناسهٔ رکورد (UUID).
پارامترهای بدنه
first_namestring | nullاختیارینام.
last_namestring | nullاختیارینام خانوادگی.
company_iduuid | nullاختیاریشرکتی که این رکورد به آن وصل است.
job_titlestring | nullاختیاریسمت.
national_idstring | nullاختیاریکد ملی.
owner_iduuidاختیاریهمکار مسئول.
lifecycle_stagestringاختیاریمرحلهٔ چرخهٔ عمر مشتری.
birthdaystring | nullاختیاریتاریخ تولد میلادی، YYYY-MM-DD.
unsubscribed_emailbooleanاختیاریلغو اشتراک ایمیل‌های تبلیغاتی.
unsubscribed_smsbooleanاختیاریلغو اشتراک پیامک‌های تبلیغاتی.
customobjectاختیاریفیلدهای سفارشی، با کلید هر فیلد.
addressobject | nullاختیارینشانی پستی؛ null یعنی پاک کردن.
address.statestring | nullاختیاری
address.citystring | nullاختیاری
address.linestring | nullاختیاری
address.postal_codestring | nullاختیاری
پاسخ‌ها و خطاها
200—انجام شد؛ بدنه همان رکورد است.
400validation_errorبدنه نادرست است یا Idempotency-Key نیامده؛ details می‌گوید کدام فیلد.
401unauthorizedکلید نیست، نادرست یا باطل است، یا سازنده‌اش دیگر فعال نیست.
403forbiddenکلید دسترسی نوشتن ندارد.
404not_foundرکورد در این کسب‌وکار پیدا نشد.
409conflictهمین Idempotency-Key با بدنهٔ دیگری آمده یا هنوز در جریان است.
429rate_limitedبیش از ۱۲۰ درخواست در دقیقه؛ Retry-After می‌گوید چند ثانیه صبر کنید.
پاسخ
{ "id": "0192c4e8-7b1a-7c3e-9f20-5d6a1b2c3d4e", "first_name": "سارا", "last_name": "رضایی", "company_id": null, "company_name": null, "job_title": "مدیر خرید", "national_id": null, "owner_id": "0192a7f0-3b4c-7d5e-8f60-718293a4b5c6", "lifecycle_stage": "lead", "birthday": null, "unsubscribed_email": false, "unsubscribed_sms": false, "is_sample": false, "source": null, "marketing_block_reason": null, "address": null, "custom": {}, "emails": [], "phones": [ { "id": "0192c4e8-7b1b-7a10-8c21-3d4e5f607182", "phone": "09121234567", "label": null, "is_primary": true } ], "created_at": "2026-10-26T14:05:12.000Z", "updated_at": "2026-10-26T14:05:12.000Z"}وب‌هوک مرتبط: contact.updated