Skip to content

Update Lead Status

Endpoint: https://catalog-admin.youcan.shop/api/partners/lead/update

Method: POST

Api Key: token

Parameters

Param NameParam TypeDescriptionRequired
idstringLead Id,sourceyes
statusnumberLead Statusyes
notestringLead Note,ex:confimration after 2 callno
confirmed_atdate-timeConfirmation DateTimeno
delivered_atdate-timeDelivered DateTimeno

Status available values

NameValue as numberDescriptionorder
CREATED1Represent a lead recently created1
CONFIRMED2lead that confirmed2
PICKED_UP3lead that picked up3
DELIVERED4lead that delivered4
RETURNED5lead that returned5
SHIPPING_FAILED6lead where shipping failed6
CANCELED7lead that cancled7

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"
}