Update Note - Didar CRM

ویرایش یادداشت

این Endpoint برای تغییر متن یا ارتباط‌های یک یادداشت موجود استفاده می‌شود.‎ برای مشخص‌کردن یادداشتی که باید ویرایش شود، لازم است ID آن را در Activity.Id ارسال کنید.‎

POST {{baseURL}}/api/activity/save?apikey={{API_KEY}}

پارامترهای Query

پارامتر	نوع	وضعیت	توضیح
`apikey`	`string`	الزامی	کلید API دیدار.

Content-Type: application/json

بدنه درخواست

object

required

اطلاعات Note جدید داخل این آبجکت ارسال می‌شود. متن یادداشت در ResultNote قرار می‌گیرد و می‌توانید آن را به مخاطب، معامله یا کارت وصل کنید.

boolean

required

برای ایجاد یادداشت باید مقدار این فیلد برابر با true باشد

Show مقادیر مجاز

true — برای ایجاد Note باید همین مقدار ارسال شود

Show property

string

required

شناسه یادداشتی که قصد دارید آن را ویرایش کنید

string

required

این فیلد نوع رکورد را برای ایجاد Note مشخص می‌کند و در این Endpoint باید مقدار ثابت نوع یادداشت را بگیرد.

Show مقادیر مجاز

00000000-0000-0000-0000-000000000000 — نوع ثابت Note

string

شناسه User مسئول انجام و پیگیری فعالیت است. فعالیت در فهرست و تقویم همین کاربر نمایش داده می‌شود.

Show وابستگی‌ها

این فیلد نام کاربر را نمی‌پذیرد؛ باید UserId یک User موجود در دیدار را بفرستید.

User List — مقدار UserId کاربر موردنظر را بردارید

Show شرایط ارسال

اگر این فیلد ارسال نشود، مسئول یادداشت مالک بیزدامنه در نظر گرفته می‌شود.

string

متن اصلی یادداشت است؛ هر چیزی که می‌خواهید در متن یادداشت دیده شود اینجا بفرستید.

boolean

مشخص می‌کند یادداشت برای دسترسی سریع در رکورد مرتبط سنجاق شود.

Show مقادیر مجاز

true — رکورد سنجاق می‌شود
false — رکورد سنجاق نمی‌شود

boolean

مشخص می‌کند یادداشت در وضعیت حذف‌شده قرار دارد یا فعال است.

Show مقادیر مجاز

true — فعالیت یا یادداشت حذف‌شده در نظر گرفته می‌شود
false — رکورد حذف‌شده نیست

string

شناسه معامله‌ای است که یادداشت باید به آن وصل شود. بعد از اتصال، رکورد در سابقه همان معامله دیده می‌شود.

Show وابستگی‌ها

مقدار این فیلد باید Id یک معامله موجود در دیدار باشد.

Create Deal — اگر معامله هنوز ساخته نشده است
Get Deal By Id — اگر Id معامله را دارید
Search Deal — برای جست‌وجوی معامله

array

فهرست Id اشخاص یا شرکت‌هایی است که این یادداشت به آن‌ها مربوط می‌شود. رکورد در سابقه مخاطبان انتخاب‌شده هم دیده خواهد شد.

Show وابستگی‌ها

هر مقدار باید Id یک شخص یا شرکت موجود در دیدار باشد.

Create Person — ساخت شخص جدید
Get Person By Mobile — پیداکردن شخص با موبایل
Search Person — جست‌وجوی شخص
Create Company — ساخت شرکت جدید
Search Company — جست‌وجوی شرکت

string

شناسه کارتی است که فعالیت یا یادداشت باید به آن وصل شود. بعد از اتصال، رکورد در سابقه همان کارت دیده می‌شود.

Show وابستگی‌ها

مقدار این فیلد باید Id یک کارت موجود در دیدار باشد.

Create Case — اگر کارت هنوز ساخته نشده است
Search Case — برای جست‌وجوی کارت

array

فهرست تگ‌هایی است که برای دسته‌بندی و پیداکردن سریع‌تر فعالیت یا یادداشت به آن وصل می‌شوند.

Show وابستگی‌ها

این فیلد باید Id تگ موجود در دیدار را بگیرد.

Tags — Id تگ موردنظر را بردارید

{
  "Activity": {
    "Id": "0740f0b5-a015-40d2-964d-fc6b4bf86152",
    "ActivityTypeId": "00000000-0000-0000-0000-000000000000",
    "OwnerId": "8c0b89b1-515c-42de-957d-294f0e80dbeb",
    "ResultNote": "test note text",
    "IsDone": true,
    "IsPinned": true,
    "IsDeleted": false,
    "DealId": "D8044233-C42B-4A55-BD30-6DC8C1915196",
    "ContactIds": [
      "BDFAF004-2AD3-47CB-89B9-0002FE5E5678",
      "3d92eedd-3a16-4ef0-ad2a-632a477f8e3b"
    ],
    "CaseId": "D8004233-C42B-0000-BD30-6DC8C1989096",
    "Tags": [
      {
        "TagId": "553655d9-8591-4bdd-b4d4-f3aca19ac5bb"
      },
      {
        "TagId": "161ca98d-b715-4ffe-b9ee-722ce33655f6"
      }
    ]
  }
}

curl --location 'https://app.didar.me/api/activity/save?apikey={{API_KEY}}' \
--header 'Content-Type: application/json' \
--data '{
  "Activity": {
    "Id": "0740f0b5-a015-40d2-964d-fc6b4bf86152",
    "ActivityTypeId": "00000000-0000-0000-0000-000000000000",
    "OwnerId": "8c0b89b1-515c-42de-957d-294f0e80dbeb",
    "ResultNote": "test note text",
    "IsDone": true,
    "IsPinned": true,
    "IsDeleted": false,
    "DealId": "D8044233-C42B-4A55-BD30-6DC8C1915196",
    "ContactIds": [
      "BDFAF004-2AD3-47CB-89B9-0002FE5E5678",
      "3d92eedd-3a16-4ef0-ad2a-632a477f8e3b"
    ],
    "CaseId": "D8004233-C42B-0000-BD30-6DC8C1989096",
    "Tags": [
      {
        "TagId": "553655d9-8591-4bdd-b4d4-f3aca19ac5bb"
      },
      {
        "TagId": "161ca98d-b715-4ffe-b9ee-722ce33655f6"
      }
    ]
  }
}'

{
    "Response": {
        "Id": "0740f0b5-a015-40d2-964d-fc6b4bf86152",
        "Title": "",
        "Note": "",
        "ResultNote": "test note text",
        "ActivityTypeId": "00000000-0000-0000-0000-000000000000",
        "IsPrivate": false,
        "IsDone": true,
        "IsPinned": true,
        "IsDeleted": false,
        "IsKeepInTouch": false,
        "DueDateType": "Default",
        "DueDate": "2026-07-28T07:42:12.8190862Z",
        "FinishDate": "2026-07-28T07:42:12.8190862Z",
        "OriginalDueDate": "2026-07-28T07:42:12.8190862Z",
        "DoneDate": "2026-07-28T07:42:12.8190862Z",
        "RegisterDate": "2026-07-28T07:42:12.8190862Z",
        "LastUpdateTime": "2026-07-28T07:42:12.8190862Z",
        "LastPokeDate": "2026-07-28T07:42:12.8190862Z",
        "Duration": 0,
        "DealId": "d8044233-c42b-4a55-bd30-6dc8c1915196",
        "CaseId": "d8004233-c42b-0000-bd30-6dc8c1989096",
        "TicketId": "00000000-0000-0000-0000-000000000000",
        "CreatorId": "8c0b89b1-515c-42de-957d-294f0e80dbeb",
        "OwnerId": "8c0b89b1-515c-42de-957d-294f0e80dbeb",
        "UpdaterId": "00000000-0000-0000-0000-000000000000",
        "ActivityGroupId": "0740f0b5-a015-40d2-964d-fc6b4bf86152",
        "RecurrenceType": "OneTime",
        "RecurrenceData": 0,
        "RecurrenceEndDate": "2026-07-28T07:42:12.8190862Z",
        "FeedbackType": "Neutral",
        "NextOccurrence": "0001-01-01T00:00:00Z",
        "CanPoke": false,
        "IsAttended": false,
        "Deal": {
            "Id": "d8044233-c42b-4a55-bd30-6dc8c1915196",
            "Title": "معامله نفری تست"
        },
        "Case": null,
        "Contacts": [
            {
                "ContactId": "bdfaf004-2ad3-47cb-89b9-0002fe5e5678",
                "ActivityId": "0740f0b5-a015-40d2-964d-fc6b4bf86152",
                "Status": "Accepted",
                "Message": "",
                "Contact": {
                    "Id": "bdfaf004-2ad3-47cb-89b9-0002fe5e5678",
                    "Title": "جناب آقای",
                    "FirstName": "سهیل",
                    "LastName": "شیرازی",
                    "WorkPhone": "",
                    "MobilePhone": "",
                    "Type": "Person",
                    "DisplayName": "سهیل شیرازی"
                }
            },
            {
                "ContactId": "3d92eedd-3a16-4ef0-ad2a-632a477f8e3b",
                "ActivityId": "0740f0b5-a015-40d2-964d-fc6b4bf86152",
                "Status": "Accepted",
                "Message": "",
                "Contact": {
                    "Id": "3d92eedd-3a16-4ef0-ad2a-632a477f8e3b",
                    "Title": "",
                    "FirstName": "12",
                    "LastName": "",
                    "WorkPhone": "",
                    "MobilePhone": "",
                    "Type": "Company",
                    "DisplayName": "12"
                }
            }
        ],
        "Creator": {
            "UserId": "8c0b89b1-515c-42de-957d-294f0e80dbeb",
            "DisplayName": "میلاد مظاهری",
            "PictureUrl": "/PortalData/Subsystems/Profile/UserPics/a727ae10-e9ae-4541-b66a-00781811e5f5.jpg",
            "Email": "milad@gmail.com"
        },
        "Owner": {
            "UserId": "8c0b89b1-515c-42de-957d-294f0e80dbeb",
            "DisplayName": "میلاد مظاهری",
            "PictureUrl": "/PortalData/Subsystems/Profile/UserPics/a727ae10-e9ae-4541-b66a-00781811e5f5.jpg",
            "Email": "milad@gmail.com"
        },
        "Users": [],
        "Notifies": [],
        "Comments": [],
        "Attachments": [],
        "Voices": [],
        "Voips": [],
        "Tags": [
            {
                "ActivityId": "00000000-0000-0000-0000-000000000000",
                "TagId": "553655d9-8591-4bdd-b4d4-f3aca19ac5bb"
            },
            {
                "ActivityId": "00000000-0000-0000-0000-000000000000",
                "TagId": "161ca98d-b715-4ffe-b9ee-722ce33655f6"
            }
        ],
        "CanEdit": true,
        "CanDelete": true,
        "CanDone": false,
        "ActivityTicketStatus": "NotAnswered",
        "IsTicket": false,
        "OwnerId_Old": "8c0b89b1-515c-42de-957d-294f0e80dbeb",
        "ActivityGroupType": "Default"
    }
}

قواعد و محدودیت ها

آپدیت به این صورت است که فقط فیلد Id اجباری است و مابقی فیلد ها اگر ارسال نشوند به مقدار اولیه و پیشفرض خود برمیگردند. (هر فیلدی که قصد دارید ویرایش نشود باید مقدار آن فیلد را دقیقا طبق مقداری که در حالت قبل از ویرایش بوده ارسال بکنید)

{
  "Activity": {
    "Id": "0740f0b5-a015-40d2-964d-fc6b4bf86152",
    "ActivityTypeId": "00000000-0000-0000-0000-000000000000",
    "OwnerId": "8c0b89b1-515c-42de-957d-294f0e80dbeb",
    "ResultNote": "test note text",
    "IsDone": true,
    "IsPinned": true,
    "IsDeleted": false,
    "DealId": "D8044233-C42B-4A55-BD30-6DC8C1915196",
    "ContactIds": [
      "BDFAF004-2AD3-47CB-89B9-0002FE5E5678",
      "3d92eedd-3a16-4ef0-ad2a-632a477f8e3b"
    ],
    "CaseId": "D8004233-C42B-0000-BD30-6DC8C1989096",
    "Tags": [
      {
        "TagId": "553655d9-8591-4bdd-b4d4-f3aca19ac5bb"
      },
      {
        "TagId": "161ca98d-b715-4ffe-b9ee-722ce33655f6"
      }
    ]
  }
}

curl --location 'https://app.didar.me/api/activity/save?apikey={{API_KEY}}' \
--header 'Content-Type: application/json' \
--data '{
  "Activity": {
    "Id": "0740f0b5-a015-40d2-964d-fc6b4bf86152",
    "ActivityTypeId": "00000000-0000-0000-0000-000000000000",
    "OwnerId": "8c0b89b1-515c-42de-957d-294f0e80dbeb",
    "ResultNote": "test note text",
    "IsDone": true,
    "IsPinned": true,
    "IsDeleted": false,
    "DealId": "D8044233-C42B-4A55-BD30-6DC8C1915196",
    "ContactIds": [
      "BDFAF004-2AD3-47CB-89B9-0002FE5E5678",
      "3d92eedd-3a16-4ef0-ad2a-632a477f8e3b"
    ],
    "CaseId": "D8004233-C42B-0000-BD30-6DC8C1989096",
    "Tags": [
      {
        "TagId": "553655d9-8591-4bdd-b4d4-f3aca19ac5bb"
      },
      {
        "TagId": "161ca98d-b715-4ffe-b9ee-722ce33655f6"
      }
    ]
  }
}'

{
    "Response": {
        "Id": "0740f0b5-a015-40d2-964d-fc6b4bf86152",
        "Title": "",
        "Note": "",
        "ResultNote": "test note text",
        "ActivityTypeId": "00000000-0000-0000-0000-000000000000",
        "IsPrivate": false,
        "IsDone": true,
        "IsPinned": true,
        "IsDeleted": false,
        "IsKeepInTouch": false,
        "DueDateType": "Default",
        "DueDate": "2026-07-28T07:42:12.8190862Z",
        "FinishDate": "2026-07-28T07:42:12.8190862Z",
        "OriginalDueDate": "2026-07-28T07:42:12.8190862Z",
        "DoneDate": "2026-07-28T07:42:12.8190862Z",
        "RegisterDate": "2026-07-28T07:42:12.8190862Z",
        "LastUpdateTime": "2026-07-28T07:42:12.8190862Z",
        "LastPokeDate": "2026-07-28T07:42:12.8190862Z",
        "Duration": 0,
        "DealId": "d8044233-c42b-4a55-bd30-6dc8c1915196",
        "CaseId": "d8004233-c42b-0000-bd30-6dc8c1989096",
        "TicketId": "00000000-0000-0000-0000-000000000000",
        "CreatorId": "8c0b89b1-515c-42de-957d-294f0e80dbeb",
        "OwnerId": "8c0b89b1-515c-42de-957d-294f0e80dbeb",
        "UpdaterId": "00000000-0000-0000-0000-000000000000",
        "ActivityGroupId": "0740f0b5-a015-40d2-964d-fc6b4bf86152",
        "RecurrenceType": "OneTime",
        "RecurrenceData": 0,
        "RecurrenceEndDate": "2026-07-28T07:42:12.8190862Z",
        "FeedbackType": "Neutral",
        "NextOccurrence": "0001-01-01T00:00:00Z",
        "CanPoke": false,
        "IsAttended": false,
        "Deal": {
            "Id": "d8044233-c42b-4a55-bd30-6dc8c1915196",
            "Title": "معامله نفری تست"
        },
        "Case": null,
        "Contacts": [
            {
                "ContactId": "bdfaf004-2ad3-47cb-89b9-0002fe5e5678",
                "ActivityId": "0740f0b5-a015-40d2-964d-fc6b4bf86152",
                "Status": "Accepted",
                "Message": "",
                "Contact": {
                    "Id": "bdfaf004-2ad3-47cb-89b9-0002fe5e5678",
                    "Title": "جناب آقای",
                    "FirstName": "سهیل",
                    "LastName": "شیرازی",
                    "WorkPhone": "",
                    "MobilePhone": "",
                    "Type": "Person",
                    "DisplayName": "سهیل شیرازی"
                }
            },
            {
                "ContactId": "3d92eedd-3a16-4ef0-ad2a-632a477f8e3b",
                "ActivityId": "0740f0b5-a015-40d2-964d-fc6b4bf86152",
                "Status": "Accepted",
                "Message": "",
                "Contact": {
                    "Id": "3d92eedd-3a16-4ef0-ad2a-632a477f8e3b",
                    "Title": "",
                    "FirstName": "12",
                    "LastName": "",
                    "WorkPhone": "",
                    "MobilePhone": "",
                    "Type": "Company",
                    "DisplayName": "12"
                }
            }
        ],
        "Creator": {
            "UserId": "8c0b89b1-515c-42de-957d-294f0e80dbeb",
            "DisplayName": "میلاد مظاهری",
            "PictureUrl": "/PortalData/Subsystems/Profile/UserPics/a727ae10-e9ae-4541-b66a-00781811e5f5.jpg",
            "Email": "milad@gmail.com"
        },
        "Owner": {
            "UserId": "8c0b89b1-515c-42de-957d-294f0e80dbeb",
            "DisplayName": "میلاد مظاهری",
            "PictureUrl": "/PortalData/Subsystems/Profile/UserPics/a727ae10-e9ae-4541-b66a-00781811e5f5.jpg",
            "Email": "milad@gmail.com"
        },
        "Users": [],
        "Notifies": [],
        "Comments": [],
        "Attachments": [],
        "Voices": [],
        "Voips": [],
        "Tags": [
            {
                "ActivityId": "00000000-0000-0000-0000-000000000000",
                "TagId": "553655d9-8591-4bdd-b4d4-f3aca19ac5bb"
            },
            {
                "ActivityId": "00000000-0000-0000-0000-000000000000",
                "TagId": "161ca98d-b715-4ffe-b9ee-722ce33655f6"
            }
        ],
        "CanEdit": true,
        "CanDelete": true,
        "CanDone": false,
        "ActivityTicketStatus": "NotAnswered",
        "IsTicket": false,
        "OwnerId_Old": "8c0b89b1-515c-42de-957d-294f0e80dbeb",
        "ActivityGroupType": "Default"
    }
}

​ویرایش یادداشت

​پارامترهای Query

​Header درخواست

​بدنه درخواست

​قواعد و محدودیت ها

ویرایش یادداشت

پارامترهای Query

Header درخواست

بدنه درخواست

قواعد و محدودیت ها