Add people or placeholders to a project team

Operation ID: createTeamMembers

Group: PSA › Team Members

Open in the interactive reference

POST /psa/team-members/bulk

Retry-safe: A write that accepts Idempotency-Key: repeating a request with the same key replays the stored answer instead of executing twice.

Adds people or placeholders to a PSA project's team. Each item names exactly one of employeeId or placeholderId, and can also name a projectPositionId. An item with a projectPositionId creates a position assignment. An item without one adds the person to the team but creates no position assignment.

If any item can't be added, none are. Adding people needs edit permission on the project.

The response lists the ids of the created position assignments in the order you sent them. An item that creates no position assignment adds no id, so you can't match ids to items by their place in the list.

Parameters

Name In Type Required Description
Api-Version header string · 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: createTeamMembersInput.

Field Type Required Description
psaProjectId number yes The PSA project to add the people to. It is a numeric key, not the UUID that GET psa/projects/:id takes. Adding people needs edit permission on this project. Example: 32341.
assignments array<object> yes One entry per person or placeholder to add. Each entry needs exactly one of employeeId or placeholderId. Either all are added, or none are. Example: [{"employeeId":3845142,"projectPositionId":7},{"placeholderId":91}].
assignments[].employeeId number no The employee to add. Give either employeeId or placeholderId, not both. The employee joins the team even when projectPositionId is omitted. It is a numeric key.
assignments[].placeholderId number no The placeholder to assign. Give either employeeId or placeholderId, not both. A placeholder item with no projectPositionId creates nothing. It is a numeric key.
assignments[].projectPositionId number | null no The project position to assign this person or placeholder to. Omit it to add the person to the team without a position assignment. It is a numeric key. 
{
  "psaProjectId": 32341,
  "assignments": [
    {
      "employeeId": 3845142,
      "projectPositionId": 7
    },
    {
      "placeholderId": 91
    }
  ]
}

Response

200 Success

Under data (createTeamMembersOutput):

Field Type Required Description
created array<object> yes The ids of the position assignments created, in the order the entries were sent. An entry that created no position assignment contributes no id, so this can be shorter than the input. Read a record back with GET psa/team-member-positions/:id. Example: [{"id":"5f2e1c40-9a3b-4d71-8e05-6b4c2d1a7f93"}].
created[].id string yes The unique identifier of the created position assignment. This is the id GET psa/team-member-positions returns. 
{
  "data": {
    "created": [
      {
        "id": "5f2e1c40-9a3b-4d71-8e05-6b4c2d1a7f93"
      }
    ]
  },
  "diagnostics": [
    {
      "code": "<code>",
      "message": "<message>",
      "severity": "error",
      "path": [
        "<path>"
      ],
      "details": "<details>"
    }
  ]
}

Response headers

Errors

Code Status
INVALID_ASSIGNMENT 400
IDEMPOTENCY_KEY_CONFLICT 409
IDEMPOTENCY_PAYLOAD_MISMATCH 422

Statuses