support-tickets

Update status and/or priority

Changed on

Closing records the note and tells the requester. A priority change carries the same note and the requester reads it: that is how an emergency is turned down.

patch/api/support-tickets/{ticket_id}

Request

  • Base URL: https://api.corabea.it (the document declares no server; this is the origin it was published from)
  • URL: https://api.corabea.it/api/support-tickets/{ticket_id}
  • Auth: HTTP bearer

Path parameters

ticket_idstring uuid required

Ticket UUID

Request body

status'OPEN' | 'IN_PROGRESS' | 'CLOSED'

Life of a support ticket. IN_PROGRESS is set by taking it in charge.

priorityinteger nullable

New level, the reserved one included

notestring nullable

Reason, shown in the thread to both sides

Response

Successful Response

idstring required

Ticket UUID

codestring required

Human readable code, TK-<number>

kind'REQUEST' | 'CHAT' required

Which of the two halves of support_tickets a row uses.

subjectstring required

Subject

status'OPEN' | 'IN_PROGRESS' | 'CLOSED' required

Life of a support ticket. IN_PROGRESS is set by taking it in charge.

priorityinteger required

Priority level

priority_labelstring nullable

Priority name

department_idstring nullable

Owning department, null on a chat

department_labelstring nullable

Owning department name

created_by_user_idstring required

Requester user UUID

created_by_namestring nullable

Requester display name

patient_namestring nullable

Patient the request is about

assignee_user_idstring nullable

Assignee user UUID

assignee_namestring nullable

Assignee display name

related_ticket_idstring nullable

Request a chat is about

related_ticket_codestring nullable

Code of that request

chat_idstring nullable

Where to post a reply. On a request this is its chat, if one exists; on a chat it is the row itself

has_chatboolean required

Whether a conversation was ever opened

chat_openboolean required

Whether anyone can still write in it

chat_expires_atstring nullable

When a live chat dies

chat_expiredboolean required

Whether it died of inactivity

waiting_on'EXPERT' | 'STAFF'

Which side owes the next message, derived from who wrote last.

unreadboolean required

Whether the caller has something unread here

idle_hoursinteger nullable

Hours since the last entry

is_staleboolean required

Idle longer than this priority allows

created_atstring nullable

ISO datetime

updated_atstring nullable

ISO datetime

last_activity_atstring nullable

ISO datetime

closed_atstring nullable

ISO datetime

assistant_conversation_idstring uuid nullable
descriptionstring required

Request description

answersobject

Answers to the questions

answer_labelsobject
patient_idstring nullable

Patient the request is about

operator_alert_idstring nullable

Portal alert it is about

operator_alert_titlestring nullable

Title of that alert

can_replyboolean required

Whether the caller can post right now

can_manageboolean required

Whether the caller acts from the handling side

can_takeboolean

Whether the caller can take this unassigned request

Changes

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status