curl --request PATCH \
--url https://api.yo-lead.com/v1/tickets/{ticketId}/status \
--header 'Content-Type: application/json' \
--header 'X-YoLead-Key: <api-key>' \
--header 'X-YoLead-Signature: <api-key>' \
--header 'X-YoLead-Timestamp: <api-key>' \
--data '
{
"status": "active",
"assigneeId": "64f000000000000000000001"
}
'{
"data": {
"ticketId": "64f000000000000000000003",
"chatId": "64f000000000000000000002",
"oldStatus": "new",
"newStatus": "active",
"assigneeId": "64f000000000000000000001"
}
}Change ticket status
Changes the status of the current ticket in a chat. Allowed transitions are new to active, active to inactive, and inactive to active.
Required API key scope: read-write.
When activating a new ticket, assigneeId is required and must reference an active employee with access to the ticket channel. When reactivating an inactive ticket, assigneeId may be omitted or must match the existing assignee. assigneeId is not allowed when setting status to inactive.
curl --request PATCH \
--url https://api.yo-lead.com/v1/tickets/{ticketId}/status \
--header 'Content-Type: application/json' \
--header 'X-YoLead-Key: <api-key>' \
--header 'X-YoLead-Signature: <api-key>' \
--header 'X-YoLead-Timestamp: <api-key>' \
--data '
{
"status": "active",
"assigneeId": "64f000000000000000000001"
}
'{
"data": {
"ticketId": "64f000000000000000000003",
"chatId": "64f000000000000000000002",
"oldStatus": "new",
"newStatus": "active",
"assigneeId": "64f000000000000000000001"
}
}Authorizations
Public API key generated in the YoLead UI.
Unix timestamp in milliseconds. Requests must be signed within a 5-minute window.
Hex HMAC-SHA256 signature over <timestamp>.<raw_body> using the API secret.
Path Parameters
Ticket id. MongoDB ObjectId represented as a 24-character hexadecimal string.
^[0-9a-fA-F]{24}$"64f000000000000000000001"
Body
Ticket status transition.
active, inactive Required when activating a new ticket. When reactivating an inactive ticket, it may be omitted or must match the existing assignee. Not allowed when setting status to inactive.
^[0-9a-fA-F]{24}$"64f000000000000000000001"
Response
Ticket status changed.
Show child attributes
Show child attributes