- Introduction
- Activity
- Authentication API
- Customer
- Case
- Deal
- Employee
- Expense
- Product
- Create Or Update Products
- Get a Product Ticket
- Get Products With Take & Status
- Get a Product by ProductCode
- Get Product Groups
- Get Product Properties
- Get Products By Filter
- Verify Serial Number
- /v3/Products/serials/status
- Create or Update Codeguard Products
- Update Product Stock
- /v1/products/units
- /v1/products/units Copy
- Quotation
- SalesOrder
- Webhooks
- Task
- Setting
Create Deal
POST
https://api.gofive.co.th/v1/deals
Request
Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.Example:
Authorization: Bearer ********************Header Params
Content-Type
string
required
Example:
application/json
Ocp-Apim-Subscription-Key
string
required
Example:
<Your-Subscription-Key>
Body Params application/json
customerCodes
array[string]
required
boardId
integer
required
dealName
string
required
probability
integer
required
dealValue
integer
required
dealQuantity
integer
optional
dealQuantityUnit
string
optional
dealInterests
array[integer]
optional
dealLabels
array[integer]
optional
dealDate
string
DateTimeString
expectedCloseDate
string
required
note
string
optional
assignTo
string
required
participantCodes
array[string]
optional
dateFollowUp
string <yyyy-MM-ddTHH:mm:ss>
optional
followUpNotes
string
optional
remark
string
optional
dealStageId
integer
optional
reasonCategoryId
integer
optional
markAllTaskAsDone
boolean
optional
cancleAllOrder
boolean
optional
Example
{
"customerCodes": [
"string"
],
"boardId": 34628319,
"dealName": "dealName",
"probability": 20,
"dealQuantity": 91493369,
"dealQuantityUnit": "unit",
"dealValue": 10,
"dealInterests": [
1001
],
"dealLabels": [
1002
],
"dealDate": "2023-02-07T16:51:40+0700",
"expectedCloseDate": "2023-02-08T16:51:40+0700",
"note": "string",
"assignTo": "staff01",
"participantCodes": [
"staff02"
],
"dateFollowUp": "2023-02-08T16:51:40+0700",
"followUpNotes": "followUp"
}Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.gofive.co.th/v1/deals' \
--header 'Ocp-Apim-Subscription-Key: <Your-Subscription-Key>' \
--header 'Content-Type: application/json' \
--data-raw '{
"customerCodes": [
"string"
],
"boardId": 34628319,
"dealName": "dealName",
"probability": 20,
"dealQuantity": 91493369,
"dealQuantityUnit": "unit",
"dealValue": 10,
"dealInterests": [1001],
"dealLabels": [1002],
"dealDate": "2023-02-07T16:51:40+0700",
"expectedCloseDate": "2023-02-08T16:51:40+0700",
"note": "string",
"assignTo": "staff01",
"participantCodes": [
"staff02"
],
"dateFollowUp": "2023-02-08T16:51:40+0700",
"followUpNotes": "followUp"
}'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
200 Ok
201 Created
400 BadRequest
401 Unauthorized
404 Record not found
500 Internal Server Error
data
object
required
value
array [object {35}]
required
statusCode
integer
required
200 Ok
201 Created
400 BadRequest
401 Unauthorized
404 Record not found
500 Internal Server Error
attachments
null
required
customerCodes
array[string]
required
dealName
string
required
assignTo
string
required
dealValue
integer
required
dealQuantity
integer
optional
dealQuantityUnit
string
optional
dealDate
string
required
expectedCloseDate
string
required
probability
integer
required
notes
null
optional
dealStageId
integer
optional
followUpNotes
string
optional
Example
{
"data": {
"value": [
{
"dealsId": 1,
"customerId": 1,
"dealNo": "string",
"dealsName": "string",
"dealsValue": 0,
"statusId": 702,
"dealStageId": 0,
"dealsDate": "string",
"expectedCloseDate": "2023-02-24T00:00:00+0700",
"probability": 0,
"notes": "string",
"isActive": true,
"boardId": 1,
"dateCreated": "2023-01-26T10:06:27+0700",
"createByUserId": "string",
"dealsInterests": [
{
"dealsId": 1,
"topicId": 1,
"isActive": true
}
],
"dealsLabels": [
{
"dealsId": 1,
"dealLabelId": 1
}
],
"dateFollowUp": "2023-02-12T00:00:00+0700",
"userId": [
"string"
],
"participantUserIds": []
}
],
"statusCode": 200
},
"statusCode": 1000,
"httpStatusCode": 200
}🟠401Unauthorized
🟠403Forbidden
🔴500Server Error
🟢200Bad Request
🟠400Field Required
🟠401User authentication required V2.
Modified at 2024-08-20 08:59:14