Add project members

Adds 1–100 active workspace members to the project. Each item names exactly one of memberId, externalId or email. Returns 201 when every item succeeds and 207 when any item fails.

Required scope: project.members.write

POST /api/public/v1/projects/{projectId}/members

Add project members

cURL

curl --request POST \
  --url https://{platformHost}/api/public/v1/projects/{projectId}/members \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "members": [
    {
      "memberId": "0193f1c2-7a4e-7b10-9c3d-5e6f7a8b9c0d",
      "roleId": "builtin.project.developer"
    },
    {
      "email": "[e-mail]",
      "roleId": "builtin.project.viewer"
    }
  ]
}
'

201

{
  "success": true,
  "data": {
    "items": [
      {
        "outcome": "added",
        "memberId": "<string>",
        "externalId": "<string>",
        "email": "<string>",
        "userId": "<string>",
        "role": {
          "roleId": "builtin.workspace.restricted_member",
          "name": "RESTRICTED_MEMBER",
          "type": "system",
          "source": "direct"
        },
        "code": "<string>"
      }
    ]
  }
}

Use this endpoint to add 1 to 100 active workspace members to a project. Each item names exactly one of memberId, externalId, or email, and a roleId. A person must already be an active workspace member. To check which roles a key can assign, call List assignable project roles.

The call returns 201 when every item succeeds and 207 when any item fails. Each item carries its own outcome. Send an Idempotency-Key header so retries are safe. The request needs the project.members.write scope.

Authorizations

platformApiKeybearerPlatformKey

X-API-Key · string · header · required

Platform key, for example abl_ws_….

Headers

Idempotency-Key · string

Recommended on every write. A retry with the same key and body replays the first result instead of repeating the change. A different body returns 422 IDEMPOTENCY_KEY_REUSED; a retry while the first is still running returns 409 IDEMPOTENCY_IN_PROGRESS.

Required string length: 1 - 255

Path Parameters

projectId · string · required

Minimum string length: 1

Body

application/json

members · object[] · required

Required array length: 1 - 100 elements

Show child attributes

Response

201

application/json

All items succeeded.

success · enum<boolean> · required

Available options: true

data · object · required

Show child attributes