.svg?fit=max&auto=format&n=5dFUa43uNFVHhpls&q=85&s=0676273c9e1c58f0a7d6694269d14045)
ایجاد کارت
کارت برای پیگیری فرایندهایی استفاده میشود که الزاماً فروش نیستند؛ مثل تیکت پشتیبانی، راهاندازی مشتری یا یک کار در کانبان. با این Endpoint میتوانید کارت جدیدی بسازید و نوع، مرحله، مسئول، مخاطبان، معامله مرتبط، اولویت، سررسید و فیلدهای اضافه آن را مشخص کنید.POST {{baseURL}}/api/Case/Save_v2?apikey={{API_KEY}}
پارامترهای Query
| پارامتر | نوع | وضعیت | توضیح |
|---|---|---|---|
apikey | string | الزامی | کلید API دیدار. |
Header درخواست
Content-Type: application/json
بدنه درخواست
object
اطلاعات کارت داخل این آبجکت ارسال میشود؛ از عنوان و نوع کارت گرفته تا مسئول، کاریز، مرحله و رکوردهای مرتبط.
Show property
Show property
string
required
عنوان کارت که در نمای کاریز و فهرست کارتها نمایش داده میشود.
string
required
شناسه مرحله کاریز کارت است و مشخص میکند کارت الان در کدام مرحله فرایند قرار دارد.
Show وابستگیها
Show وابستگیها
شناسه مرحله باید متعلق به یکی از کاریزهای کارت در همین اکانت باشد.
- List Case Pipelines —
Response[].Stages[].Idشناسه مرحله کاریز کارت است
string
شناسه User مسئول رسیدگی و پیگیری کارت است.
Show وابستگیها
Show وابستگیها
این فیلد نام کاربر را نمیپذیرد؛ باید
UserId یک User موجود در دیدار را بفرستید.- User List — مقدار
UserIdکاربر موردنظر را بردارید
string
توضیحات تکمیلی کارت برای ثبت موضوع، نیاز یا جزئیات پیگیری.
string
شناسه شرکت مرتبط با کارت است. برای زمانی که میخواهید کارت به یک شرکت هم متصل باشد
Show وابستگیها
Show وابستگیها
این فیلد نام شرکت را نمیپذیرد؛ باید
Id شرکت موجود در دیدار را بفرستید.- Create Company — اگر شرکت هنوز ساخته نشده است
- Get Company By Id — اگر
Idشرکت را دارید - Search Company — برای جستوجوی شرکت
string
شناسه شخص اصلی مرتبط با کارت است؛ یعنی کارتی که فرایند یا پیگیری آن برای این شخص انجام میشود.
Show وابستگیها
Show وابستگیها
این فیلد نام یا موبایل شخص را نمیپذیرد؛ باید
Id شخص موجود در دیدار را بفرستید.- Create Person — اگر شخص هنوز در دیدار ساخته نشده است
- Get Person By Id — اگر
Idشخص را دارید - Get Person By Mobile — اگر شماره موبایل شخص را دارید
- Search Person — برای جستوجوی شخص
string
required
شناسه دستهبندی کارت که نوع یا فرایند کارت را مشخص میکند.
Show مقادیر مجاز
Show مقادیر مجاز
00000000-0000-0000-0000-000000000000— کارت فعالیتمحور؛ امکان اتصال فعالیت داردcd06853c-35df-4d9b-b124-9556474d84a1— کارت کانبان؛ برای حرکت در مراحل فرایند و بدون افزودن فعالیت37375848-a403-4186-8460-d45754f49e4c— کارت تیکت؛ برای پیگیری ارتباط تیکتی با مشتری
string
شناسه معاملهای است که این کارت از آن ایجاد شده یا باید به آن مرتبط باشد.
Show وابستگیها
Show وابستگیها
مقدار این فیلد باید
Id یک معامله موجود در دیدار باشد.- Create Deal — اگر معامله هنوز ساخته نشده است
- Get Deal By Id — اگر
Idمعامله را دارید - Search Deal — برای جستوجوی معامله
boolean
مشخص میکند کارت حذف شده است یا همچنان فعال است.
Show مقادیر مجاز
Show مقادیر مجاز
true— کارت حذفشده در نظر گرفته میشودfalse— کارت فعال است
string
وضعیت جاری کارت در چرخه انجام کار.
Show مقادیر مجاز
Show مقادیر مجاز
InProgress— کارت در حال انجام استDone— کار کارت تمام شده است
string
تاریخ سررسید کارت؛ زمانی که انتظار میرود کار تا آن انجام شود.
number
اولویت کارت برای مرتبسازی و تعیین تقدم رسیدگی.
Show مقادیر مجاز
Show مقادیر مجاز
-2— کمترین اهمیت و مقدار پیشفرض-1— اهمیت کم0— اهمیت متوسط1— اهمیت بالا
array
فهرست شناسه مسئول های دیگری است که باید به کارت مرتبط باشند. برای زمانی که بیش از یک مسئول به کارت مرتبط هستند
Show وابستگیها
Show وابستگیها
این فیلد نام کاربر را نمیپذیرد؛ باید
UserId یک User موجود در دیدار را بفرستید.- User List — مقدار
UserIdکاربر موردنظر را بردارید
string
شناسه سایر مخاطبان مرتبط با کارت است؛ یعنی افراد یا شرکتهایی غیر از مخاطب اصلی که باید به کارت وصل باشند.
Show وابستگیها
Show وابستگیها
هر مقدار باید
Id یک شخص یا شرکت موجود در دیدار باشد.- Create Person — ساخت شخص جدید
- Get Person By Mobile — پیداکردن شخص با موبایل
- Search Person — جستوجوی شخص
- Create Company — ساخت شرکت جدید
- Search Company — جستوجوی شرکت
string
نتیجه یا جمعبندی ثبتشده پس از تکمیل کارت.
string
سطح مشاهده کارت؛ تعیین میکند چه کاربران یا گروههایی امکان دیدن آن را دارند.
Show مقادیر مجاز
Show مقادیر مجاز
0 / Owner— فقط مسئول کارت1 / OwnerGroup— مسئول و گروه او2 / OwnerSubGroup— مسئول، گروه و زیرگروه او3 / All— همه کاربران مجاز
object
مقدار Custom Fieldهای کارت است. کلید هر پراپرتی، کلید فنی فیلد و مقدار آن، دیتایی است که باید در همان فیلد ذخیره شود.
Show وابستگیها
Show وابستگیها
فقط از کلید Custom Fieldهایی استفاده کنید که
FieldType آنها مربوط به Case است.- Get Custom Fields — کلید فنی فیلد متناسب با Entity را بردارید
boolean
مشخص میکند کاربر فعلی اجازه حذف کارت را دارد یا خیر.
Show مقادیر مجاز
Show مقادیر مجاز
true— کاربر اجازه حذف کارت داردfalse— کاربر اجازه حذف کارت ندارد
boolean
مشخص میکند کاربر فعلی اجازه ویرایش کارت را دارد یا خیر.
Show مقادیر مجاز
Show مقادیر مجاز
true— کاربر اجازه ویرایش کارت داردfalse— کاربر اجازه ویرایش کارت ندارد
boolean
مشخص میکند دستهبندی فعلی کارت فعال و قابل استفاده است یا خیر.
Show مقادیر مجاز
Show مقادیر مجاز
true— نوع فعلی کارت فعال استfalse— نوع فعلی کارت غیرفعال است
string
تاریخ و زمان ورود کارت به وضعیت در حال انجام.
string
تاریخ نزدیکترین فعالیت باز مرتبط با کارت.
تاریخ و زمان آخرین تغییر در فعالیتهای مرتبط با کارت.
string
تاریخ و زمان تکمیل کارت.
string
تاریخ و زمان آخرین انتقال کارت بین کاریزها یا مراحل.
array
فهرست شناسه برچسبهایی است که باید به کارت وصل شوند.
Show وابستگیها
Show وابستگیها
هر مقدار باید
Id یکی از برچسبهای کارت باشد.- Case Labels —
Idبرچسب کارت را بردارید
{
"Case": {
"Title": " 1231 123123123 تست",
"PipelineStageId": "422dfd72-549e-4443-9c32-6336e2275059",
"OwnerId": "f1599895-3d58-44a8-a830-e77b42d8e4c6",
"Description": "asdfas asdf adfs asdf",
"CompanyId": "c867d72d-a5ca-47dd-8e0c-e65db830dea6",
"PersonId": "c86978d0-7d19-45ad-9c54-bfb270b97c07",
"CaseCategoryId": "37375848-a403-4186-8460-d45754f49e4c",
"DealId": "16d952cc-2321-4680-a951-957c3eb21423",
"IsDeleted": false,
"Status": "InProgress",
"DueDate": "2025-08-31T11:19:58.4577817Z",
"Priority": -2,
"UserIds": [
"f1599895-3d58-44a8-a830-e77b42d8e4c6",
"04c4f658-64a5-4231-8850-36089c8a77d5"
],
"OtherContactIds": "b868fc4c-f8bc-460e-ac4e-a302cae45a1a,c8968598-9720-494c-8894-cbf728f40255",
"ResultNote": "sdfasd asdf a asdf",
"VisibilityType": "OwnerSubGroup",
"Fields": {
"Field_8785_0_13": "123123"
},
"CanDelete": true,
"CanEdit": true,
"IsCaseCategoryActive": null,
"InProgressTime": "2025-08-31T11:19:58.4577817Z",
"NextActivityDate": "2000-08-31T11:19:58.4577817Z",
"LastActivityUpdateTime": null,
"DoneTime": "2025-08-31T11:19:58.4577817Z",
"PipelineChangeTime": "2025-08-31T11:19:58.4577817Z",
"Category": null,
"IdleStatus": null,
"RottenInPipelineStatus": null,
"RottenInStageStatus": null,
"CaseRating": null
},
"LabelIds": [
"196d9122-3547-4386-b316-06a792e78958",
"19c80b4f-6b4a-4bdc-ab06-76d891406d2f"
]
}
curl --location --request POST '{{baseURL}}/api/Case/Save_v2?apikey={{API_KEY}}' \
--header 'Content-Type: application/json' \
--data '{
"Case": {
"Title": " 1231 123123123 تست",
"PipelineStageId": "422dfd72-549e-4443-9c32-6336e2275059",
"OwnerId": "f1599895-3d58-44a8-a830-e77b42d8e4c6",
"Description": "asdfas asdf adfs asdf",
"CompanyId": "c867d72d-a5ca-47dd-8e0c-e65db830dea6",
"PersonId": "c86978d0-7d19-45ad-9c54-bfb270b97c07",
"CaseCategoryId": "37375848-a403-4186-8460-d45754f49e4c",
"DealId": "16d952cc-2321-4680-a951-957c3eb21423",
"IsDeleted": false,
"Status": "InProgress",
"DueDate": "2025-08-31T11:19:58.4577817Z",
"Priority": -2,
"UserIds": [
"f1599895-3d58-44a8-a830-e77b42d8e4c6",
"04c4f658-64a5-4231-8850-36089c8a77d5"
],
"OtherContactIds": "b868fc4c-f8bc-460e-ac4e-a302cae45a1a,c8968598-9720-494c-8894-cbf728f40255",
"ResultNote": "sdfasd asdf a asdf",
"VisibilityType": "OwnerSubGroup",
"Fields": {
"Field_8785_0_13": "123123"
},
"CanDelete": true,
"CanEdit": true,
"IsCaseCategoryActive": null,
"InProgressTime": "2025-08-31T11:19:58.4577817Z",
"NextActivityDate": "2000-08-31T11:19:58.4577817Z",
"LastActivityUpdateTime": null,
"DoneTime": "2025-08-31T11:19:58.4577817Z",
"PipelineChangeTime": "2025-08-31T11:19:58.4577817Z",
"Category": null,
"IdleStatus": null,
"RottenInPipelineStatus": null,
"RottenInStageStatus": null,
"CaseRating": null
},
"SetLabelDto": {
"UpdatedLabels": [],
"AddedLabels": [],
"LabelIds": [
"196d9122-3547-4386-b316-06a792e78958",
"19c80b4f-6b4a-4bdc-ab06-76d891406d2f"
]
}
}'
{
"Response": {
"Id": "b83965ac-5a28-4be2-a844-e783ba2f254c",
"OwnerId": "00000000-0000-0000-0000-000000000000",
"OwnerId_Old": "00000000-0000-0000-0000-000000000000",
"Title": " 1231 تست",
"CanDelete": true,
"CanEdit": true,
"IsCaseCategoryActive": true,
"Description": "",
"CompanyId": "00000000-0000-0000-0000-000000000000",
"PersonId": "00000000-0000-0000-0000-000000000000",
"ContactId": "00000000-0000-0000-0000-000000000000",
"IsDeleted": false,
"Status": "InProgress",
"CreateTime": "2026-07-28T16:35:51.9663563Z",
"DueDate": "2026-07-28T16:35:51.9663563Z",
"InProgressTime": "2026-07-28T16:35:51.9663563Z",
"DoneTime": "2026-07-28T16:35:51.9663563Z",
"CaseType": "Simple",
"DealId": "00000000-0000-0000-0000-000000000000",
"LabelId": "048cba4c-c168-421d-949b-4ca2bb84ebb4",
"Code": 4,
"Color": "",
"Priority": 0,
"UserIds": [],
"PipelineStageId": "2d34c424-62e5-4fcc-b0f0-bfbd11bf440a",
"PipelineId": "f7861340-b22c-49b1-bb5a-d96b5cdba979",
"PipelineChangeTime": "2026-07-28T16:35:51.9663563Z",
"CaseCategoryId": "00000000-0000-0000-0000-000000000000",
"OtherContactIds": null,
"ResultNote": null,
"NextActivityDate": null,
"LastActivityUpdateTime": null,
"VisibilityType": "Owner",
"CategoryType": "ActivityOriented",
"CreatorId": "00000000-0000-0000-0000-000000000000",
"Creator": {
"UserId": "00000000-0000-0000-0000-000000000000",
"DisplayName": "کاربر میهمان ",
"PictureUrl": "/PortalData/Subsystems/Profile/UserPics/nopicture.png",
"Email": ""
},
"Owner": {
"UserId": "00000000-0000-0000-0000-000000000000",
"DisplayName": "کاربر میهمان ",
"PictureUrl": "/PortalData/Subsystems/Profile/UserPics/nopicture.png",
"Email": ""
},
"Category": null,
"Fields": {},
"Contact": null,
"Person": null,
"Company": null,
"OtherContacts": [],
"Deal": null,
"_Type": null,
"LabelIds": [
"048cba4c-c168-421d-949b-4ca2bb84ebb4"
],
"IdleStatus": null,
"RottenInPipelineStatus": null,
"RottenInStageStatus": null,
"CaseRating": null
}
}