الانتقال إلى المحتوى الرئيسي
PATCH
Partially updates a ticket. Send only the fields you want to change.

التفويضات

X-API-Key
string
header
مطلوب

Your Gorelo API key. See Generate API key. If your data is hosted in Australia, click the base URL at the top of this page and select https://api.aue.gorelo.io.

معلمات المسار

ticketId
string<uuid>
مطلوب

Ticket to update.

الجسم

Fields to change.

Unified partial update for a ticket. Every field is optional; only the fields present in the request body are applied. Each change has the same effects (notifications, timeline entries) as making it in the app.

Title
string | null

Ticket title. Maximum 250 characters.

UpdatedByName
string | null

Display name recorded as the author of this update. Source is always stamped as Public API. Omitted or blank, it is recorded as API.

ClosedOn
string<date-time> | null

The date the ticket was closed, for correcting the close date of a ticket migrated from another system. The ticket must already be in a closed status, or be moved into one by this same request. Must not be in the future or earlier than the ticket's CreatedOn. Omit to leave an already-closed ticket's close date untouched. Sending null is the same as omitting it - the close date is not clearable here, since a closed ticket always has one. A close that carries ClosedOn is treated as history: it is recorded on the timeline but sends no status-changed email to the contact and triggers no automation rules.

UpdatedOn
string<date-time> | null

Timestamp to record as the ticket's last activity instead of the current time, for a caller replaying historical changes. Must not be in the future or earlier than the ticket's CreatedOn. Applies to whichever fields this request changes; it is not an update on its own. Defaults to the ClosedOn supplied by the same request, otherwise to the current time. A caller migrating a ticket sends CreatedOn on create, and ClosedOn and UpdatedOn together here, so the ticket keeps the dates it had in the other system. Sending null is the same as omitting it.

ClientId
integer<int64> | null

Client the ticket belongs to. Changing it clears the ticket's contact, assets, uptime checks and billing override.

LocationId
integer<int64> | null

Client location the ticket belongs to. Requires the ticket to have a client.

ContactId
integer<int64> | null

Primary contact on the ticket. A ticket with a client (the ClientId sent, otherwise the one the ticket has) takes a contact of any client; a ticket with no client takes a temporary contact (IsTemporaryContact true).

CcContactIds
integer<int64>[] | null

Cc contacts on the ticket. At most 100. Same rule as ContactId: contacts of any client, or temporary contacts when the ticket has no client. Replaces the list; [] clears it; omit to leave unchanged.

StatusId
integer<int64> | null

Ticket status id.

GroupIds
integer<int64>[] | null

Technician groups subscribed to the ticket. Replaces the list; [] clears it; omit to leave unchanged.

PriorityId
enum<integer>
الخيارات المتاحة:
0,
1,
2,
3,
4
TypeId
integer<int64> | null

Ticket type id.

LeadAssigneeId
integer<int64> | null

Lead assignee technician id. Send 0 to unassign; omit to leave unchanged.

AssistingAssigneeIds
integer<int64>[] | null

Assisting assignee technician ids. Replaces the list; [] clears it; omit to leave unchanged.

WatcherIds
integer<int64>[] | null

Watcher technician ids. Replaces the list; [] clears it; omit to leave unchanged.

TagIds
integer<int64>[] | null

Tag ids on the ticket. Replaces the list; [] clears it; omit to leave unchanged.

AgentAssetIds
string<uuid>[] | null

Agent (managed device) asset ids to link. Replaces the current set; omit to leave unchanged.

CustomAssetIds
string<uuid>[] | null

Custom asset ids to link. Replaces the current set; omit to leave unchanged.

UptimeIds
string<uuid>[] | null

Uptime check ids to link. Replaces the current set; omit to leave unchanged.

BillingOverride
object

Ticket-level billing defaults. These are stored on the ticket and applied when a time entry is created against it — they are not posted to Billing by this endpoint.

الاستجابة

OK

StatusCode
enum<integer>
الخيارات المتاحة:
100,
101,
102,
103,
200,
201,
202,
203,
204,
205,
206,
207,
208,
226,
300,
301,
302,
303,
304,
305,
306,
307,
308,
400,
401,
402,
403,
404,
405,
406,
407,
408,
409,
410,
411,
412,
413,
414,
415,
416,
417,
421,
422,
423,
424,
426,
428,
429,
431,
451,
500,
501,
502,
503,
504,
505,
506,
507,
508,
510,
511
IsSuccess
boolean
Data
object
DataContext
object | null
مثال:

null

Notifications
object[]