Update Deal - Gofive OpenAPI

แก้ไขข้อมูล Deal

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

integer

required

รหัส dealsId

Header Params

Content-Type

string

required

Example:

application/json

Ocp-Apim-Subscription-Key

string

required

รหัส subscription key ของลูกค้า

Example:

<Your-Subscription-Key>

Body Params application/json

dealName

string

required

ชื่อดีล

dealValue

integer

required

ค่า ดีล

dealQuantity

integer

optional

ปริมาณดีล

dealQuantityUnit

string

optional

หน่วยของปริมาณดีล

dealInterests

array[integer]

optional

ชื่อหัวข้อความสนใจ

dealLabels

array[integer]

optional

ชื่อป้ายกำกับ

dealDate

string

DateTimeString

required

เวลาขอเสนอ

expectedCloseDate

string

required

วันที่คาดว่าจะปิด

note

string

optional

รายละเอียดเพิ่มเติม

assignTo

string

required

มอบหมายให้

participantCodes

array[string]

optional

รายการรหัสผู้เขาร่วม

dateFollowUp

string <yyyy-MM-ddTHH:mm:ss>

optional

เวลาติดตาม

followUpNotes

string

optional

บันทึกสำหรับการติดตาม

dealStageId

integer

optional

remark

string

optional

บันทึกสำหรับการยกเลิกดีล Won / Missed ดีล

reasonCategoryId

integer

optional

ประเภทเหตุผลดีลที่ Missed

markAllTaskAsDone

boolean

optional

ปรับให้ task ทั้งหมด Done

cancleAllOrder

boolean

optional

ยกเลิก Saleorder , Quotation ทั้งหมด (กรณี Missed Deal)

Example

{
    "dealName": "string",
    "dealQuantityUnit": "unit",
    "dealQuantity": 90,
    "dealValue": 10000,
    "dealInterests": [],
    "dealLabels": [
        98199047,
        34064271
    ],
    "dealDate": "2023-02-08T16:51:40+0700",
    "expectedCloseDate": "2023-02-08T16:51:40+0700",
    "note": "string",
    "assignTo": "staff01",
    "participantCodes": [
        "staff02"
    ],
    "dateFollowUp": "2023-02-08T16:51:40+0700",
    "followUpNotes": "incididunt",
    "dealStageId": 5509,
    "remark": "Excepteur Lorem non cupidatat nostrud",
    "reasonCategoryId": 39733557,
    "markAllTaskAsDone": false,
    "cancleAllOrder": true
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Body

statusCode

integer

required

สถานะของ Business Code ถ้า
Success = 1000
Error 1 ตัว = 4001
Error มากกว่า 1 ตัว = 4002
หรือเป็น Subcode ที่ต้องการจะแสดงเพื่อสื่อความหมายของ Error โดย subcode จะเป็นตัวเดียวกับ business error code หรือไม่ก็ได้ เพื่อความสะดวกในการแสดงผล

httpStatusCode

integer

required

สถานะ code ของ httpเช่น
200 Ok
201 Created
400 BadRequest
401 Unauthorized
404 Record not found
500 Internal Server Error

data

object

required

value

object

required

statusCode

integer

required

สถานะ code ของ httpเช่น
200 Ok
201 Created
400 BadRequest
401 Unauthorized
404 Record not found
500 Internal Server Error

Example

{
    "data": {
        "value": {
            "dealsId": 1,
            "customerId": 1,
            "dealNo": "string",
            "dealsName": "string",
            "dealsValue": 10,
            "statusId": 1,
            "dealStageId": 1,
            "dealsIndex": 1,
            "dealsDate": "2023-01-19T00:00:00+0700",
            "expectedCloseDate": "2023-01-23T00:00:00+0700",
            "probability": 20,
            "notes": "string",
            "isActive": true,
            "boardId": 1,
            "dateCreated": "2023-01-19T21:25:01+0700",
            "createByUserId": "string",
            "dateModified": "2023-01-19T21:39:34+0700",
            "modifiedByUserId": "string",
            "customer": {
                "customerId": 1,
                "companyId": 1,
                "customerCode": "string",
                "customerName": "string",
                "type": 1,
                "customerType": 1,
                "isActive": true,
                "createdByUserId": "string",
                "dateCreated": "2022-11-28T13:41:11+0700",
                "modifiedByUserId": "string",
                "dateModified": "2023-01-16T15:12:52+0700",
                "customerGroupId": 1,
                "sourceOfLead": 1,
                "classificationId": 2,
                "hasOwner": true,
                "pictureUrl": "string",
                "addresses": [],
                "customerInterests": []
            },
            "dealStage": {
                "dealStageId": 1,
                "stageName": "string",
                "dateCreated": "2022-12-12T17:15:43+0700",
                "createByUserId": "string",
                "isActive": true,
                "companyId": 1,
                "seq": 3,
                "boardId": 1
            },
            "dealsInterests": [
                {
                    "dealsId": 1,
                    "topicId": 3,
                    "isActive": true
                }
            ],
            "dealsLabels": [
                {
                    "dealsId": 1,
                    "dealLabelId": 1,
                    "isActive": true
                }
            ],
            "isAction": true,
            "isEdit": true,
            "isDelete": true,
            "statusName": "string",
            "user": {
                "userId": "string",
                "username": "string",
                "companyId": 1,
                "companyName": "string",
                "teamId": 1,
                "teamName": "string",
                "staffCode": "string",
                "title": "",
                "firstname": "string",
                "lastname": "string",
                "fullname": "string",
                "position": "string",
                "email": "string",
                "phoneNumber": "string",
                "orgString": "string",
                "orgLevel": 1,
                "latitude": 1,
                "longitude": 1.5,
                "location": "string",
                "locationName": "string",
                "isActive": true,
                "createdByUserId": "string",
                "hasPicture": true,
                "dateCreated": "2018-11-05T10:13:59+0700",
                "dateModified": "2023-01-19T15:15:13+0700",
                "role": "string",
                "roleId": "string",
                "level": 0,
                "siteId": 1,
                "isAgreementPDPA": true,
                "dateAgreementPDPA": "2020-08-26T07:13:22+0700",
                "emailSubscription": 2,
                "identityUserId": "string",
                "uniqueName": "string",
                "inAppSubscription": 1,
                "userType": 1
            },
            "dealSummary": {
                "probability": 20,
                "dealValue": 10,
                "expectedCloseDate": "2023-01-23T00:00:00+0700"
            },
            "currentStage": {
                "dealStageId": 1,
                "stageName": "string",
                "dateChangeStage": "2023-01-19T21:39:34+0700"
            },
            "dateFollowUp": "2023-01-21T00:00:00+0700"
        },
        "statusCode": 200
    },
    "statusCode": 1000,
    "httpStatusCode": 200
}

🟠401Unauthorized

🟠403Forbidden

🔴500Server Error

🟢200Bad Request

🟠401User authentication required V2.