Creates one or more placeholders. Either all are created, or none are.
POST /psa/placeholders
Group: PSA › Placeholders · Operation ID: createPlaceholders
The response returns the new placeholders' ids in the order they were sent. New placeholders are not assigned to any project.
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. |
Request body
Required, application/json: createPlaceholdersInput.
| Field | Type | Required | Description |
|---|---|---|---|
placeholders |
array of object | yes | The placeholders to create. Send at least one. Either all are created, or none are. |
placeholders[].name |
string | yes | The display name of the placeholder. Required, and unique within the tenant. A blank name fails the call with NAME_REQUIRED. A name another placeholder already has fails with DUPLICATE_NAME. |
placeholders[].weeklyWorkingHours |
string (decimal) | no | The weekly working hours used for planning, as a non-negative number of hours, for example 40.00. Omitted or zero stores no hours. |
Example:
{
"placeholders": [
{
"name": "Unassigned Backend Engineer",
"weeklyWorkingHours": "40.00"
},
{
"name": "Unassigned Designer"
}
]
}
Response
200 Success
Under data (createPlaceholdersOutput):
| Field | Type | Required | Description |
|---|---|---|---|
ids |
array of string | yes | The identifiers of the created placeholders, in the order they were sent. |
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 |
|---|---|
NAME_REQUIRED |
400 |
DUPLICATE_NAME |
400 |
IDEMPOTENCY_KEY_CONFLICT |
409 |
IDEMPOTENCY_PAYLOAD_MISMATCH |
422 |
Statuses
400— Invalid request or business failure. Codes: 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