Add project members
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": "sam@example.com",
"roleId": "builtin.project.viewer"
}
]
}
'{
"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>"
}
]
}
}{
"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>"
}
]
}
}{
"success": false,
"error": {
"code": "INSUFFICIENT_SCOPE",
"message": "<string>",
"messages": [
"<string>"
],
"retryable": true,
"details": {}
}
}{
"success": false,
"error": {
"code": "INSUFFICIENT_SCOPE",
"message": "<string>",
"messages": [
"<string>"
],
"retryable": true,
"details": {}
}
}{
"success": false,
"error": {
"code": "INSUFFICIENT_SCOPE",
"message": "<string>",
"messages": [
"<string>"
],
"retryable": true,
"details": {}
}
}{
"success": false,
"error": {
"code": "INSUFFICIENT_SCOPE",
"message": "<string>",
"messages": [
"<string>"
],
"retryable": true,
"details": {}
}
}{
"success": false,
"error": {
"code": "INSUFFICIENT_SCOPE",
"message": "<string>",
"messages": [
"<string>"
],
"retryable": true,
"details": {}
}
}{
"success": false,
"error": {
"code": "INSUFFICIENT_SCOPE",
"message": "<string>",
"messages": [
"<string>"
],
"retryable": true,
"details": {}
}
}{
"success": false,
"error": {
"code": "INSUFFICIENT_SCOPE",
"message": "<string>",
"messages": [
"<string>"
],
"retryable": true,
"details": {}
}
}{
"success": false,
"error": {
"code": "INSUFFICIENT_SCOPE",
"message": "<string>",
"messages": [
"<string>"
],
"retryable": true,
"details": {}
}
}{
"success": false,
"error": {
"code": "INSUFFICIENT_SCOPE",
"message": "<string>",
"messages": [
"<string>"
],
"retryable": true,
"details": {}
}
}Add project members
Add up to 100 active workspace members to a project with a project role in one request.
POST
/
api
/
public
/
v1
/
projects
/
{projectId}
/
members
Add project members
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": "sam@example.com",
"roleId": "builtin.project.viewer"
}
]
}
'{
"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>"
}
]
}
}{
"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>"
}
]
}
}{
"success": false,
"error": {
"code": "INSUFFICIENT_SCOPE",
"message": "<string>",
"messages": [
"<string>"
],
"retryable": true,
"details": {}
}
}{
"success": false,
"error": {
"code": "INSUFFICIENT_SCOPE",
"message": "<string>",
"messages": [
"<string>"
],
"retryable": true,
"details": {}
}
}{
"success": false,
"error": {
"code": "INSUFFICIENT_SCOPE",
"message": "<string>",
"messages": [
"<string>"
],
"retryable": true,
"details": {}
}
}{
"success": false,
"error": {
"code": "INSUFFICIENT_SCOPE",
"message": "<string>",
"messages": [
"<string>"
],
"retryable": true,
"details": {}
}
}{
"success": false,
"error": {
"code": "INSUFFICIENT_SCOPE",
"message": "<string>",
"messages": [
"<string>"
],
"retryable": true,
"details": {}
}
}{
"success": false,
"error": {
"code": "INSUFFICIENT_SCOPE",
"message": "<string>",
"messages": [
"<string>"
],
"retryable": true,
"details": {}
}
}{
"success": false,
"error": {
"code": "INSUFFICIENT_SCOPE",
"message": "<string>",
"messages": [
"<string>"
],
"retryable": true,
"details": {}
}
}{
"success": false,
"error": {
"code": "INSUFFICIENT_SCOPE",
"message": "<string>",
"messages": [
"<string>"
],
"retryable": true,
"details": {}
}
}{
"success": false,
"error": {
"code": "INSUFFICIENT_SCOPE",
"message": "<string>",
"messages": [
"<string>"
],
"retryable": true,
"details": {}
}
}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.
An item’s outcome is added when it succeeds. Otherwise it is an error code such as NOT_A_WORKSPACE_MEMBER, MEMBER_NOT_ACTIVE, ALREADY_PROJECT_MEMBER, or AMBIGUOUS_IDENTIFIER.Authorizations
platformApiKeybearerPlatformKey
Headers
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 - 255Body
application/json
Was this page helpful?