Update Placeholder
PATCH /psa/placeholders/{id}
Group: PSA › Placeholders · Operation ID: updatePlaceholder
Updates the placeholder with the given identifier. Only the fields in the request body change.
The response is empty. Read the placeholder back with GET psa/placeholders/:id.
Open in the interactive reference
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
Api-Version |
header | "v1" |
yes | The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version v1. |
Idempotency-Key |
header | string | no | An opaque caller-chosen string (1-255 characters) that makes this request safe to retry. Repeating the same key with an identical request body replays the original response instead of re-executing - but only once that original request succeeded; a failed attempt re-executes on retry. Repeating the key with a different body is answered with 422. A key still in flight is answered with 409 - as is a key whose original request was interrupted before it finished, for a few minutes afterwards, until that attempt is presumed dead. A completed response stays replayable for 24 hours. The key is scoped to the caller, not to the action: reusing it for a different action is answered with 409 or 422 rather than treated independently. On read actions this header is ignored. On write actions that cannot offer the guarantee it is answered with 400 IDEMPOTENCY_NOT_SUPPORTED rather than silently ignored. |
id |
path | string | yes | The unique identifier for the placeholder to update. |
Request body
Required, application/json: updatePlaceholderInput.
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | no | A new display name. Omit to leave it unchanged. Must be unique within the tenant. A blank name fails with NAME_REQUIRED, and a name another placeholder already has fails with DUPLICATE_NAME. |
weeklyWorkingHours |
string (decimal) | no | New weekly working hours, as a non-negative number of hours, for example 32.00. Omit to leave the stored value unchanged. A zero is stored as zero. |
Example:
{
"name": "<name>",
"weeklyWorkingHours": "32.00"
}
Response
200 Success
Response headers
Idempotency-Replayed— Present andtrueonly when this response replays a previously stored one for the same Idempotency-Key, rather than reflecting a live execution. Absent on a live response - never sent asfalse.
Errors
| Code | Status |
|---|---|
NOT_FOUND |
400 |
NAME_REQUIRED |
400 |
DUPLICATE_NAME |
400 |
IDEMPOTENCY_KEY_CONFLICT |
409 |
IDEMPOTENCY_PAYLOAD_MISMATCH |
422 |
Statuses
400— Invalid request or business failure. Codes: NOT_FOUND, NAME_REQUIRED, DUPLICATE_NAME401— Missing or invalid access token403— Not authorized404— Not found409— The Idempotency-Key is still being processed by another request.422— The Idempotency-Key was already used with a different request payload.429— Too many requests500— Internal server error