Add a workspace person

OpenAPI contract

Method

POST

Path

/api/v1/workspaces/{id}/people

Security

jwtBearer (bearer)

Response status

201 400 401 403 404 409 429 500

Request and response schemas

JSON

{
  "requestBody": {
    "application/json": {
      "$ref": "#/components/schemas/AddWorkspacePersonRequest"
    }
  },
  "responses": {
    "201": {
      "description": "Workspace person added or invited",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/WorkspacePersonResponse"
        }
      }
    },
    "400": {
      "description": "Invalid request",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/RequestError"
        }
      }
    },
    "401": {
      "description": "Authentication required or invalid",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/SecurityError"
        }
      }
    },
    "403": {
      "description": "Authenticated but not permitted",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/SecurityError"
        }
      }
    },
    "404": {
      "description": "Requested workspace resource was not found",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/ApiError"
        }
      }
    },
    "409": {
      "description": "Request conflicts with current workspace state",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/ApiError"
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/SecurityError"
        }
      }
    },
    "500": {
      "description": "Unexpected server error",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/ApiError"
        }
      }
    }
  }
}

POST /api/v1/workspaces/{id}/people is JWT-only and requires people:manage. Send a valid nonblank email of at most 320 characters and a role: ADMIN, DEVELOPER, VIEWER, or BILLING. An archived workspace rejects the request.

If the email belongs to an existing account, the service ensures organization membership and creates or reactivates an active workspace membership. Otherwise it records a pending invitation. An existing active member or pending invitation returns a conflict. The response identifies whether the result is a MEMBER or INVITATION.

json

{"email":"[email protected]","role":"DEVELOPER"}