Deskhero Developer Hub
Back to deskhero.com
Ticket follow ups

Save

Schedules or edits a one-time status change if the ticket's last outbound reply remains unanswered. The worker checks deadlines every two minutes.

PUT /api/{tenant:minlength(2)}/v{version:apiVersion}/ticket_follow_ups/{ticket_id}
Authorisation
Minimum role: USER

Request arguments

Name Type Source
ticket_idInt32
inputDTO_ticket_follow_up_inputBody
Request body example

Response

Status
0 (0)
Type
DTO_ticket_follow_up
Wrapper
DTO_response_wrap
Other statuses
429 (TooManyRequests)
Response body example
DTO_ticket_follow_up_input
NameTypeReadOnlyDescription
operation_idStringUnique operation UUID. Reuse it when retrying the same request.
expected_versionStringVersion of the saved follow-up being edited, or null when creating one.
modeStringMOVE_STATUS (default) moves the ticket to target_status_id when no customer reply has arrived. REMIND keeps the status: the follow-up becomes DUE instead, until a reply is sent or it is turned off.
target_status_idInt32Workspace status id to move to when no customer reply has arrived. Ignored for REMIND.
due_atDateTimeOffsetFuture deadline with a UTC offset. Checked every two minutes.
DTO_ticket_follow_up
NameTypeReadOnlyDescription
versionStringActivation version used to prevent overwriting another User's changes.
stateStringACTIVE (waiting for its due time), DUE (a reminder whose time came without a customer reply), COMPLETED, CANCELED or UNAVAILABLE (deployment prerequisites are not enabled).
modeStringMOVE_STATUS (moves the ticket to target_status) or REMIND (keeps the status and becomes DUE).
due_atDateTimeDeadline in UTC.
target_statusDTO_reference_colorFuture status, resolved from the workspace's configured statuses. Null for REMIND.
expected_status_idInt32Current status expected when this follow-up runs.
created_byDTO_reference_userUser who scheduled this follow-up.
created_atDateTimeWhen this activation was saved, in UTC.
reasonStringReason a completed or canceled follow-up stopped waiting: NO_REPLY, FOLLOWED_UP (a reply was sent to a due reminder), CUSTOMER_REPLIED, STATUS_CHANGED, USER_CANCELED, TICKET_DELETED, TICKET_MERGED, TICKET_CHANGED, STATUS_UNAVAILABLE or EXECUTION_FAILED.
DTO_reference_color
NameTypeReadOnlyDescription
bg_colorStringReadOnlyBg color
text_colorStringReadOnlyText color
idInt32Id
labelObjectReadOnlyLabel
DTO_reference_user
NameTypeReadOnlyDescription
profile_picStringReadOnlyProfile pic
emailStringReadOnlyEmail
idInt32Id
labelObjectReadOnlyLabel

Generated Nov 3, 2026 05:19