Skip to main content
PATCH

​
At a glance

​
Operational behavior

Updates editable incident fields. Setting dateUntil closes or schedules completion of an open temporary incident. Incidents cannot be reopened. With dryRun=true, the API returns the projected incident without saving it.
  • The patch exposes type, dateFrom, and dateUntil as documented.
  • Setting dateUntil closes or schedules completion of an open temporary incident.
  • Incidents cannot be reopened through this endpoint.

​
Common errors

The operation response list and Error handling page are authoritative for complete handling.

​
Before implementation

  • Generate and log a new X-Request-ID for the attempt.
  • Handle every documented response status.
  • Do not log X-API-Key or unnecessary personal data.
  • Reconcile current resource state before replaying an ambiguous write.

Related integration guidance

Review the complete process, state, retry, and operational pattern for this operation.

Authorizations

​
X-API-Key
string
header
required

JobHandy integration API key. Send the credential in the X-API-Key header. Treat the key as a secret and use it only from trusted server-side environments.

Headers

​
X-Tenant-ID
string
inactive
optional
not sent by default

Narrows the operation to one tenant in the API key's scope. Any referenced or target resource must be accessible through that tenant. In interactive clients, use the {{tenantId}} variable when a tenant must be selected. Keep the header disabled when tenant selection is not required.

Pattern: ^[0-9a-fA-F]{24}$
​
X-Request-ID
string<uuid>
inactive
optional
not sent by default

Optional request identifier. If supplied, it must be a UUID v4 or v7 and is returned unchanged in every response. If omitted, the API generates one. Invalid values return 400 INVALID_REQUEST_ID. If your client uses a {{requestId}} variable, refresh it with a new UUID version 4 or 7 for every HTTP request attempt. Keep the header disabled to let the API generate the request identifier.

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[47][0-9a-fA-F]{3}-[89aAbB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$

Path Parameters

​
id
string
required

Incident ID.

Pattern: ^[0-9a-fA-F]{24}$
Example:

"730000000000000000000001"

Query Parameters

​
dryRun
boolean
inactive
optional
server default: false
not sent by default

When true, the API validates the request without applying the change. The operation's responses specify the returned representation. When omitted, the server uses false.

Example:

true

Body

application/json

The JSON request body must not exceed 5,242,880 bytes.

Editable employee incident fields. Lifecycle status is assigned by the server.

​
type
enum<string>
inactive
optional
not sent by default

Replacement incident type. Omit the field to leave it unchanged.

Available options:
temporary,
permanent
Example:

"temporary"

​
dateFrom
string<date-time>
inactive
optional
not sent by default

Replacement UTC start timestamp. Omit the field to leave it unchanged.

Pattern: Z$
Example:

"2026-07-21T00:00:00.000Z"

​
dateUntil
string<date-time>
inactive
optional
not sent by default

UTC end timestamp. Setting this field closes or schedules completion of an open temporary incident. Incidents cannot be reopened through this endpoint.

Pattern: Z$
Example:

"2026-07-25T23:59:59.999Z"

Response

Returns the updated incident, or the projected incident when dryRun=true.

Employee incident details.

​
id
string
required
read-only

Unique incident identifier.

Minimum string length: 1
Pattern: ^[0-9a-fA-F]{24}$
Example:

"730000000000000000000001"

​
employeeIncidentNumber
integer
required
read-only

Tenant-facing numeric incident number assigned by the server.

Must be a multiple of 1
Example:

37

​
type
enum<string>
required

Incident type. Values are case-sensitive.

Available options:
temporary,
permanent
Minimum string length: 1
Example:

"temporary"

​
status
enum<string>
required
read-only

Server-managed incident lifecycle status.

Available options:
reported,
in_progress,
completed,
archived
Minimum string length: 1
Example:

"reported"

​
employee
string
required

Identifier of the affected employee.

Pattern: ^[0-9a-fA-F]{24}$
Example:

"68a000000000000000000001"

​
reportedBy
enum<string>
required
read-only

Actor category that originally reported the incident.

Available options:
user,
api_key
Minimum string length: 1
Example:

"api_key"

​
reportedAt
string<date-time>
required
read-only

UTC timestamp at which the incident was reported.

Minimum string length: 1
Pattern: Z$
Example:

"2026-07-21T07:30:00.000Z"

​
dateFrom
string<date-time>
required

UTC timestamp from which the incident applies.

Minimum string length: 1
Pattern: Z$
Example:

"2026-07-21T00:00:00.000Z"

​
dateUntil
string<date-time> | null
required
nullable

UTC timestamp until which the incident applies, or null while no end is set.

Minimum string length: 1
Pattern: Z$
Example:

null

​
createdAt
string<date-time>
required
read-only

UTC timestamp at which the incident record was created.

Minimum string length: 1
Pattern: Z$
Example:

"2026-07-21T07:30:00.000Z"

​
updatedAt
string<date-time>
required
read-only

UTC timestamp of the latest incident update.

Minimum string length: 1
Pattern: Z$
Example:

"2026-07-21T07:30:00.000Z"

Last modified on August 27, 2026