Appearance
Update Lead Status
Endpoint: https://catalog-admin.youcan.shop/api/partners/lead/update
Method: POST
Api Key: token
Parameters
Param Name | Param Type | Description | Required |
---|---|---|---|
id | string | Lead Id,source | yes |
status | number | Lead Status | yes |
note | string | Lead Note,ex:confimration after 2 call | no |
confirmed_at | date-time | Confirmation DateTime | no |
delivered_at | date-time | Delivered DateTime | no |
Status available values
Name | Value as number | Description | order |
---|---|---|---|
CREATED | 1 | Represent a lead recently created | 1 |
CONFIRMED | 2 | lead that confirmed | 2 |
PICKED_UP | 3 | lead that picked up | 3 |
DELIVERED | 4 | lead that delivered | 4 |
RETURNED | 5 | lead that returned | 5 |
SHIPPING_FAILED | 6 | lead where shipping failed | 6 |
CANCELED | 7 | lead that cancled | 7 |
TIP
Make sure the lead status follow the order.
Response
[422] Unprocessable Entity
json
// Returned when signature is invalid
{
"message": "invalid signature"
}
[201] Updated
json
{
"id": "lea_2gopU7Uo1DS5k28mtx22FEQuGuM",
"status": 6,
"status_text": "canceled",
"confirmed_at": "05/22/2024 10:29:57",
"delivered_at": "05/24/2024 10:04:59"
}